From 19ed48a4883c91d0569224a22ab234007124e84e Mon Sep 17 00:00:00 2001 From: "james.adams" Date: Thu, 29 Jun 2023 15:39:11 -0400 Subject: [PATCH] [522] added a quick start section to the documentation --- docs/index.rst | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 7db0025e..afabcc13 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -68,17 +68,32 @@ with the following goals in mind: best practices -Getting started +Quick Start --------------- + :: -Installation from PyPI + # create and activate a Python virtual environment with conda + conda create -n myvenv poetry pytest + conda activate myvenv + + # install the package + python -m poetry install + + # optionally run the unit tests suite + export NUMBA_DISABLE_JIT=1 + python -m poetry run pytest + + +Installation +------------- +From PyPI ^^^^^^^^^^^^^^^^^^^^^^^ Install directly from PyPI:: python -m pip install climate-indices -Installation from source +From source ^^^^^^^^^^^^^^ In order to build and install the package from source we need to first install `poetry `__::