Skip to main content

Metabolomics Integrator (Mint)

Project description

Python package CII Best Practices Docker Image CI

MINT (Metabolomics Integrator)

The Metabolomics Integrator (MINT) is a post-processing tool for liquid chromatography-mass spectrometry (LCMS) based metabolomics. Metabolomics is the study of all metabolites (small chemical compounds) in a biological sample e.g. from bacteria or a human blood sample. The metabolites can be used to define biomarkers used in medicine to find treatments for diseases or for the development of diagnostic tests or for the identification of pathogens such as methicillin resistant Staphylococcus aureus (MRSA). More information on how to install and run the program can be found in the Documentation or check out the Tutorial to jump right into it.

Release notes

0.2.1

  • uses ms-mint 0.2.1 with new implementation of peak_area_top3
  • new quality control tab

0.1.9

MINT has been split into the Python library and the app. This repository contains the Python library. The underlying Python library ms-mint can be found here.

Screenshot

Screenshot

Quickstart

Try it

A demo server is available here. Be mindful, you share the server with others.

Installation

The recommended way of installing Mint is to use pip:

pip install ms-mint-app

Then you can start the application with:

Mint.py  # This starts the application

Once the server has started navigate to http://localhost:9999 with your browser (tested on Chrome).

There are more options available:

Mint.py --help
>>>
usage: Mint.py [-h] [--no-browser] [--version] [--data-dir DATA_DIR] [--debug] [--port PORT] [--host HOST]
               [--serve-path SERVE_PATH] [--ncpu NCPU]

MINT frontend.

options:
  -h, --help            show this help message and exit
  --no-browser          do not start the browser
  --version             print current version
  --data-dir DATA_DIR   target directory for MINT data
  --debug               start MINT server in debug mode
  --port PORT           Port to use
  --host HOST           Host binding address
  --ncpu NCPU           Number of CPUs to use  # Not yet implemented

Windows installer

The latest Windows installer is available here.

Contributions

All contributions, bug reports, code reviews, bug fixes, documentation improvements, enhancements, and ideas are welcome. Before you modify the code please reach out to us using the issues page.

Code standards

The project follows PEP8 standard and uses Black and Flake8 to ensure a consistent code format throughout the project.

Get in touch

Open an issue or join the slack channel.

Acknowledgements

This project would not be possible without the help of the open-source community. The tools and resources provided by GitHub, Docker-Hub, the Python Package Index, as well the answers from dedicated users on Stackoverflow and the Plotly community, as well as the free open-source packages used are the foundation of this project. Several people have made direct contributions to the codebase and we are extremely grateful for that.

  • @rokm refactored the specfile for Pyinstaller to create a windows package.
  • @bucknerns helped with the configuration of the versioneer file.

Last but not least, we want to thank all the users and early adopters that drive the development with feature requests and bug reports.

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

ms-mint-app-0.2.2.2.tar.gz (8.6 MB view details)

Uploaded Source

Built Distribution

ms_mint_app-0.2.2.2-py3-none-any.whl (8.6 MB view details)

Uploaded Python 3

File details

Details for the file ms-mint-app-0.2.2.2.tar.gz.

File metadata

  • Download URL: ms-mint-app-0.2.2.2.tar.gz
  • Upload date:
  • Size: 8.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for ms-mint-app-0.2.2.2.tar.gz
Algorithm Hash digest
SHA256 914e660b198980810765141067cd13f2786b24d36fc14c3e1d323662339717b1
MD5 0a562889c059742031a0813a486b6f8a
BLAKE2b-256 1d7978aee5b0a231015a8b07a66713551ccfa4f74e0e3e56637de3fec9485a61

See more details on using hashes here.

File details

Details for the file ms_mint_app-0.2.2.2-py3-none-any.whl.

File metadata

File hashes

Hashes for ms_mint_app-0.2.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9a93ba88613aed2f81cef2513ac5bdd4b77f44bac7e9a01f56d957e7d7171a15
MD5 2f02b98f1adfb82e084a57096294feba
BLAKE2b-256 9d0639a12b9c261e65a34c479d227d5b81d9e3d50a3422ad38331f9aea6a4e90

See more details on using hashes here.

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