Skip to content

Commit

Permalink
re-added structure page and bumped package versions
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelweinold committed Oct 14, 2024
1 parent 0721671 commit f6849db
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 6 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ This will update the URL in the `.gitmodules` file and in the `.git/config` file
2. Use the [`git submodule update`](https://git-scm.com/docs/git-submodule#Documentation/git-submodule.txt-update--init--remote-N--no-fetch--no-recommend-shallow-f--force--checkout--rebase--merge--referenceltrepositorygt--depthltdepthgt--recursive--jobsltngt--no-single-branch--filterltfilterspecgt--ltpathgt82308203) command to update the submodule:

```bash
git submodule update --init --recursive --remote
git submodule update --init --recursive --remote
```

3. Now build the documentation as described above.
Expand Down
10 changes: 5 additions & 5 deletions environment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,20 @@ dependencies:
- python=3.12
- ipython
# sphinx
- sphinx=8.0.2 # core builder # https://anaconda.org/conda-forge/sphinx/files
- sphinx=8.1.3 # core builder # https://anaconda.org/conda-forge/sphinx/files
# theme and extensions
- pydata-sphinx-theme=0.15.4 # website theme # https://anaconda.org/conda-forge/pydata-sphinx-theme/files
- myst-parser=4.0.0 # Markdown support # https://anaconda.org/conda-forge/myst-parser/files
- myst-nb=1.1.1 # Jupyter notebook support # https://anaconda.org/conda-forge/myst-nb/files
- sphinx-autoapi=3.3.1 # to build docs from source code instead of package import # https://anaconda.org/conda-forge/sphinx-autoapi/files
- myst-nb=1.1.2 # Jupyter notebook support # https://anaconda.org/conda-forge/myst-nb/files
- sphinx-autoapi=3.3.2 # to build docs from source code instead of package import # https://anaconda.org/conda-forge/sphinx-autoapi/files
- sphinx-design=0.6.1 # responsive web component support # https://anaconda.org/conda-forge/sphinx-design/files
- sphinx-notfound-page=1.0.4 # custom 404 page # https://anaconda.org/conda-forge/sphinx-notfound-page/files
- graphviz=12.0.0 # for plotting dependency diagrams with sphinx-autoapi # https://anaconda.org/conda-forge/graphviz/files
- sphinxcontrib-mermaid=0.9.2 # https://anaconda.org/conda-forge/sphinxcontrib-mermaid/files
- sphinxcontrib-mermaid=1.0.0 # https://anaconda.org/conda-forge/sphinxcontrib-mermaid/files
- sphinx-favicon=1.0.1 # for custom favicons # https://anaconda.org/conda-forge/sphinx-favicon/files
- sphinx-copybutton=0.5.2 # for copy button in code blocks # https://anaconda.org/conda-forge/sphinx-copybutton/files
# build process
- sphinx-autobuild=2024.9.17 # live-html support # https://anaconda.org/conda-forge/sphinx-autobuild/files
- sphinx-autobuild=2024.10.2 # live-html support # https://anaconda.org/conda-forge/sphinx-autobuild/files
# other packages
- pip
- pip:
Expand Down
1 change: 1 addition & 0 deletions source/content/overview/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ maxdepth: 2
---
self
glossary
structure
ecosystem
inventory
matrix
Expand Down
18 changes: 18 additions & 0 deletions source/content/overview/structure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Brightway Structure

## Brightway Objects

Data in Brightway is structured in a hierarchy. At the top level, we
have projects. A project is self-contained, with its own copy of data,
LCIA methods, calculations, assumptions, and any other data you need.
Each project is completely independent of other projects.Projects are
saved as subdirectories in the file system.

Inside a project we have a number of objects that store data. The most
common data objects are inventory *databases* and impact assessment
*methods*. However, non-LCA data can also be included. For example, a
set of vehicle registrations and lifetimes could also be stored in a
project, and used to generate fleet-based scenarios for sustainability
assessment of mobility services.

![image](_images/org-scheme.png)

0 comments on commit f6849db

Please sign in to comment.