Skip to main content

"User friendly writing of imzML mass spectrometry imaging files from continuous MSI data"

Project description

Documentation Status

Installation:

Installing imzML Writer has gotten easier! We're now available as:

  1. (Recommended) As a python package available from pip:
pip install imzml-writer
  1. (Experimental) Standalone app bundles / executables for Mac and PC in the builds folder of the Github.

Installation:

Using imzML Writer depends on msconvert for conversion of raw vendor files to the open format mzML. On PC, this can be installed normally from Proteowizard: https://proteowizard.sourceforge.io/download.html

imzML Writer will prompt you for the path to msconvert the first time you try to convert raw files (see Docs), or you can add msconvert to the system path if you'd like to run msconvert from the command line.

On Mac, you can still run msconvert via a docker image. First, install Docker: https://www.docker.com/products/docker-desktop/

Similarly, imzML Writer will prompt you to download the docker image the first time you try to call it. If you'd like to do this in advance you can open Terminal.app and run the command:

docker pull chambm/pwiz-skyline-i-agree-to-the-vendor-licenses

Quickstart

Once the python package (pip install imzML-Writer) and msconvert (or the docker image) have been successful installed, you can quickly launch the GUI with the script:

import imzML_Writer.imzML_Writer as iw

iw.gui()

Compatibility

Software Functioning? Comments
Cardinal MSI Yes
METASPACE Yes
M2aia Yes
MSIReader Yes
Julia mzML_imzML Yes
SCiLS Lab Yes Pixel dimensions must be written as an integer to be read properly
Mozaic Yes

Documentation

Detailed installation instructions, quickstart guides, and documentation are available on the ReadTheDocs page: https://imzml-writer.readthedocs.io/en/latest/

Contact us

Please direct any questions, concerns, or feature requests to me at Joseph.Monaghan@viu.ca

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

imzml_writer-1.1.8.tar.gz (51.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

imzml_writer-1.1.8-py3-none-any.whl (55.5 kB view details)

Uploaded Python 3

File details

Details for the file imzml_writer-1.1.8.tar.gz.

File metadata

  • Download URL: imzml_writer-1.1.8.tar.gz
  • Upload date:
  • Size: 51.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.12.4 Darwin/25.0.0

File hashes

Hashes for imzml_writer-1.1.8.tar.gz
Algorithm Hash digest
SHA256 41e3648044fc997a826eb61ff03f3046eda5f1c841f23a3552e8c24d0dd2f76e
MD5 9c3ca72096015598bb90a1bc84ecd1b0
BLAKE2b-256 309425143e768a4b6293647ee1f4e4883e94014f45c1b6017c495cee119291e2

See more details on using hashes here.

File details

Details for the file imzml_writer-1.1.8-py3-none-any.whl.

File metadata

  • Download URL: imzml_writer-1.1.8-py3-none-any.whl
  • Upload date:
  • Size: 55.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.12.4 Darwin/25.0.0

File hashes

Hashes for imzml_writer-1.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 a9d572cb6fc5b47bfcff4912155c3439b8ad2d4d123ed1dfe154835a8d971304
MD5 85f07f3c0f2325d5f155e61b8d827cc6
BLAKE2b-256 407583cc43357264ec8de708ba5623c60d13563916a055ff5142cebda7ab2d7c

See more details on using hashes here.

Supported by

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