Skip to content
Snippets Groups Projects
Commit 2300da8f authored by David Schäfer's avatar David Schäfer
Browse files

installation guide update

parent afecd7fa
No related branches found
No related tags found
7 merge requests!685Release 2.4,!684Release 2.4,!567Release 2.2.1,!566Release 2.2,!501Release 2.1,!372fix doctest snippets,!369Current documentation
......@@ -14,53 +14,66 @@ SaQC is tested to run with Python version from 3.7 to 3.9 on 64-bit operating sy
Set up a virtual environment
-----------------------------
The exact process depends on your operating system and python version/distribution.
The following sections should get you started on UNIX-like Systems and Windows.
It is good practice to create new virtual environments for different projects. This
helps keeping dependencies separated and avoids issues with conflicting versions of
a single module. The exact process to setup such an environment depends on your operating
system and python version/distribution. The following sections should get you started on
UNIX-like Systems and Windows.
On Unix/Mac-systems
"""""""""""""""""""
On Unix-like systems the process is usually rather easy. Open up a terminal window and
copy-paste the following commands
.. code-block:: sh
# create virtual environment called "env_saqc"
python3 -m venv env_saqc
# create virtual environment called "saqc-env"
python -m venv saqc-env
# activate the virtual environment
source env_saqc/bin/activate
source saqc-env/bin/activate
On Windows-systems
""""""""""""""""""
.. code-block:: sh
On windows, things are a bit more evolved however. The first hurdle to take is usually an
installation of Python itself. There are many options available, one popular solution is
the `Conda package management system <https://docs.conda.io/en/latest/>`_. After its
`installation <https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html>`_
type in the following:
# create virtual environment called "env_saqc"
py -3 -m venv env_saqc
.. code-block:: sh
# move to the Scripts directory in "env_saqc"
cd env_saqc/Scripts
# create virtual environment called "saqc-env"
conda create -n saqc-enc
# activate the virtual environment
./activate
conda activate saqc-env
# install pip, we will need it later
conda install pip
Get SaQC
--------
Install SaQC
------------
We currently distribute SaQC via the `Python Package Index (PyPI) <https://pypi.org/>`_
or through our `GitLab-repository <https://git.ufz.de/rdm-software/saqc>`_.
From PyPI
"""""""""
The latest stable versions are available with
.. code-block:: sh
python -m pip install saqc
The latest stable versions are available from PyPI:
or
.. code-block:: sh
python3 -m pip install saqc
pip install git+https://git.ufz.de/rdm-software/saqc@master
From the Gitlab repository
""""""""""""""""""""""""""
If you feel more adventurous feel free to use the latest development version from our
`GitLab-repository <https://git.ufz.de/rdm-software/saqc>`_. While we try to keep the
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment