Install¶
This section covers the basics of how to download and install DQuality.
Contents:
Pre-requisites¶
Each of the verifier requires a parameter configuration file. The configuration files must define schemas and verifier’s properties and be located in the user account home directory under a .dquality/default folder.
The schemas should be saved under “default/schemas” folder and contain the following files:
~/.dquality/default/schemas/pvs.jsoncontaining the list of Process variable (PV) of your beamline PVs with their acceptable value range.~/.dquality/default/schemas/tags.jsoncontaining the list valid HDF file tags, attributes and array dimentions.~/.dquality/default/schemas/dependencies.jsoncontaining the list of valid relation among data sets in the same HDF file.~/.dquality/default/schemas/limits.jsoncontaining the threshold values for the quality check calculations.~/.dquality/default/schemas/data_tags.jsoncontaining the dictionary of hdf tags of data sets by data type.~/.dquality/default/schemas/quality_checks.jsoncontaining the dictionary of quality check calculations. The keys are the slice verification methods, values are lists of stat methods.
Different instruments generating data that require different sets of configuration files can be configured as ~/.dquality/instrument1, ~/.dquality/instrument2 etc. with the same schemas subfolder structure.
Installing from source¶
Clone the DQuality from GitHub repository:
git clone https://github.com/bfrosik/data-quality.git DQuality
then:
cd DQuality
python setup.py install
Installing from Conda/Binstar (coming soon)¶
First you must have Conda installed, then open a terminal or a command prompt window and run:
conda install -c ....
Updating the installation (coming soon)¶
Data Management is an active project, so we suggest you update your installation frequently. To update the installation run in your terminal:
conda update -c ....
For some more information about using Conda, please refer to the docs.