Skip to content

Commit

Permalink
Changed docs for env generation
Browse files Browse the repository at this point in the history
  • Loading branch information
dalmijn committed Oct 4, 2023
1 parent 7a22fc1 commit 86b7a48
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions docs/dev_guide/dev_install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,21 @@ the code folder (where the envs folder and pyproject.toml are located):
$ git clone https://github.com/Deltares/hydromt_wflow.git
$ cd hydromt_wflow
Then, make and activate a new hydromt-wflow conda environment based on the envs/hydromt-wflow.yml
file contained in the repository:
The next step is to create an environment yaml.
This is done by calling the `make_env.py` script from commandline:
(This requires the presence of the package `tomli` or Python 3.11)

.. code-block:: console
$ conda env create -f envs/hydromt-wflow.yml
$ conda activate hydromt-wflow
$ python make_env.py full
The 'full' argument guarantees all the necessary tools!
Now create the environment using conda and activate it:

.. code-block:: console
$ conda env create -f environment.yml
$ conda activate hydromt_wflow
If you wish to make changes in HydroMT-Wflow, you should make an editable install of the plugin.
This can be done with:
Expand All @@ -35,3 +43,8 @@ This can be done through the following command from your base environment:
.. code-block:: console
$ conda clean -a
It may also be advisable to clear pip's cache:

.. code-block:: console
$ pip cache purge

0 comments on commit 86b7a48

Please sign in to comment.