Python library for the PSI-mzQC quality control file format.
Project description
MZQC python library
A python library to create and use mzQC files. Specifically, the library facilitates access to mzQC files in form of a directly usable object representation of mzQC and offers additional functionality to:
- serialise
- deserialise
- check syntax
- check semantics
- file-info
- experimental file-merging
The library follows the formats versioning (which is 'v(Major).(Minor).(Patch)').
This library implements python modules for (de-)serialisation and validity checks of the PSI fileformat mzQC. Find the specification document, examples, and and further documentation there.
Install
Latest Release
Most people will want to install the latest release version of pymzqc. Please install pymzqc via pypi:
pip install pymzqc
From Git
If you want a development version, use:
pip install -U git+https://github.com/MS-Quality-hub/pymzqc.git#v1.0.0rc2
You can select a development branch of your choice by changing the command after the .git#
Containers
However, we recommend using the ready-built containers to check out the latest updates.
Online docs
To get a nice and simple overview of how pymzqc works, visit here. If you've successfully installed the library and want to jump right in and work on the library, we suggest a peek at the codestructure.
If you however just want to get your toes wet, or use it as-is, have a look at the interactive guides (below).
Interactive pymzqc
Have a go with our interactive python notebooks to explore what is possible.
Development
Contributions are welcome! (Just fork, develop, and open PR.)
Repository structure
The python package's code is located in the mzqc
folder, continuous testing code in tests
, the documentation in doc
. The libray-use container descriptions are in containers
, if you want a container for library-development, you can use the container description within .devcontainer
, more development presets can be found in .vscode
. The jupyter
and accessories
folders are subprojects making use of the library. See their README in the respective sub-folders.
Documentation
The code documentation style convention is of the type Sphinx/numpy
.
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
File details
Details for the file pymzqc-1.0.0rc2.tar.gz
.
File metadata
- Download URL: pymzqc-1.0.0rc2.tar.gz
- Upload date:
- Size: 28.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.10.12
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | dd4a2f3bc6dc5299a18b6a1906508d4e1cde24777cc44427d982a394dcf479bf |
|
MD5 | 38eb157a55371dc52bb165c1e8ead447 |
|
BLAKE2b-256 | cc4c02a50354bd479f583dea26d7b75a8a82950610394fb81e76ee96ec1c1a66 |
File details
Details for the file pymzqc-1.0.0rc2-py3-none-any.whl
.
File metadata
- Download URL: pymzqc-1.0.0rc2-py3-none-any.whl
- Upload date:
- Size: 23.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.10.12
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | cf93b59846ec1cee66ea5d238a172307b53623f71559a46ac807f44536107795 |
|
MD5 | f18650d28e423037f523445b1e1257da |
|
BLAKE2b-256 | 30c1960b79c569c5cc1506a8dd240edbbef977784328c60933e2aac10db1ce1a |