From 1c7273e578b974d358a6e838b3d1ab724956fee1 Mon Sep 17 00:00:00 2001 From: Kingsley Collie Date: Wed, 6 Apr 2022 15:05:58 +0100 Subject: [PATCH 1/5] Add installation instructions. --- doc/installation.rst | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/doc/installation.rst b/doc/installation.rst index e2c87c14..4c903dd6 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -1,2 +1,21 @@ -Installing +Installation ========== + +InDicA requires python version 3.8 or above. If this is not the default in your +environment and you cannot install version 3.8 system-wide, consider using +`pyenv `_, available via the +`installer `_, to manage your python +versions. + +InDicA can be installed in a virtual environment: + +.. code-block:: bash + + mkdir analysis + cd analysis + python -m venv .venv + source .venv/bin/activate + pip install git+https://github.com/ukaea/Indica + +You should then be able to `import indica` in your python scripts, Jupyter +notebooks and python interpreters after having sourced the virtual environment. From 6c7a44244b144e03e1e17785055b8c47fdd4deb8 Mon Sep 17 00:00:00 2001 From: Kingsley Collie Date: Wed, 6 Apr 2022 15:33:09 +0100 Subject: [PATCH 2/5] Code role instead of default. --- doc/installation.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/installation.rst b/doc/installation.rst index 4c903dd6..535dd562 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -17,5 +17,6 @@ InDicA can be installed in a virtual environment: source .venv/bin/activate pip install git+https://github.com/ukaea/Indica -You should then be able to `import indica` in your python scripts, Jupyter -notebooks and python interpreters after having sourced the virtual environment. +You should then be able to :code:`import indica` in your python scripts, +Jupyter notebooks and python interpreters after having sourced the virtual +environment. From bd4545a57f19ebdd8ca22f2d169d99aecc6c59c7 Mon Sep 17 00:00:00 2001 From: Kingsley Collie Date: Thu, 7 Apr 2022 11:24:17 +0100 Subject: [PATCH 3/5] Fix underline length. --- doc/installation.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/installation.rst b/doc/installation.rst index 535dd562..63f61593 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -1,5 +1,5 @@ Installation -========== +============ InDicA requires python version 3.8 or above. If this is not the default in your environment and you cannot install version 3.8 system-wide, consider using From bdf87ce9debddf55571067f9285b57b1d2b40c4a Mon Sep 17 00:00:00 2001 From: Kingsley Collie Date: Thu, 5 May 2022 15:19:36 +0100 Subject: [PATCH 4/5] Use poetry for install for reproducible environment. --- doc/installation.rst | 14 +++++++------- pyproject.toml | 2 +- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/installation.rst b/doc/installation.rst index 63f61593..f31eb1dc 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -1,21 +1,21 @@ Installation ============ -InDicA requires python version 3.8 or above. If this is not the default in your -environment and you cannot install version 3.8 system-wide, consider using -`pyenv `_, available via the -`installer `_, to manage your python -versions. +InDicA requires python version 3.8 or 3.9. If this is not the default in your +environment and you cannot install either version system-wide, consider using +`pyenv `_, available via the `installer +`_, to manage your python versions. InDicA can be installed in a virtual environment: .. code-block:: bash - mkdir analysis + git clone --depth=1 https://github.com/ukaea/Indica.git analysis cd analysis python -m venv .venv source .venv/bin/activate - pip install git+https://github.com/ukaea/Indica + pip install poetry + poetry install --no-dev You should then be able to :code:`import indica` in your python scripts, Jupyter notebooks and python interpreters after having sourced the virtual diff --git a/pyproject.toml b/pyproject.toml index 069454ab..52ac26fa 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -40,7 +40,7 @@ readme = 'README.md' # Markdown files are supported include = [".git", "indica/git_version"] [tool.poetry.dependencies] -python = "^3.8" +python = ">=3.8,<3.10" prov = "^1.5.3" netCDF4 = "^1.5.4" numpy = "^1.21.0" From 4c6087161903ddbc7d14545062da7f71367f5d5d Mon Sep 17 00:00:00 2001 From: Kingsley Collie Date: Tue, 28 Jun 2022 17:58:46 +0100 Subject: [PATCH 5/5] Revert python version restriction --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 52ac26fa..069454ab 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -40,7 +40,7 @@ readme = 'README.md' # Markdown files are supported include = [".git", "indica/git_version"] [tool.poetry.dependencies] -python = ">=3.8,<3.10" +python = "^3.8" prov = "^1.5.3" netCDF4 = "^1.5.4" numpy = "^1.21.0"