This is a collection of guides, tutorials, and bits of information for the Royce Institute Data Infrastructure Project, we have written an extensive tutorial on how you can contribute which can be found here.
If you'd like to develop and/or build the Royce Data Handbook book, you should:
- Clone this repository
- Run
pip install -r requirements.txt(it is recommended you do this within a virtual environment)- Or
conda env create --file env.yaml
- Or
- (Optional) Edit the books source files located in the
handbook/directory - (Optional) Run
jupyter-book clean handbook/to remove any existing builds (Not recommended unless you are prepared to transfer files fromhandbooktohandbook/_buildin the hierarchical structure of this repository) - Run
jupyter-book build handbook/
A fully-rendered HTML version of the book will be built in handbook/_build/html/ in your local directory.
You can view the fully rendered HTML version locally by opening index.html located in handbook/_build/html/ in your web browser.
We welcome and recognize all contributions. You can see a list of current contributors in the contributors tab.
Note that the main branch is protected. If you would like to contribute to this project, please create a new branch, push your branch to the repository and create a pull request. We will then review it and merge it with the main branch. For streamlining purposes branches will be deleted once merged. We strongly encourage you to delete your equivalent local branch too, before moving on to a different branch.
This project is created using the excellent open source Jupyter Book project and the executablebooks/cookiecutter-jupyter-book template.
The content displayed on the deployed website and found under this repository is licensed under the Creative Commons Attribution 4.0 International (CC BY 4.0), the underlying source code used to format and display that content is licensed under the MIT license found here.