Skip to content

alan-turing-institute/rse-course

Repository files navigation

Project Status: Active – The project has reached a stable, usable state and is being actively developed. Build documentation Code style Licence: MIT Python 3.8 | 3.9 | 3.10

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. You can build the documentation from source by running:

pip install -U jupyter-book
./build_docs.sh

Contributing

Contributions are always welcome! Please do the following:

  • Add an issue to the course repo, 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. 🎉
  • 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.

Acknowledgements

This course began as a fork of the UCL RSD course.