Skip to content

Commit

Permalink
Fix doc
Browse files Browse the repository at this point in the history
  • Loading branch information
raphaeljolivet committed Apr 29, 2024
1 parent e128d89 commit f7b55e2
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 4 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ First create a python environment, with **Python** [>=3.9] :
**With Conda (or [mamba](https://mamba.readthedocs.io/en/latest/index.html))**

```bash
conda env create -n lca python==3.10
conda create -n lca python==3.10
conda activate lca
```

Expand All @@ -40,7 +40,19 @@ source .venv/bin/activate

## 2) Install lca_algebraic

> pip install lca_algebraic
> pip install lca_algebraic
## 3) [Optional] Install Jupyter & Activity Browser

You may also install Jupyter and [Activity Browser](https://github.com/LCA-ActivityBrowser/activity-browser) on the same
environment.

**Jupyter** :
> pip install jupyter
**Activity Browser** can only be installed via conda/mamba. Note that it can also be installed on a separate Python env and will
still be able to access and browse the projects created programmatically with *lca_algebraic* / *Brightway*.
> conda install activity-browser

# Licence & Copyright
Expand Down
25 changes: 23 additions & 2 deletions doc/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ First create a python environment, with **Python** [>=3.9] :
**With Conda (or [mamba](https://mamba.readthedocs.io/en/latest/index.html))**

```bash
conda env create -n lca python==3.10
conda create -n lca python==3.10
conda activate lca
```

Expand All @@ -42,17 +42,38 @@ source .venv/bin/activate

> pip install lca_algebraic
## Source code

## 3) [Optional] Install Jupyter & Activity Browser

You may also install Jupyter and [Activity Browser](https://github.com/LCA-ActivityBrowser/activity-browser) on the same
environment.

**Jupyter** :
> pip install jupyter
**Activity Browser** can only be installed via conda/mamba. Note that it can also be installed on environment and will
still be able to access and browse the projects created programmatically with *lca_algebraic* / *Brightway*.
> conda install activity-browser
# Source code

The source code is available of our {gitref}`github </>`


# Licence & Copyright

This library has been developed by [OIE - MinesParistech](http://www.oie.mines-paristech.fr), for the project [*INCER-ACV*](https://librairie.ademe.fr/energies-renouvelables-reseaux-et-stockage/4448-incer-acv.html),
lead by [ADEME](https://www.ademe.fr/).

It is distributed under the {gitref}`BSD License </LICENSE>`.

# Mailing list

Please register to this dedicated mailing list to discuss the evolutions of this library and be informed of future releases :

[[email protected]](https://groupes.minesparis.psl.eu/wws/subscribe/lca_algebraic)


# Summary

```{toctree}
Expand Down

0 comments on commit f7b55e2

Please sign in to comment.