Skip to content

Commit f6849db

Browse files
re-added structure page and bumped package versions
1 parent 0721671 commit f6849db

File tree

4 files changed

+25
-6
lines changed

4 files changed

+25
-6
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ This will update the URL in the `.gitmodules` file and in the `.git/config` file
179179
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:
180180

181181
```bash
182-
git submodule update --init --recursive --remote
182+
git submodule update --init --recursive --remote
183183
```
184184

185185
3. Now build the documentation as described above.

environment.yaml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,20 @@ dependencies:
77
- python=3.12
88
- ipython
99
# sphinx
10-
- sphinx=8.0.2 # core builder # https://anaconda.org/conda-forge/sphinx/files
10+
- sphinx=8.1.3 # core builder # https://anaconda.org/conda-forge/sphinx/files
1111
# theme and extensions
1212
- pydata-sphinx-theme=0.15.4 # website theme # https://anaconda.org/conda-forge/pydata-sphinx-theme/files
1313
- myst-parser=4.0.0 # Markdown support # https://anaconda.org/conda-forge/myst-parser/files
14-
- myst-nb=1.1.1 # Jupyter notebook support # https://anaconda.org/conda-forge/myst-nb/files
15-
- sphinx-autoapi=3.3.1 # to build docs from source code instead of package import # https://anaconda.org/conda-forge/sphinx-autoapi/files
14+
- myst-nb=1.1.2 # Jupyter notebook support # https://anaconda.org/conda-forge/myst-nb/files
15+
- sphinx-autoapi=3.3.2 # to build docs from source code instead of package import # https://anaconda.org/conda-forge/sphinx-autoapi/files
1616
- sphinx-design=0.6.1 # responsive web component support # https://anaconda.org/conda-forge/sphinx-design/files
1717
- sphinx-notfound-page=1.0.4 # custom 404 page # https://anaconda.org/conda-forge/sphinx-notfound-page/files
1818
- graphviz=12.0.0 # for plotting dependency diagrams with sphinx-autoapi # https://anaconda.org/conda-forge/graphviz/files
19-
- sphinxcontrib-mermaid=0.9.2 # https://anaconda.org/conda-forge/sphinxcontrib-mermaid/files
19+
- sphinxcontrib-mermaid=1.0.0 # https://anaconda.org/conda-forge/sphinxcontrib-mermaid/files
2020
- sphinx-favicon=1.0.1 # for custom favicons # https://anaconda.org/conda-forge/sphinx-favicon/files
2121
- sphinx-copybutton=0.5.2 # for copy button in code blocks # https://anaconda.org/conda-forge/sphinx-copybutton/files
2222
# build process
23-
- sphinx-autobuild=2024.9.17 # live-html support # https://anaconda.org/conda-forge/sphinx-autobuild/files
23+
- sphinx-autobuild=2024.10.2 # live-html support # https://anaconda.org/conda-forge/sphinx-autobuild/files
2424
# other packages
2525
- pip
2626
- pip:

source/content/overview/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ maxdepth: 2
2525
---
2626
self
2727
glossary
28+
structure
2829
ecosystem
2930
inventory
3031
matrix

source/content/overview/structure.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Brightway Structure
2+
3+
## Brightway Objects
4+
5+
Data in Brightway is structured in a hierarchy. At the top level, we
6+
have projects. A project is self-contained, with its own copy of data,
7+
LCIA methods, calculations, assumptions, and any other data you need.
8+
Each project is completely independent of other projects.Projects are
9+
saved as subdirectories in the file system.
10+
11+
Inside a project we have a number of objects that store data. The most
12+
common data objects are inventory *databases* and impact assessment
13+
*methods*. However, non-LCA data can also be included. For example, a
14+
set of vehicle registrations and lifetimes could also be stored in a
15+
project, and used to generate fleet-based scenarios for sustainability
16+
assessment of mobility services.
17+
18+
![image](_images/org-scheme.png)

0 commit comments

Comments
 (0)