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.2.0.tar.gz (51.4 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.2.0-py3-none-any.whl (55.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for imzml_writer-1.2.0.tar.gz
Algorithm Hash digest
SHA256 aae075ad390276a1466342dd20de893a0eb3aa2fb8553dc619107494d51867f6
MD5 4462fa13fa87a4d5febf8e086d4fac78
BLAKE2b-256 bff9cfe4e4bbb7fa02c6871ac7cefed25bc6248f2696a77401613e32c4ba1167

See more details on using hashes here.

File details

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

File metadata

  • Download URL: imzml_writer-1.2.0-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.1.0

File hashes

Hashes for imzml_writer-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 92334d8f2488a957c9114f76bb3c7f886282a893eaf9340fa0f9ce96a954785e
MD5 087be91a27ee3bde2fc3f334129d91fd
BLAKE2b-256 ec01b2eca3ca1dbc27a693c1a352618bac8511b4c76ef9c28aad570392ef74ce

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