diff --git a/activity_browser/docs/wiki/Flow-Scenarios.md b/activity_browser/docs/wiki/Flow-Scenarios.md index 6308e1128..35519e4f0 100644 --- a/activity_browser/docs/wiki/Flow-Scenarios.md +++ b/activity_browser/docs/wiki/Flow-Scenarios.md @@ -3,3 +3,11 @@ > > Please help us improve the wiki by reading our > [contributing guidelines](https://github.com/LCA-ActivityBrowser/activity-browser/blob/main/CONTRIBUTING.md#wiki). + +### Video overview of modelling and calculating scenarios + +[![Projects and Databases](https://img.youtube.com/vi/3LPcpV1G_jg/hqdefault.jpg)](https://www.youtube.com/watch?v=3LPcpV1G_jg) + + +Note: some content of the video may be outdated. Written content should be more up-to-date. + \ No newline at end of file diff --git a/activity_browser/docs/wiki/Getting-Started.md b/activity_browser/docs/wiki/Getting-Started.md index 77e1b5b4b..c13882be2 100644 --- a/activity_browser/docs/wiki/Getting-Started.md +++ b/activity_browser/docs/wiki/Getting-Started.md @@ -1,6 +1,6 @@ [Learn how to install Activity Browser...](Installation-Guide) -# Starting Activity Browser +## Starting Activity Browser First activate the environment where the activity browser is installed: ```bash @@ -9,13 +9,13 @@ conda activate ab Then simply run `activity-browser` and the application will open. -# Understanding Activity Browser terms +## Understanding Activity Browser terms Activity Browser uses [Brightway](https://docs.brightway.dev/en/latest/) for its data management and calculations. Brightway has its own 'accent' of LCA terms, you can compare LCA terms from Brightway, [ISO 14044 (2006)](https://www.iso.org/standard/38498.html) and others in the [Brightway Glossary](https://docs.brightway.dev/en/latest/content/other/glossary.html). -# Organization of data in Brightway and Activity Browser +## Organization of data in Brightway and Activity Browser Data in Brightway is organized into projects - Projects contain databases, impact categories, calculation setups and more - Databases contain activities (biosphere and technosphere) @@ -33,7 +33,7 @@ _Image copied from the Read more about how data is organized in the [Brightway documentation](https://docs.brightway.dev/en/latest/content/theory/structure.html#brightway-objects). -# User interface +## User interface Activity Browser is organized in two panels, which themselves have tabs and a menu bar. The left panel has a `Project` tab and an `Impact Categories` tab. The right panel has the `Welcome` screen, `LCA setup` tab, `Parameters` tab and -if used- an `LCA Results` tab. @@ -45,8 +45,17 @@ The [`Parameters`](Parameters) tab allows you to manage your parameters. The [`LCA Results`](LCA-Results) tab shows the results of the calculations you do. Finally, the menu bar at the top allows you to manage Activity Browser, Plugins and Project settings. -# Setting up a project -## Installing a biosphere and impact categories +## Setting up a project + +### Video overview of project setup + +[![Projects and Databases](https://img.youtube.com/vi/qWzaQjAf8ZU/hqdefault.jpg)](https://www.youtube.com/watch?v=qWzaQjAf8ZU) + + +Note: some content of the video may be outdated. Written content should be more up-to-date. + + +### Installing a biosphere and impact categories 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. @@ -56,14 +65,14 @@ This adds a `biosphere` database which contains a number of standardized biosphe ![project setup - choose type](./assets/project_setup_dialog_choose_type.png) -### Setting up with Biosphere3 data +#### 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. ![project setup - choose biosphere version](./assets/project_setup_dialog_bio_vsn.png) -### Setting up with ecoinvent data +#### 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. @@ -73,18 +82,18 @@ You can then choose the database version and system model. [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. +## LCI databases +After adding the default data, you can create or import a database with the `New` and `Import Database` buttons. ![project tab until databases](./assets/project_tab_until_databases.png) -## New databases +### New databases With `New` you can create a completely empty database with any given name and enter your own activity data. [Read more about activities...](Activities) -## Importing databases +### Importing databases Clicking 'Import' will open a new dialog that will allow you to select how you want to import data into brightway (and by extension, the Activity Browser). There are two main options: 'remote data' and 'local data': @@ -93,11 +102,11 @@ There are two main options: 'remote data' and 'local data': We currently support 2 remote databases, Ecoinvent and Forwast: -### Importing Ecoinvent +#### Importing Ecoinvent [**Ecoinvent**](https://ecoinvent.org/) is a paid database you can install directly in Activity Browser if you have a valid ecoinvent license and login information. -### Importing Forwast +#### Importing Forwast [**Forwast**](http://forwast.brgm.fr/) is a free database you can install directly in Activity Browser. ___ @@ -114,17 +123,35 @@ ___ [Read more about databases...](Databases) -# Running an LCA calculation +### Video overview of working with Activities in Databases + +[![Projects and Databases](https://img.youtube.com/vi/2rmydYdscJY/hqdefault.jpg)](https://www.youtube.com/watch?v=2rmydYdscJY) + + +Note: some content of the video may be outdated. Written content should be more up-to-date. + + +[Read more about activities...](Activities) + +## Running an LCA calculation To run an LCA, you must first create a calculation setup, add at least one reference flow and one impact category to be able to calculate results. +### Video overview of calculating LCA results + +[![LCA results](https://img.youtube.com/vi/J94UehVQM-Q/hqdefault.jpg)](https://www.youtube.com/watch?v=J94UehVQM-Q) + + +Note: some content of the video may be outdated. Written content should be more up-to-date. + + [Read more about LCA calculation setups...](LCA-Calculation-Setups) [Read more about LCA results...](LCA-Results) [Follow a tutorial to do your first LCA...](Tutorials#your-first-lca) -# Additional Resources +## Additional Resources - [Youtube tutorials](https://www.youtube.com/channel/UCsyySKrzEMsRFsWW1Oz-6aA/) - [Introduction video by ETH Zurich](https://www.youtube.com/watch?v=j3uLptvsxeA) - [AB Discussions page](https://github.com/LCA-ActivityBrowser/activity-browser/discussions) diff --git a/activity_browser/docs/wiki/Home.md b/activity_browser/docs/wiki/Home.md index 02e89142f..d6385df46 100644 --- a/activity_browser/docs/wiki/Home.md +++ b/activity_browser/docs/wiki/Home.md @@ -8,7 +8,7 @@ Welcome to the Activity Browser wiki! The wiki aims to help users get started and to document all features in Activity Browser. -# Getting started +## Getting started **Check out these resources to get you started with Activity Browser** - [Installation guide](Installation-Guide) - [Updating Activity Browser](Installation-Guide#updating-activity-browser) @@ -22,13 +22,22 @@ The wiki aims to help users get started and to document all features in Activity - [Need help?](Need-Help) ___ -# Tutorials +## Tutorials Have a look at our [tutorials page](Tutorials) to follow along with examples. - [Follow a tutorial to do your first LCA](Tutorials#your-first-lca) ___ -# Documentation +## Video overview of Activity Browser + +[![What is the Activity Browser video](https://img.youtube.com/vi/oeL_FOsNYfU/hqdefault.jpg)](https://www.youtube.com/watch?v=oeL_FOsNYfU) + + +Note: some content of the video may be outdated. Written content should be more up-to-date. + + +___ +## Documentation - [📚 Projects](Projects) - [📒 Databases](Databases) diff --git a/activity_browser/docs/wiki/Tutorials.md b/activity_browser/docs/wiki/Tutorials.md index 60c44ff57..6eca50420 100644 --- a/activity_browser/docs/wiki/Tutorials.md +++ b/activity_browser/docs/wiki/Tutorials.md @@ -123,6 +123,9 @@ Your `Activity Details` tab should look like below: > 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. > +> Every time you close an `Activity Details` tab, the editing state will be reset, when you open the activity again you +> need to re-enable editing to continue to make changes. +> > Your changes are saved automatically. Now, we can fill in information in the empty activity. @@ -165,7 +168,8 @@ If you are unsure about something specific, just read back to find the informati - 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'_. +- Now switch back to the `Activity Details` of the activity _'electricity production, coal'_. + - Remember, if you have closed this activity in the mean time, you need to re-enable the `Edit Activty` toggle. - From the database _'first lca tutorial'_ add the _'coal mining'_ activity you just created to the `Technosphere Flows` table of the _electricity production_ process. - Remember to show the `Technosphere Flows` table again before adding the flow.