https://github.com/alan-turing-institute/rse-course

Materials for The Alan Turing Institute's Research Software Engineering course
https://github.com/alan-turing-institute/rse-course

hacktoberfest hut23

Last synced: 22 days ago
JSON representation

Materials for The Alan Turing Institute's Research Software Engineering course

• Host: GitHub
• URL: https://github.com/alan-turing-institute/rse-course
• Owner: alan-turing-institute
• License: other
• Created: 2018-10-01T15:42:33.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-06-08T00:12:45.000Z (11 months ago)
• Last Synced: 2024-06-11T19:55:24.890Z (11 months ago)
• Topics: hacktoberfest, hut23
• Language: Jupyter Notebook
• Homepage: https://alan-turing-institute.github.io/rse-course/
• Size: 5.18 GB
• Stars: 227
• Watchers: 22
• Forks: 113
• Open Issues: 40
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)

[![Build documentation](https://github.com/alan-turing-institute/rse-course/actions/workflows/build_docs.yaml/badge.svg)](https://github.com/alan-turing-institute/rse-course/actions/workflows/build_docs.yaml)

[![Code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

[![Licence: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

[![Python 3.8 | 3.9 | 3.10](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10-blue.svg)](https://www.python.org/downloads/)

# Research Software Engineering Course

Course materials for Turing's Research Software Engineering course.

## Documentation

Documentation for the course is hosted at [`https://alan-turing-institute.github.io/rse-course`](https://alan-turing-institute.github.io/rse-course).

You can build the documentation from source by running:

```bash

pip install -U jupyter-book

./build_docs.sh

```

## Contributing

Contributions are always welcome! Please do the following:

- Add an issue to the [course repo](https://github.com/alan-turing-institute/rse-course), explaining the problem and, potentially, its solution.

- If you know how to fix it, please also open a pull request that contains the fix. By doing this, you will improve the instructions for future users. :tada:

- If you need to add a dependency, please edit `pyproject.toml` which is used to automatically generate `requirements.txt`

The full list of contributors can be [seen here](https://github.com/alan-turing-institute/rse-course/graphs/contributors).

## Acknowledgements

This course began as a fork of the [UCL RSD course](https://github.com/UCL/rsd-engineeringcourse).