Module qc data tools
Project description
module QC data tools v1.0.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==1.0.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 hatchorpython -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 installto 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.
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
File details
Details for the file module_qc_data_tools-1.0.0.tar.gz.
File metadata
- Download URL: module_qc_data_tools-1.0.0.tar.gz
- Upload date:
- Size: 10.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.7.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e5387e80f132528094070e3773db4b61e16f077ec4773f196303c5a573a53d16 |
|
| MD5 | abb9047ca1d07bfa210768184c0368a0 |
|
| BLAKE2b-256 | a8d33823040898e1dd413f1b5cf9166fbc6d11dd15df5c2490e44be83fd5d034 |
File details
Details for the file module_qc_data_tools-1.0.0-py3-none-any.whl.
File metadata
- Download URL: module_qc_data_tools-1.0.0-py3-none-any.whl
- Upload date:
- Size: 8.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.7.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d8a3d0fb2100562ef13a5edf63f2197e0565ce3fe990a189f7ee5dd5a28ff912 |
|
| MD5 | a8918eb18ad61adad05a0d774949d36c |
|
| BLAKE2b-256 | 39b5139f1e3f08073174cc28c8bb95186efbacd4ed4a2375b4df702db79cc650 |
