From 49e6d19f512022607fafc5b126d3ce8d5c45396b Mon Sep 17 00:00:00 2001 From: Lionel C <43442120+lionel42@users.noreply.github.com> Date: Thu, 24 Oct 2024 16:00:47 +0200 Subject: [PATCH] Update install instructions (#68) * remove github release * update for version to work * fix placeholder * installation with pip --- docs/source/installation.rst | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/docs/source/installation.rst b/docs/source/installation.rst index ba887e9..1c090bc 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -1,18 +1,31 @@ Installation ============ +With pip +-------- + +The easiest way to install emiproc is to use pip. This will install the latest +release from PyPI. + +.. code:: bash + + pip install emiproc + +From source +----------- -Installing emiproc can be done as a standard python package. First create a folder for emiproc and go into it -.. code:: +.. code:: bash mkdir emiproc cd emiproc -Clone the repository:: +Clone the repository + +.. code:: bash git clone https://github.com/C2SM-RCM/emiproc.git . @@ -21,7 +34,7 @@ Then install using pip. Installing as an editable (`-e` options) allows you to directly modify the cloned code. -.. code:: +.. code:: bash pip install -e .