Skip to content

Commit

Permalink
Docs update insntallation (#379)
Browse files Browse the repository at this point in the history
* warning readme to not use pip install

* update installation for hydromt fiat

* fix rst

* fix rst

* fix rst codeblock

* update heading

* replace bullet points with numbering

* update headings

* update user install docs
  • Loading branch information
Santonia27 authored Sep 30, 2024
1 parent 377d2f5 commit 1885d44
Showing 1 changed file with 32 additions and 3 deletions.
35 changes: 32 additions & 3 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,42 @@ Installation
User install
------------

HydroMT-FIAT is available from pypi and will be added to conda-forge (in progress).
For Use HydroMT-FIAT, do:
Hydromt-FIAT can be installled in an existing environment or the user can create a new environment. We recommened to create a new environment to avoid issues with other dependencies and packages.

To install HydroMT-FIAT using pip, do:
New environment
To create a new environment follow the steps below.

1. Create a new environment:

.. code-block:: console
conda create -n hydromt_fiat python=3.11.*
2. Activate the environment:

.. code-block:: console
conda activate hydromt_fiat
3. Install conda-forge gdal.

.. code-block:: console
conda install -c conda-forge gdal
4. Install Hydromt-FIAT from Github. After creating the new environment, you need to install all dependencies from the Deltares Github repository. You can use **pip install** to do so:

.. code-block:: console
pip install git+https://github.com/Deltares/hydromt_fiat.git
Existing environment
If you want to install FIAT into an existing environment, simply activate the desired environment and run:

pip install hydromt_fiat
.. code-block:: console
pip install git+https://github.com/Deltares/hydromt_fiat.git
Developer install
Expand Down

0 comments on commit 1885d44

Please sign in to comment.