Module qc data tools
Project description
module QC data tools v0.2.0
This project contains the modules needed to write/read the data files used in the module QC flow. This project is to be added as a submodule in other projects.
Installation
Note that please use the latest python version. Python3.7 is the minimum requirement for developers.
via clone
First clone the project:
git clone https://gitlab.cern.ch/atlas-itk/pixel/module/module-qc-data-tools.git
Upon a successful checkout, cd
to the new module-qc-data-tools
directory and
run the following to install the necessary software:
$ python -m venv venv
$ source venv/bin/activate
$ python -m pip install --upgrade pip
$ python -m pip install -e .
via pip
python -m venv venv
source venv/bin/activate
python -m pip install -U pip module-qc-data-tools==0.2.0
Developer
versioning
In case you need to tag the version of the code, you need to have either hatch
or pipx
installed.
- Activate python environment, e.g.
source venv/bin/activate
. - Run
python -m pip install hatch
orpython -m pip install pipx
.
You can bump the version via:
pipx run hatch run tag x.y.z
# or
hatch run tag x.y.z
where x.y.z
is the new version to use. This should be run from the default
branch (main
/ master
) as this will create a commit and tag, and push for
you. So make sure you have the ability to push directly to the default branch.
pre-commit
Install pre-commit to avoid CI failure. Once pre-commit is installed, a git hook script will be run to identify simple issues before submission to code review.
Instruction for installing pre-commit in a python environment:
- Activate python environment, e.g.
source venv/bin/activate
. - Run
python -m pip install pre-commit
. - Run
pre-commit install
to install the hooks in.pre-commit-config.yaml
.
After installing pre-commit, .pre-commit-config.yaml
will be run every time
git commit
is done. Redo git add
and git commit
, if the pre-commit script
changes any files.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for module_qc_data_tools-0.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e50e3fff2b45a6b25f143e6873e2e70bf36573037c6f293689e1c09e3aa195db |
|
MD5 | e97005aa21eaf568c32f629fe8150f3a |
|
BLAKE2b-256 | 5c69b493de17a5235870d53b82a7f9624d7c57020aa91048cd0442b06c3cd991 |
Hashes for module_qc_data_tools-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 54b2d1841cb1660b1945198c707b6d3ec792513c6c645f32d0459dd027888fdf |
|
MD5 | 639dffb4a9ff81eae78e2a74d6b1e4e3 |
|
BLAKE2b-256 | da409afbf86f835af5f56609fa6ee3810f3f22dd98024ad4e994bfe12e227db6 |