Module qc data tools
Project description
module QC data tools v1.0.2
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.2
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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 180dbc8134a01fa63699b774779e77831632e7bec39716c9e706f357724659f4 |
|
MD5 | f7eb44768a6a7f468d57b3a947742517 |
|
BLAKE2b-256 | c956e33aacd87ea29b08b9c2288572fd4b45e8c90da235c8d95d60e614440da2 |
Hashes for module_qc_data_tools-1.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5f779bc9b537061e8377bb7b00de772000e68f4c334ecf69686201aeb7cfbe56 |
|
MD5 | ce1496469d840454d2d18db73153122d |
|
BLAKE2b-256 | e69acbda6f182356487306e8536a566956ad1054bc219afdebbc04a73f0b753b |