Skip to content

Commit 91e61a4

Browse files
committed
Add screenshots to wiki
1 parent 43150cf commit 91e61a4

19 files changed

Lines changed: 53 additions & 23 deletions

activity_browser/docs/wiki/Getting-Started.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,36 +47,36 @@ Finally, the menu bar at the top allows you to manage Activity Browser, Plugins
4747

4848
# Setting up a project
4949
## Installing a biosphere and impact categories
50-
**... reorder this section when screenshots are available**
51-
52-
In the `Project`-tab there is initially a button called `Set up your project with default data`.
50+
In the `Project` tab there is initially a button called `Set up your project with default data`.
5351
Click this button to add the default data.
5452
This adds a `biosphere` database which contains a number of standardized biosphere flows.
5553

5654
> [!NOTE]
5755
> Once a project is set up, you cannot reset it.
5856
59-
**... screenshot of first dialog page**
57+
![project setup - choose type](./assets/project_setup_dialog_choose_type.png)
6058

6159
### Setting up with Biosphere3 data
6260
You can choose a biosphere version, this biosphere version will be compatible with that version of ecoinvent,
6361
if you choose to import that later.
6462
If you don't use ecoinvent, don't worry about this and choose the highest version.
6563

66-
**... screenshot of relevant dialog**
64+
![project setup - choose biosphere version](./assets/project_setup_dialog_bio_vsn.png)
6765

6866
### Setting up with ecoinvent data
6967
If you have a valid ecoinvent license and login information, you can immediately set up ecoinvent in your project with all
7068
relevant and compatible data.
69+
You can then choose the database version and system model.
7170

72-
**... screenshot of relevant dialog**
71+
![project setup - ecoinvent login](./assets/project_setup_dialog_ei_login.png)
72+
![project setup - ecoinvent version and system model](./assets/project_setup_dialog_ei_vsn_and_model.png)
7373

7474
[Read more about projects...](Projects)
7575

7676
# LCI databases
7777
After adding the default data, you can create or import a database with the `New` and `Import Database` buttons.
7878

79-
**... Screenshot of AB left pane until new/import buttons**
79+
![project tab until databases](./assets/project_tab_until_databases.png)
8080

