This repository contains the source code for Uncertainty Modelling for Engineers.
The book can be read online here. A pdf of the book can be downloaded from here.
This book is an open source project; all readers are heartily invited to contribute with corrections and improvements.
Pull requests are most welcome. To make a contribution you should first familiarise yourself with JupyterBook. If you are making a major change you may first wish to discuss the change by opening a GitHub issue.
If you'd like to develop on and build the book, you should:
- Clone this repository
- Run
pip install -r requirements.txt
(it is recommended you do this within a virtual environment) - (Recommended) Remove the existing
uncertainty-book/_build/
directory - Run
jupyter-book build uncertainty-book/
A fully-rendered HTML version of the book will be built in uncertainty-book/_build/html/
.
The html version of the book is hosted on the gh-pages
branch of this repo. A GitHub actions workflow has been created that automatically builds and pushes the book to this branch on a push or pull request to main.
This project is created using the excellent open source Jupyter Book project and the executablebooks/cookiecutter-jupyter-book template.
Thanks goes to these wonderful people (emoji key):
Jonathan Sadeghi 📖 |
This project follows the all-contributors specification. Contributions of any kind welcome!
You can reference this book through the project's Zenodo archive using DOI: 10.5281/zenodo.4483793.
The citation will look something like:
Jonathan Sadeghi. (2021, January 31). Uncertainty Modelling for Engineers: Version 0.1.1 (Version v0.1.1). Zenodo. http://doi.org/10.5281/zenodo.4484026