Git Product home page Git Product logo

pymzml's Introduction

Introduction

Documentation Status

image

image

As long it is black

Research software impact

General information

Module to parse mzML data in Python based on cElementTree

Copyright 2010-2021 by:

M. Kösters,
J. Leufken,
T. Bald,
A. Niehues,
S. Schulze,
K. Sugimoto,
R.P. Zahedi,
M. Hippler,
S.A. Leidel,
C. Fufezan,

Contact information

Please refer to:

Dr. Christian Fufezan
Group Leader Experimental Bioinformatics
Cellzome GmbH
R&D Platform Technology & Science
GSK
Germany
eMail: [email protected]

https://fufezan.net

Summary

pymzML is an extension to Python that offers
    1. easy access to mass spectrometry (MS) data that allows the rapid development of tools
    1. a very fast parser for mzML data, the standard mass spectrometry data format
    1. a set of functions to compare and/or handle spectra
    1. random access in compressed files
    1. interactive data visualization

Implementation

pymzML requires Python3.7+. The module is freely available on pymzml.github.com or pypi, published under MIT license and only requires numpy and regex, however there are several optional dependencies for extended functionality like interactive plotting and deconvolution.

Download

Get the latest version via github
The complete Documentation can be found as pdf

Citation

M Kösters, J Leufken, S Schulze, K Sugimoto, J Klein, R P Zahedi, M Hippler, S A Leidel, C Fufezan; pymzML v2.0: introducing a highly compressed and seekable gzip format, Bioinformatics, doi: https://doi.org/10.1093/bioinformatics/bty046

Installation

pymzML requires Python 3.7 or higher.

Note

Consider to use a Python virtual environment for easy installation and use. Further, usage of python3.7+ is recommended.

Download pymzML using GitHub or the zip file:

  • GitHub version: Start by cloning the GitHub repository:

    user@localhost:~$ git clone https://github.com/pymzML/pymzml.git
    user@localhost:~$ cd pymzml
    user@localhost:~$ pip install -r requirements.txt
    user@localhost:~$ python setup.py install
  • pypi version:

    user@localhost:~$ pip install pymzml # install standard version
    user@localhost:~$ pip install "pymzml[plot]" # with plotting support
    user@localhost:~$ pip install "pymzml[pynumpress]" # with pynumpress support
    user@localhost:~$ pip install "pymzml[deconvolution]" # with deconvolution support using ms_deisotope
    user@localhost:~$ pip install "pymzml[full]" # full featured

If you have troubles installing the dependencies, install numpy first separately, since pynumpress requires numpy to be installed.

If you use Windows 7 please use the 'SDK7.1 command prompt' for installation of pymzML to assure correct compiling of the C extensions.

Testing

To test the package and correct installation:

tox

Contributing

Please read the contribution guidelines before contributing here

Code of Conduct

Since pymzML is an open source project maintained by the community, we established a code of conduct in order to facilitate an inclusive environment for all users, contributors and project memebers. Before contributing to pymzML, please read the code of conduct here

pymzml's People

Contributors

mkoesters avatar fu avatar jb-ms avatar stschulze avatar renovate-bot avatar hroest avatar myw avatar bald avatar zhixuni avatar siggismara avatar capuanob avatar renovate[bot] avatar andy-d-palmer avatar plpla avatar biogeek avatar erwinvaneijk avatar rjmw avatar guoci avatar jb-wolf avatar tristan-ranff avatar niehues avatar mmendez12 avatar jessbade avatar caetera avatar luysimon avatar mwang87 avatar maikroeder avatar jhersack avatar chris7 avatar pyeguy avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.