Skip to content

Commit

Permalink
updated installation guides
Browse files Browse the repository at this point in the history
  • Loading branch information
veenstrajelmer committed Sep 12, 2024
1 parent 1a7aa29 commit f226cf8
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 8 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ A Python package for pre- and postprocessing D-FlowFM model input and output fil

## Information

- install with ``pip install dfm_tools -U`` (or [installation guide](https://deltares.github.io/dfm_tools/installation))
- install with `pip install dfm_tools -U` (or [installation guide](https://deltares.github.io/dfm_tools/installation))
- [online documentation](https://deltares.github.io/dfm_tools) with installation guide, tutorials/examples, API reference and contributing guide.
- Bug or feature request? Create a [GitHub issue](https://github.com/Deltares/dfm_tools/issues)
12 changes: 6 additions & 6 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@

## Basic installation

- ``pip install dfm_tools``
- `pip install dfm_tools`

## Recommended installation

- download Miniforge3 from [the miniforge github](https://github.com/conda-forge/miniforge?tab=readme-ov-file#download) and install it with the recommended settings.
- open Miniforge Prompt
- ``conda create --name dfm_tools_env python=3.11 git spyder -y`` (``git`` and ``spyder`` are optional)
- ``conda activate dfm_tools_env``
- install latest dfm_tools release (stable): ``pip install dfm_tools -U`` (the ``-U`` is for updating)
- alternatively install most recent dfm_tools version from github (might be unstable): ``python -m pip install git+https://github.com/Deltares/dfm_tools``
- to remove environment when necessary: ``conda remove -n dfm_tools_env --all``
- `conda create --name dfm_tools_env python=3.12 git spyder -y` (`git` and `spyder` are optional)
- `conda activate dfm_tools_env`
- install latest dfm_tools release (stable): `pip install dfm_tools -U` (`-U` is for updating)
- alternatively install most recent dfm_tools version from github (might be unstable): `python -m pip install git+https://github.com/Deltares/dfm_tools`
- to remove environment when necessary: `conda remove -n dfm_tools_env --all`

## Potential git/conda issues with installation

Expand Down
1 change: 0 additions & 1 deletion tests/__init__.py

This file was deleted.

0 comments on commit f226cf8

Please sign in to comment.