Skip to content

Commit d5ca0de

Browse files
make installation instructions more concise, add comments
1 parent 327150e commit d5ca0de

1 file changed

Lines changed: 12 additions & 9 deletions

File tree

doc/getting-started/install.rst

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -146,17 +146,17 @@ Simple Instructions with Pixi (Alternative)
146146
-------------------
147147

148148
As an alternative to mamba `Pixi <https://pixi.sh/>` can be used to install climada from conda-forge.
149+
`Pixi`_ is a modern package manager that is based on `Conda`_ and offers much faster dependency resolution.
149150

150151
.. important::
151152

152-
On Windows, installing ``climada-petals`` from ``conda-forge`` may fail with ``mamba`` or ``conda`` in some setups due to dependency resolution issues.
153-
In these cases, Pixi is often the most reliable fallback and can sometimes be the only working installation path.
153+
On Windows, installing ``climada-petals`` with `Conda`_ / `Mamba`_ may be prohibited as it takes forever to resolve the dependency tree.
154+
In these cases, `Pixi`_ is often the only reliable fallback.
154155

155156
#. Open the command line and create a new folder for your Pixi project:
156157

157158
.. code-block:: shell
158159
159-
mkdir climada_pixi
160160
pixi init climada_pixi
161161
162162
.. _install-simple:
@@ -165,24 +165,27 @@ As an alternative to mamba `Pixi <https://pixi.sh/>` can be used to install clim
165165

166166
.. code-block:: shell
167167
168-
pixi shell --manifest-path climada_pixi/pixi.toml
169-
pixi add climada
168+
pixi add --manifest-path climada_pixi/pixi.toml climada
170169
171170
#. Verify that everything is installed correctly by executing a single test:
172171

173172
.. code-block:: shell
174173
174+
# the pixi way to activate an environment
175+
pixi shell --manifest-path climada_pixi/pixi.toml
176+
# execute the test
175177
python -m unittest climada.engine.test.test_impact
178+
# the pixi way to deactivate an environment
179+
exit
176180
177-
Executing CLIMADA for the first time will take some time because it will generate a directory tree in your home/user directory.
178-
If this test passes, great!
179-
You are good to go.
181+
Executing CLIMADA for the first time in a pixi environment will take quite some time because it will generate
182+
a directory tree in your home/user directory. If this test passes, great! You are good to go.
180183

181184
#. *Optional:* Install CLIMADA Petals into the same Pixi environment:
182185

183186
.. code-block:: shell
184187
185-
pixi add climada-petals
188+
pixi add --manifest-path climada_pixi/pixi.toml climada-petals
186189
187190
.. _install-advanced:
188191

0 commit comments

Comments
 (0)