diff --git a/docs/content/installation.md b/docs/content/installation.md new file mode 100644 index 0000000..2ba5dcf --- /dev/null +++ b/docs/content/installation.md @@ -0,0 +1,77 @@ +# Installation + +`timex_lca` is a Python software package. It's available via [`pip`](https://pypi.org/project/pip/) or [`conda`](https://docs.conda.io/en/latest/) / [`mamba`](https://mamba.readthedocs.io/en/latest/). + +```{note} +We currently recommend the installation via `conda` or `mamba`. That's what we're providing detailed instructions for below. +``` + +## Installing `timex_lca` using `conda` or `mamba` + +```{admonition} Prerequisites +:class: important +1. A working installation of `conda` or `mamba`. If you are using `conda`, we recommend installing the [libmamba solver](https://www.anaconda.com/blog/a-faster-conda-for-a-growing-community). +2. Basic knowledge of [Conda environments](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html) +``` + +::::{tab-set} + +:::{tab-item} Linux, Windows, or MacOS (x64) + +1. Create a new Conda environment (in this example named `timex`): + +```console +conda create -n timex -c conda-forge -c cmutel -c diepers brightway25 timex_lca +``` + +2. Activate the environment: + +```console +conda activate timex +``` + +3. (Optional but recommended) You can also use conda to install useful libraries like `jupyterlab`: + +```console +conda install -c conda-forge jupyterlab +``` + +::: + +:::{tab-item} macOS (Apple Silicon/ARM) + +```{note} +Brightway runs on the new Apple Silicon ARM architecture. However, the super-fast linear algebra software library `pypardiso` is not compatible with the ARM processor architecture. To avoid critical errors during instruction that would break core functionality, a different version of Brightway (`brightway_nosolver`) and a a different linear algebra software library (`scikit-umfpack`) must be installed. +``` + +1. Create a new Conda environment (in this example named `brightway`): + +``` +conda create -n timex -c conda-forge -c cmutel -c diepers brightway25_nosolver scikit-umfpack timex_lca +``` + +2. Activate the environment: + +``` +conda activate timex +``` + +3. (Optional but recommended) You can also use conda to install useful libraries like `jupyterlab`: + +```console +conda install -c conda-forge jupyterlab +``` + +:::: + +## Updating `timex_lca` + +`timex_lca` is being actively developed, with frequent new releases. To update Brightway using `conda` or `mamba`, activate your environment, and run: + +``` bash +conda update -c diepers timex_lca +``` + +```{warning} +Newer versions of `timex_lca` can introduce breaking changes. We recommend you create a new environment for each project, and only update `timex_lca` when you are ready to update your project. +``` \ No newline at end of file diff --git a/docs/content/installation.rst b/docs/content/installation.rst deleted file mode 100644 index a678edb..0000000 --- a/docs/content/installation.rst +++ /dev/null @@ -1,3 +0,0 @@ -======== -Installation -========