Skip to main content

nmrml2isa - nmrML to ISA-Tab parsing tool

Project description

Version Py versions Git Build Status License RTD doc DOI



nmrml2isa is a Python3 program that can be used to generate an ISA-Tab structured investigation out of nmrML files, providing the backbone of a study that can then be edited with an ISA editing tool (see MetaboLights pre-packaged ISA Creator)


See the Installation page of the online documentation.


See the Usage page and the Examples page for more detailed descriptions of usage and examples.


The parser comes with a simple one-liner:

mzml2isa -i /path/to/nmrml_files/ -o /path/to/out_folder -s name_of_study


It possible to import nmrml2isa as a Python module:

from nmrml2isa import parsing

in_dir = "/path/to/nmrml_files/"
out_dir = "/path/to/out_folder/"
study_identifier_name = "name_of_study"

parsing.full_parse(in_dir, out_dir, study_identifier_name)

Meta extraction

If you just want to extract the meta information without writing them in ISA-Tab files, it is possible to do so either by running the nmrml2isa.nmrml module as main:

python -m nmrml2isa.nmrml /path/to/your/file.nmrML
# this will produce a JSON dict of all extracted metadata

Or within a python program with the nmrml submodule:

from nmrml2isa import nmrml

nmrml_path = "/path/to/file.nmrML"
nmrml_meta = nmrml.nmrMLmeta(nmrml_path)

# python dictionnary

# json dictionnary

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nmrml2isa-0.3.3.tar.gz (83.7 kB view hashes)

Uploaded Source

Built Distribution

nmrml2isa-0.3.3-py3-none-any.whl (87.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page