Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
SaQC
Manage
Activity
Members
Labels
Plan
Issues
36
Issue boards
Milestones
Wiki
Code
Merge requests
8
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
rdm-software
SaQC
Commits
2300da8f
Commit
2300da8f
authored
3 years ago
by
David Schäfer
Browse files
Options
Downloads
Patches
Plain Diff
installation guide update
parent
afecd7fa
No related branches found
Branches containing commit
No related tags found
Tags containing commit
7 merge requests
!685
Release 2.4
,
!684
Release 2.4
,
!567
Release 2.2.1
,
!566
Release 2.2
,
!501
Release 2.1
,
!372
fix doctest snippets
,
!369
Current documentation
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
sphinx-doc/getting_started/InstallationGuide.rst
+32
-19
32 additions, 19 deletions
sphinx-doc/getting_started/InstallationGuide.rst
with
32 additions
and
19 deletions
sphinx-doc/getting_started/InstallationGuide.rst
+
32
−
19
View file @
2300da8f
...
...
@@ -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"
python
3
-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
"
c
d env_saqc/Scripts
#
create virtual environment called "saqc-env
"
c
onda 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
p
ython3 -m pip install saqc
p
ip 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
...
...
This diff is collapsed.
Click to expand it.
David Schäfer
@schaefed
mentioned in commit
63b55c6d
·
2 years ago
mentioned in commit
63b55c6d
mentioned in commit 63b55c6d7dadb0e612b23a897f292d5ffc14cb52
Toggle commit list
David Schäfer
@schaefed
mentioned in commit
684dc8a0
·
2 years ago
mentioned in commit
684dc8a0
mentioned in commit 684dc8a0515470d644fc85fee95d07661c8dd572
Toggle commit list
David Schäfer
@schaefed
mentioned in commit
8f7a90e4
·
1 year ago
mentioned in commit
8f7a90e4
mentioned in commit 8f7a90e4aed61c79a9dc8d67541a46beba0907e8
Toggle commit list
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment