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
5b790950
Commit
5b790950
authored
3 years ago
by
David Schäfer
Browse files
Options
Downloads
Patches
Plain Diff
work on
parent
ac76bb79
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
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
sphinx-doc/getting_started/InstallationGuide.rst
+6
-12
6 additions, 12 deletions
sphinx-doc/getting_started/InstallationGuide.rst
sphinx-doc/index.rst
+14
-3
14 additions, 3 deletions
sphinx-doc/index.rst
sphinx-doc/misc/title.rst
+3
-5
3 additions, 5 deletions
sphinx-doc/misc/title.rst
with
23 additions
and
20 deletions
sphinx-doc/getting_started/InstallationGuide.rst
+
6
−
12
View file @
5b790950
...
...
@@ -5,20 +5,14 @@ SaQC is written in Python, so the easiest way to set up your system to use SaQC
for your needs is using the Python Package Index (PyPI). It might be a good idea
to install SaQC into its own virtual environment.
Contents
--------
#. :ref:`Set up a virtual environment <getting_started/InstallationGuide:1. system requirements>`
#. :ref:`Set up a virtual environment <getting_started/InstallationGuide:2. set up a virtual environment>`
#. :ref:`Get SaQC <getting_started/InstallationGuide:3. get saqc>`
1.
System Requirements
-------------------
---
System Requirements
-------------------
SaQC is tested to run with Python version from 3.7 to 3.9 on 64-bit operating systems (Linux and Windows).
2.
Set up a virtual environment
-----------------------------
---
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.
...
...
@@ -50,8 +44,8 @@ On Windows-systems
./activate
3.
Get SaQC
--------
---
Get 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>`_.
...
...
This diff is collapsed.
Click to expand it.
sphinx-doc/index.rst
+
14
−
3
View file @
5b790950
...
...
@@ -10,15 +10,26 @@
Package API <moduleAPIs/saqcInit>
Tutorials and Topics
====================
Getting Started
===============
.. toctree::
:caption: Getting started
:maxdepth: 1
:hidden:
getting_started/InstallationGuide
getting_started/TutorialAPI
getting_started/GettingStarted
Cookbooks
=========
.. toctree::
:caption: Cookbooks
:maxdepth: 1
:hidden:
cook_books/DataRegularisation
cook_books/OutlierDetection
cook_books/MultivariateFlagging
...
...
This diff is collapsed.
Click to expand it.
sphinx-doc/misc/title.rst
+
3
−
5
View file @
5b790950
...
...
@@ -77,8 +77,8 @@ Features
.. list-table::
* - |pyLogo| |csvConfig|
- *
get SaQC from PyPI
* use SaQC as a commandline application and configure your
flagging
pipelines via plain
.csv files
- *
:ref:`get and install SaQC <getting_started/InstallationGuide:installation guide>`
* use SaQC as a commandline application and configure your pipelines via plain
text
* or use the SaQC python API, enabling integration in your python processing script
* - |sacRaw|
- * easily load data from multiple sources, concatenating them in a SaQC object
...
...
@@ -90,10 +90,8 @@ Features
- * automatically keep track of flagging history and flags significance for every datapoint
* define and use custom schemes to translate your flags to and from SaQC
* - |sacProc|
- * modifyyour data
,
by interpolations, corrections and transformations
- * modify
your data by interpolations, corrections and transformations
* calculate data products, such as residues or outlier scores
* automatically keep track of labeling history and label significance
* - |sacMV|
- * apply multivariate flagging function
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