From f226cf87f7bcaf04941f9ae5cd6078c7389eebc8 Mon Sep 17 00:00:00 2001 From: veenstrajelmer Date: Thu, 12 Sep 2024 12:08:05 +0200 Subject: [PATCH] updated installation guides --- README.md | 2 +- docs/installation.md | 12 ++++++------ tests/__init__.py | 1 - 3 files changed, 7 insertions(+), 8 deletions(-) delete mode 100644 tests/__init__.py diff --git a/README.md b/README.md index 17b1796c0..b023b71c2 100644 --- a/README.md +++ b/README.md @@ -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) diff --git a/docs/installation.md b/docs/installation.md index 8ec6eaee3..2e40c6944 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -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 diff --git a/tests/__init__.py b/tests/__init__.py deleted file mode 100644 index 6bbc93e71..000000000 --- a/tests/__init__.py +++ /dev/null @@ -1 +0,0 @@ -"""Unit test package for dfm_tools."""