Maintainance Team : @michaelweinold, @cmutel
A collection of Jupyter notebooks containing self-contained examples showcasing Brightway functionality.
A detailed guide is available at the Examples Contributing Guide on the Brightway Documentation website.
A template for new examples is available in the template folder.
All the examples collected in this repository are available as a submodule in the brightway-documentation repository. This allows us to collect the examples in a separate repository and still have them available on the Brightway Documentation webpage. This action triggers a submodule pull action in the brightway-documentation repository that keeps the examples up to date. It is triggered every time a new commit is pushed to the brightway-examples repository.
Jupyter Notebooks are JSON files. If they are not valid JSON, the readthedocs.org build will fail. Invalid JSON might be the result of an incomplete save process or other file corruption. This action tests all Jupyter Notebooks for valid JSON and fails if one of the notebooks is not valid JSON. It is triggered every time a pull request is opened.