Module qc data tools
Project description
module QC data tools v1.0.1
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.1
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-1.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9b653755a2ca07a1efb4ee94641e352dd1a69fbc3739c66289e5aab118f521f3 |
|
MD5 | 57974de7f928ea804f2d7beebdf8f8c0 |
|
BLAKE2b-256 | c3e1bc1a6c97f79356ef80493ac6988674a049a7741477d24c5598e7c26d7bd3 |
Hashes for module_qc_data_tools-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 66f110b9efb60f5c7748f8a092e8298164a7c80dc6b35c1be9f0a6c36184d5ae |
|
MD5 | 417017a42acecaae24eded83ef867927 |
|
BLAKE2b-256 | 7711a19a9904fa24b5ce4fad9406b2c53f58e102e15b5c69ed67dd2e286d02e1 |