Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Install instructions #117

Draft
wants to merge 5 commits into
base: master
Choose a base branch
from
Draft

Install instructions #117

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1c7273e
Add installation instructions.
k-collie Apr 6, 2022
6c7a442
Code role instead of default.
k-collie Apr 6, 2022
bd4545a
Fix underline length.
k-collie Apr 7, 2022
bdf87ce
Use poetry for install for reproducible environment.
k-collie May 5, 2022
4c60871
Revert python version restriction
k-collie Jun 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 22 additions & 2 deletions doc/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,22 @@
Installing
==========
Installation
============

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 <https://github.com/pyenv/pyenv>`_, available via the `installer
<https://github.com/pyenv/pyenv-installer>`_, to manage your python versions.

InDicA can be installed in a virtual environment:

.. code-block:: bash

git clone --depth=1 https://github.com/ukaea/Indica.git analysis
cd analysis
python -m venv .venv
source .venv/bin/activate
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
environment.