You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/getting-started/install.rst
+5-6Lines changed: 5 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -263,11 +263,12 @@ They are also not needed for using CLIMADA.
263
263
However, if you want to develop CLIMADA, we strongly recommend you install them.
264
264
265
265
With the ``climada_env`` activated, enter the workspace directory and then the CLIMADA repository as above.
266
-
Then, add the ``dev`` extra specification to the ``pip install`` command (**mind the quotation marks**, and see also `pip install examples <https://pip.pypa.io/en/stable/cli/pip_install/#examples>`_):
266
+
Then, add the ``test`` extra specification to the ``pip install`` command (**mind the quotation marks**,
267
+
and see also `pip install examples <https://pip.pypa.io/en/stable/cli/pip_install/#examples>`_):
267
268
268
269
.. code-block:: shell
269
270
270
-
python -m pip install -e "./[dev]"
271
+
python -m pip install -e "./[test]"
271
272
272
273
The CLIMADA Python package defines the following `extras <https://peps.python.org/pep-0508/#extras>`_:
273
274
@@ -277,12 +278,10 @@ The CLIMADA Python package defines the following `extras <https://peps.python.or
277
278
278
279
* - Extra
279
280
- Includes Dependencies...
280
-
* - ``doc``
281
-
- for building documentation
282
281
* - ``test``
283
282
- for running and evaluating tests
284
-
* - ``dev``
285
-
- combination of ``doc`` and ``test``, and additional tools for development
283
+
* - ``doc``
284
+
- for building documentation
286
285
287
286
The developer dependencies also include `pre-commit <https://pre-commit.com/#intro>`_, which is used to install and run automated, so-called pre-commit hooks before a new commit.
288
287
In order to use the hooks defined in ``.pre-commit-config.yaml``, you need to install the hooks first.
0 commit comments