From cf27f19821b44fd817ea4af6a51d719ad6fce2a7 Mon Sep 17 00:00:00 2001 From: Francis Charette-Migneault Date: Fri, 20 May 2022 14:27:14 -0400 Subject: [PATCH] add pypi install command to docs --- docs/installation.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/installation.rst b/docs/installation.rst index 301674db8..8503311fc 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -29,6 +29,12 @@ with it directly. pip install git+https://github.com/Ouranosinc/Magpie.git +To use the PyPI package, employ the following command instead: + +.. code-block:: console + + pip install pavics-magpie + If you desire to develop code features or fixes with `Magpie`, consider using the ``-e`` option to install a reference to your local installation, avoiding distinct instances locally and in ``site-packages``. For example: @@ -42,7 +48,7 @@ If you have ``conda`` installed, you can create an environment and activate it a conda create -n magpie conda activate magpie - pip install magpie + pip install -e All above operations is done automatically with the following command executed from within a local `Magpie` directory: