brightway-book
📖🌿 Interactive jupyter-book Documentation for Brightway
Science Score: 23.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
○.zenodo.json file
-
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
4 of 9 committers (44.4%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (2.1%) to scientific vocabulary
Keywords
Repository
📖🌿 Interactive jupyter-book Documentation for Brightway
Basic Info
- Host: GitHub
- Owner: brightway-lca
- License: bsd-3-clause
- Language: Jupyter Notebook
- Default Branch: main
- Homepage: https://learn.brightway.dev
- Size: 15.3 MB
Statistics
- Stars: 21
- Watchers: 8
- Forks: 7
- Open Issues: 5
- Releases: 1
Topics
Metadata Files
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
bash
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:
bash
conda env create -f environment.yml
and activate the environment:
bash
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:
bash
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
- Name: Brightway LCA software framework
- Login: brightway-lca
- Kind: organization
- Website: https://docs.brightway.dev/
- Repositories: 28
- Profile: https://github.com/brightway-lca
Open source framework for Brightway framework
GitHub Events
Total
- Issues event: 5
- Watch event: 3
- Issue comment event: 4
- Push event: 3
Last Year
- Issues event: 5
- Watch event: 3
- Issue comment event: 4
- Push event: 3
Committers
Last synced: 6 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Michael Weinold | 2****d@u****m | 103 |
| jhuo2021 | j****o@e****h | 13 |
| Chirderna | k****r@p****h | 10 |
| Shuyan Xiong | s****g@m****a | 8 |
| mkvdhulst | 7****t@u****m | 3 |
| Benjamin W. Portner | b****r@b****t | 1 |
| Marin Visscher | m****r@c****l | 1 |
| Nicolas Liénart | n****s@l****t | 1 |
| lmeul | 1****l@u****m | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 34
- Total pull requests: 9
- 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.41
- Average comments per pull request: 0.56
- Merged pull requests: 7
- Bot issues: 0
- Bot pull requests: 1
Past Year
- Issues: 7
- Pull requests: 4
- Average time to close issues: about 11 hours
- Average time to close pull requests: 7 minutes
- Issue authors: 5
- Pull request authors: 2
- Average comments per issue: 0.71
- Average comments per pull request: 0.25
- Merged pull requests: 4
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- michaelweinold (18)
- KarinTreyer (5)
- GiuliaCavenago93 (2)
- rafaellaurenti (2)
- diptavasius (1)
- juliana-steinbach (1)
- mkvdhulst (1)
- mariashoeller (1)
- andreadm84 (1)
- katzern (1)
- CristinaMadrid (1)
- tngTUDOR (1)
Pull Request Authors
- michaelweinold (7)
- mrvisscher (2)
- lmeul (2)
- nicolnt (2)
- renovate[bot] (1)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- actions/checkout v3 composite
- conda-incubator/setup-miniconda v2 composite
- peaceiris/actions-gh-pages v3.9.3 composite