Skip to content

Commit

Permalink
Add screenshots to wiki
Browse files Browse the repository at this point in the history
  • Loading branch information
marc-vdm committed Sep 17, 2024
1 parent 43150cf commit 91e61a4
Show file tree
Hide file tree
Showing 19 changed files with 53 additions and 23 deletions.
14 changes: 7 additions & 7 deletions activity_browser/docs/wiki/Getting-Started.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,36 +47,36 @@ Finally, the menu bar at the top allows you to manage Activity Browser, Plugins

# Setting up a project
## Installing a biosphere and impact categories
**... reorder this section when screenshots are available**

In the `Project`-tab there is initially a button called `Set up your project with default data`.
In the `Project` tab there is initially a button called `Set up your project with default data`.
Click this button to add the default data.
This adds a `biosphere` database which contains a number of standardized biosphere flows.

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

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

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

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

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

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

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

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

## New databases
With `New` you can create a completely empty database with any given name and
Expand Down
5 changes: 5 additions & 0 deletions activity_browser/docs/wiki/Graph-Explorer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
> [!IMPORTANT]
> This wiki section is __incomplete__ or __outdated__.
>
> Please help us improve the wiki by reading our
> [contributing guidelines](https://github.com/LCA-ActivityBrowser/activity-browser/blob/main/CONTRIBUTING.md#wiki).
3 changes: 2 additions & 1 deletion activity_browser/docs/wiki/Home.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,5 +39,6 @@ ___
- [🎰 Uncertainty](Uncertainty)
- [📈 Flow Scenarios](Flow-Scenarios)
- [📈 Parameter Scenarios](Parameters)
- [🧩 PPlugins](Plugins)
- [🔁 Graph Explorer](Graph-Explorer)
- [🧩 Plugins](Plugins)
- [⚙️ Settings](Settings)
51 changes: 36 additions & 15 deletions activity_browser/docs/wiki/Tutorials.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Write in a few sentences what reader will learn (what problem to solve) from fol
### Before you start
> [!IMPORTANT]
> Make sure you have/know the following:
> - [x] [Have a working installation of Activity Browser](Getting-Started#installation-guide)
> - [x] [Have a working installation of Activity Browser](Installation-Guide)
> - [x] [Have a project set up](Getting-Started#setting-up-a-project)
> - [x] ...
Expand All @@ -73,57 +73,67 @@ and water use impact.
### Before you start
> [!IMPORTANT]
> Make sure you have/know the following:
> - [x] [Have a working installation of Activity Browser](Getting-Started#installation-guide)
> - [x] [Have a working installation of Activity Browser](Installation-Guide)
> - [x] [Have a project set up](Getting-Started#setting-up-a-project)
> - [x] Know the basics of LCA
### 1. Create a new database
- Create new database with the name _'first lca tutorial'_, confirm.
- **... screenshot of new db button marked and name dialog**

![create a database](./assets/_tutorials/first_lca_tutorial_create_db.png)

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

- Right-click on your new database in the `Databases` table and choose `New activity`.
- **... screenshot of context menu and dialog**

![create an activity context menu](./assets/_tutorials/first_lca_tutorial_create_act_context.png)

- Name your new activity _'electricity production, coal'_, confirm.
- This opens your new activity in the `Activity Details` tab on the right.
- **... screenshot of tab**
- This tab shows all information about an activity.
- You can also see your new activity in the database now.

This opens your new activity in the `Activity Details` tab on the right.
This tab shows all information about an activity.
You can also see your new activity in the database on the left now.

![activity details - new activity](./assets/_tutorials/first_lca_tutorial_act_details_1.png)

> [!TIP]
> You can only edit activities when the database is not set to `Read-only` and the activity is set to `Edit Activity`.
> You can set these in the `Databases` table and in the top left of the 'Activity Details' tab respectively.
> You can set these in the `Databases` table and in the top left of the `Activity Details` tab respectively.
> This is done to avoid accidental changes.
>
> Your changes are saved automatically.
- In the `Products` table, change the `Product` name to _'electricity'_ and `Unit` to _'kilowatt hour'_.
- Optionally set the `Location` to your favourite country.
- Optionally set the `Location` to your favourite country.

![activity details - product name](./assets/_tutorials/first_lca_tutorial_act_details_2.png)

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

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

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

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

![activity details - finished activity](./assets/_tutorials/first_lca_tutorial_act_details_3.png)

#### 2.4 Inspecting your system
You have now finished creating a simple product-system for producing electricity from coal.
You may want to inspect if everything in developing your system went correctly.
Expand All @@ -148,6 +160,9 @@ You can open the graph explorer in two ways; 1) by right-clicking on an activity
`Open activity in Graph Explorer`, or 2) in the top left of the `Activity Details`,
by clicking the `Graph Explorer` logo.

![graph explorer context menu](./assets/_tutorials/first_lca_tutorial_db_graph_explorer.png)
![graph explorer context menu](./assets/_tutorials/first_lca_tutorial_graph_explorer.png)

### 3 Creating a calculation setup
Now that we created a product-system, we can calculate its environmental impact.

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

![lca setup](./assets/_tutorials/first_lca_tutorial_lca_setup.png)

### 4 Running an LCA calculation
Now you are ready to calculate results.

- Click the `Calculate` button on the top left of the `LCA Setup` tab.
- When Activity Browser finished the calculation, it will automatically open the `LCA results` tab on the right.

When Activity Browser finished the calculation, it will automatically open the `LCA results` tab on the right.

- Congratulations! You have successfully calculated your first LCA.

![lca results](./assets/_tutorials/first_lca_tutorial_lca_results.png)

> [!NOTE]
> The activities you see in there `Reference flows` table are linked to your system, if you change your system, the changes are saved automatically.
> Do keep in mind that you do need to re-calculate your results every time you make changes.
3 changes: 3 additions & 0 deletions activity_browser/docs/wiki/_Sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@ ___
</details>

___

[**🔁 Graph Explorer**](Graph-Explorer)

[**🧩 Plugins**](Plugins)

<details><summary><b>🚀 Advanced topics</b></summary>
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 91e61a4

Please sign in to comment.