From e1646f382cc82a24069bd0a0cff30a74b62f72ac Mon Sep 17 00:00:00 2001 From: RuudHurkmans <59835874+RuudHurkmans@users.noreply.github.com> Date: Tue, 12 Jan 2021 14:09:21 +0100 Subject: [PATCH] Update README.rst --- README.rst | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/README.rst b/README.rst index e02eb19..40107c7 100644 --- a/README.rst +++ b/README.rst @@ -32,16 +32,6 @@ The package ``delft3dfmpy`` requires you to have (a) an environment with require Please meet these two conditions first with instructions below before installing the Python package ``delft3dfmpy``. - -Python package ``delft3dfmpy`` -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -1. Install the Python package ``delft3dfmpy`` directly, by executing the following command in an Anaconda Prompt - - ``python -m pip install delft3dfmpy`` - -2. If the command prompt states ``Successfully built delft3dfmpy`` then installation is succesful. - - Environment Preparation ^^^^^^^^^^^^^^^^^^^^^^^ Prepare an environment with the correct dependencies for ``delft3dfmpy``. @@ -67,6 +57,20 @@ Prepare an environment with the correct dependencies for ``delft3dfmpy``. You now have a correct and activated environment for installation of the ``delft3dfmpy`` Python package +Python package ``delft3dfmpy`` +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +1. Install the Python package ``delft3dfmpy`` directly, by executing the following command in an Anaconda Prompt + + ``python -m pip install delft3dfmpy`` + + Note that in this way the most recent version that is available on PyPi (see releases) is installed. It is also possible to force installation of older versions. For example, to install version 1.0.0 (the 'frozen' version, or the initial release): + + ``python -m pip install delft3dfmpy=1.0.0`` + Since that version, however, no significant features have been implemented, but there were some minor improvements and bug fixes. + +2. If the command prompt states ``Successfully built delft3dfmpy`` then installation is succesful. + + Envrionment Integration in your IDE ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Integration of the prepared envrionment depends on the IDE of usage. Here we mention briefly some options for the user (pick one!):