Module qc data tools
Project description
module QC data tools v1.0.5
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==1.0.5
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.
Release candidates can be bumped as e.g.:
hatch run tag x.y.zrc0
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-1.0.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 802efc4bfecb4c1f22943f0377070bc04eb3fb33306abb0b7f8870c9f1c3069e |
|
MD5 | 11bf6a0562029cee18ac666d5bd48d1d |
|
BLAKE2b-256 | d68fc87a562b74daf8b0e53b32986c32d459544d23691a11314d85f7f37da006 |
Hashes for module_qc_data_tools-1.0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 645e2b06e42581d47acb9a3d426786ddd0bcedf53c07881812fe4cd0870cb79f |
|
MD5 | a05e2cee6b68bd3d1747f97abadcd54c |
|
BLAKE2b-256 | 31d487b4b128d952bb7c7d827340fd377c7e88b771485911c18d3b327064c2d5 |