8181
## New databases
8282
With `New` you can create a completely empty database with any given name and
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
> [!IMPORTANT]
2+
> This wiki section is __incomplete__ or __outdated__.
3+
>
4+
> Please help us improve the wiki by reading our
5+
> [contributing guidelines](https://github.com/LCA-ActivityBrowser/activity-browser/blob/main/CONTRIBUTING.md#wiki).

activity_browser/docs/wiki/Home.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,5 +39,6 @@ ___
3939
- [🎰 Uncertainty](Uncertainty)
4040
- [📈 Flow Scenarios](Flow-Scenarios)
4141
- [📈 Parameter Scenarios](Parameters)
42-
- [🧩 PPlugins](Plugins)
42+
- [🔁 Graph Explorer](Graph-Explorer)
43+
- [🧩 Plugins](Plugins)
4344
- [⚙️ Settings](Settings)

activity_browser/docs/wiki/Tutorials.md

Lines changed: 36 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Write in a few sentences what reader will learn (what problem to solve) from fol
4848
### Before you start
4949
> [!IMPORTANT]
5050
> Make sure you have/know the following:
51-
> - [x] [Have a working installation of Activity Browser](Getting-Started#installation-guide)
51+
> - [x] [Have a working installation of Activity Browser](Installation-Guide)
5252
> - [x] [Have a project set up](Getting-Started#setting-up-a-project)
5353
> - [x] ...
5454
@@ -73,57 +73,67 @@ and water use impact.
7373
### Before you start
7474
> [!IMPORTANT]
7575
> Make sure you have/know the following:
76-
> - [x] [Have a working installation of Activity Browser](Getting-Started#installation-guide)
76+
> - [x] [Have a working installation of Activity Browser](Installation-Guide)
7777
> - [x] [Have a project set up](Getting-Started#setting-up-a-project)
7878
> - [x] Know the basics of LCA
7979
8080
### 1. Create a new database
8181
- Create new database with the name _'first lca tutorial'_, confirm.
82-
- **... screenshot of new db button marked and name dialog**
82+
83+
![create a database](./assets/_tutorials/first_lca_tutorial_create_db.png)
8384

8485
### 2. Create the system
8586
#### 2.1 Creating activities
8687
To assess the environmental impact of generating electricity from coal, we need to model the production of
8788
electricity and coal first.
8889

8990
- Right-click on your new database in the `Databases` table and choose `New activity`.
90-
- **... screenshot of context menu and dialog**
91+
92+
![create an activity context menu](./assets/_tutorials/first_lca_tutorial_create_act_context.png)
93+
9194
- Name your new activity _'electricity production, coal'_, confirm.
92-
- This opens your new activity in the `Activity Details` tab on the right.
93-
- **... screenshot of tab**
94-
- This tab shows all information about an activity.
95-
- You can also see your new activity in the database now.
95+
96+
This opens your new activity in the `Activity Details` tab on the right.
97+
This tab shows all information about an activity.
98+
You can also see your new activity in the database on the left now.
99+
100+
![activity details - new activity](./assets/_tutorials/first_lca_tutorial_act_details_1.png)
96101

97102
> [!TIP]
98103
> You can only edit activities when the database is not set to `Read-only` and the activity is set to `Edit Activity`.
99-
> You can set these in the `Databases` table and in the top left of the 'Activity Details' tab respectively.
104+
> You can set these in the `Databases` table and in the top left of the `Activity Details` tab respectively.
100105
> This is done to avoid accidental changes.
101106
>
102107
> Your changes are saved automatically.
103108
104109
- In the `Products` table, change the `Product` name to _'electricity'_ and `Unit` to _'kilowatt hour'_.
105-
- Optionally set the `Location` to your favourite country.
110+
- Optionally set the `Location` to your favourite country.
111+
112+
![activity details - product name](./assets/_tutorials/first_lca_tutorial_act_details_2.png)
106113

107114
> [!NOTE]
108115
> Units in Brightway and Activity Browser are 'just' text.
109116
> Units don't have an inherent meaning or relationships to each other.
110117
111118
#### 2.2 Linking activities
112-
- In the `Databases` table in the `Project` tab on the left, open the database `biosphere3` by double-clicking on it.
119+
- In the `Databases` table in the `Project` tab on the left, open the database _'biosphere3'_ by double-clicking on it.
113120

114121
> [!NOTE]
115122
> All databases that you have open in a project are shown as tabs underneath the `Databases` table.
116123
117-
- Search for _'carbon dioxide, fossil'_ in the database the category does not matter right now.
124+
- Search for _'carbon dioxide, fossil'_ in the database, the category does not matter right now.
118125
- In the `Activity Details` show the (still empty) `Biosphere Flows` table by ticking the box.
119-
- Drag the _'carbon dioxide, fossil'_ biosphere flow to the `Biosphere Flows` table.
126+
- Drag the one of the _'carbon dioxide, fossil'_ biosphere flows to the `Biosphere Flows` table.
120127
- Set the `Amount` to 0.9 kilogram by double-clicking on the `Amount` field and changing the value.
121128

129+
> [!TIP]
130+
> You can resize the tables in the activity details by dragging the 'splitter' up or down.
131+
122132
#### 2.3 Finishing your system
123133
Of course, electricity cannot be generated from nothing, so we need to
124134
add the production of coal as a new activity to the system.
125135

126-
- Create a new activity named _'coal mining'_ with as `Product` name _'coal'_ and as unit _'kilogram'_.
136+
- Create a new activity named _'coal mining'_ with as `Product` name _'coal'_ and as `Unit` _'kilogram'_.
127137
- Again add the _'carbon dioxide, fossil'_ biosphere flow to the activity, set the `Amount` to 0.15 kilogram.
128138
- Now switch back to the `Activity Details` of the process _'electricity production, coal'_.
129139
- From the database _'first lca tutorial'_ add the _'coal mining'_ activity you just created to the
@@ -136,6 +146,8 @@ and also add electricity as input there
136146
- Open the _'coal mining'_ activity again and add _'electricity production'_ to the process
137147
- Set the `Amount` to 0.01 kilowatt hour.
138148

149+
![activity details - finished activity](./assets/_tutorials/first_lca_tutorial_act_details_3.png)
150+
139151
#### 2.4 Inspecting your system
140152
You have now finished creating a simple product-system for producing electricity from coal.
141153
You may want to inspect if everything in developing your system went correctly.
@@ -148,6 +160,9 @@ You can open the graph explorer in two ways; 1) by right-clicking on an activity
148160
`Open activity in Graph Explorer`, or 2) in the top left of the `Activity Details`,
149161
by clicking the `Graph Explorer` logo.
150162

163+
![graph explorer context menu](./assets/_tutorials/first_lca_tutorial_db_graph_explorer.png)
164+
![graph explorer context menu](./assets/_tutorials/first_lca_tutorial_graph_explorer.png)
165+
151166
### 3 Creating a calculation setup
152167
Now that we created a product-system, we can calculate its environmental impact.
153168

@@ -157,13 +172,19 @@ Now that we created a product-system, we can calculate its environmental impact.
157172
- On the left, open the tab `Impact Categories` and search for _'GWP100'_ and choose one of the impact categories,
158173
drag it to the `Impact categories` table.
159174

175+
![lca setup](./assets/_tutorials/first_lca_tutorial_lca_setup.png)
176+
160177
### 4 Running an LCA calculation
161178
Now you are ready to calculate results.
162179

163180
- Click the `Calculate` button on the top left of the `LCA Setup` tab.
164-
- When Activity Browser finished the calculation, it will automatically open the `LCA results` tab on the right.
181+
182+
When Activity Browser finished the calculation, it will automatically open the `LCA results` tab on the right.
183+
165184
- Congratulations! You have successfully calculated your first LCA.
166185

186+
![lca results](./assets/_tutorials/first_lca_tutorial_lca_results.png)
187+
167188
> [!NOTE]
168189
> The activities you see in there `Reference flows` table are linked to your system, if you change your system, the changes are saved automatically.
169190
> Do keep in mind that you do need to re-calculate your results every time you make changes.

activity_browser/docs/wiki/_Sidebar.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,9 @@ ___
4141
</details>
4242

4343
___
44+
45+
[**🔁 Graph Explorer**](Graph-Explorer)
46+
4447
[**🧩 Plugins**](Plugins)
4548

4649
<details><summary><b>🚀 Advanced topics</b></summary>
22.4 KB
Loading
16.5 KB
Loading
30.4 KB
Loading
19.7 KB
Loading
27.3 KB
Loading

0 commit comments

Comments
 (0)