Module qc data tools
Project description
module QC data tools v1.0.3
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.3
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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 55ece9a661f7e2fdbe5e2af1112f5acc4fb8c7173f0ff22dc699847f0707c028 |
|
MD5 | ea311540019c308b9db7b88ea3b6d42d |
|
BLAKE2b-256 | 7f868bf06a5281755b0e84a15096a00d9dd792115166d6312aceef7bee65321a |
Hashes for module_qc_data_tools-1.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 34d3e486131f47f261ccf6b3eb8637c36e7a84b85d2ccc4725aa57489267fa27 |
|
MD5 | 2434327aed3351308ccc2edc6bb6d0ba |
|
BLAKE2b-256 | 9b23e9a682ba25447c032e7e5b719549dc4fd131536d127ae24e56e991c4e41c |