Learn Brightway
The interactive learning and teaching documentation for the Brightway life-cycle assessment software package.
https://github.com/brightway-lca/brightway-book
Category: Sustainable Development
Sub Category: Education
Keywords
documentation lca life-cycle-assessment
Last synced: about 19 hours ago
JSON representation
Repository metadata
📖🌿 Interactive jupyter-book Documentation for Brightway
- Host: GitHub
- URL: https://github.com/brightway-lca/brightway-book
- Owner: brightway-lca
- License: bsd-3-clause
- Created: 2022-08-20T04:35:14.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-25T06:25:53.000Z (5 months ago)
- Last Synced: 2025-04-21T11:07:39.414Z (7 days ago)
- Topics: documentation, lca, life-cycle-assessment
- Language: Jupyter Notebook
- Homepage: https://learn.brightway.dev
- Size: 15.3 MB
- Stars: 18
- Watchers: 8
- Forks: 7
- Open Issues: 5
- Releases: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE
README.md
Brightway Interactive Learning (based on Jupyter Book)
Maintainance Team: @michaelweinold
The interactive learning and teaching documentation for the Brightway life-cycle assessment software package. Readthedocs.org with the Jupyter Book Theme and the Thebe tool are used to build/host the interactive documentation.
| static documentation | interactive documentation | development playground |
|---|---|---|
| docs.brightway.dev | learn.brightway.dev | live.brightway.dev |
Quickstart
Setup Repository
git clone https://github.com/brightway-lca/brightway-book.git
Setup Python Environment
Set up a Python virtual environment that includes all packages required to build the documentation. A Conda environment file is provided for convenient setup. The file is located at ./environment.yml. Install the environment jbook by running from the repository root directory:
conda env create -f environment.yml
and activate the environment:
conda activate jbook
Building the Documentation
[!TIP]
You can check the Jupyter Book documentation for further information on how to structure your content.
- You can build the documentation by running the
buildcommand:
jupyter-book build ./
- Preview the built documentation by opening the generated
htmlfile:
_build/html/index.html
Publishing the Documentation
- Create a pull request to have a maintainer merge your changes into the
mainbranch. As soon aschanges have been merged, Readthedocs.org will build the documentation and deploy it.
📚 References
Compare the jupyter-book:
Owner metadata
- Name: Brightway LCA software framework
- Login: brightway-lca
- Email:
- Kind: organization
- Description: Open source framework for Brightway framework
- Website: https://docs.brightway.dev/
- Location:
- Twitter:
- Company:
- Icon url: https://avatars.githubusercontent.com/u/26960762?v=4
- Repositories: 28
- Last ynced at: 2023-03-05T21:43:27.615Z
- Profile URL: https://github.com/brightway-lca
GitHub Events
Total
- Issues event: 5
- Watch event: 1
- Issue comment event: 4
- Push event: 3
Last Year
- Issues event: 5
- Watch event: 1
- Issue comment event: 4
- Push event: 3
Committers metadata
Last synced: 8 days ago
Total Commits: 141
Total Committers: 9
Avg Commits per committer: 15.667
Development Distribution Score (DDS): 0.27
Commits in past year: 33
Committers in past year: 2
Avg Commits per committer in past year: 16.5
Development Distribution Score (DDS) in past year: 0.03
| Name | Commits | |
|---|---|---|
| Michael Weinold | 2****d | 103 |
| jhuo2021 | j****o@e****h | 13 |
| Chirderna | k****r@p****h | 10 |
| Shuyan Xiong | s****g@m****a | 8 |
| mkvdhulst | 7****t | 3 |
| lmeul | 1****l | 1 |
| Nicolas Liénart | n****s@l****t | 1 |
| Marin Visscher | m****r@c****l | 1 |
| Benjamin W. Portner | b****r@b****t | 1 |
Committer domains:
- bauhaus-luftfahrt.net: 1
- cml.leidenuniv.nl: 1
- lienart.net: 1
- mail.mcgill.ca: 1
- psi.ch: 1
- ethz.ch: 1
Issue and Pull Request metadata
Last synced: 2 days ago
Total issues: 38
Total pull requests: 10
Average time to close issues: 3 months
Average time to close pull requests: 1 day
Total issue authors: 11
Total pull request authors: 5
Average comments per issue: 2.26
Average comments per pull request: 0.7
Merged pull request: 8
Bot issues: 0
Bot pull requests: 1
Past year issues: 9
Past year pull requests: 4
Past year average time to close issues: about 11 hours
Past year average time to close pull requests: 7 minutes
Past year issue authors: 5
Past year pull request authors: 2
Past year average comments per issue: 0.67
Past year average comments per pull request: 0.25
Past year merged pull request: 4
Past year bot issues: 0
Past year bot pull requests: 0
Top Issue Authors
- michaelweinold (20)
- KarinTreyer (5)
- GiuliaCavenago93 (3)
- diptavasius (2)
- rafaellaurenti (2)
- juliana-steinbach (1)
- mkvdhulst (1)
- andreadm84 (1)
- katzern (1)
- CristinaMadrid (1)
- tngTUDOR (1)
Top Pull Request Authors
- michaelweinold (4)
- lmeul (2)
- nicolnt (2)
- mrvisscher (1)
- renovate[bot] (1)
Top Issue Labels
- enhancement (16)
- bug (10)
- infrastructure (7)
- documentation (5)
- content (3)
- help wanted (2)
- good first issue (1)
Top Pull Request Labels
Dependencies
- actions/checkout v3 composite
- conda-incubator/setup-miniconda v2 composite
- peaceiris/actions-gh-pages v3.9.3 composite
Score: 5.33271879326537