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.6.tar.gz (52.0 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.6-py3-none-any.whl (56.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: imzml_writer-1.2.6.tar.gz
  • Upload date:
  • Size: 52.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.0 CPython/3.12.10 Darwin/25.5.0

File hashes

Hashes for imzml_writer-1.2.6.tar.gz
Algorithm Hash digest
SHA256 e6b87433fd9a1d88336a64f8b0d8dce4f2bacbd3e0854bebabde8691aafe1707
MD5 bfa7b9eb24e314abac07c9465967d423
BLAKE2b-256 a979034447faf7941fd502689fdd616823d7ab889416368e30732185fce7f842

See more details on using hashes here.

File details

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

File metadata

  • Download URL: imzml_writer-1.2.6-py3-none-any.whl
  • Upload date:
  • Size: 56.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.0 CPython/3.12.10 Darwin/25.5.0

File hashes

Hashes for imzml_writer-1.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 87a0b44ca47f5e6078527ad80a0caeb8cbe91af72d323f7dd1820fb8478c931e
MD5 1e46696d66830030848fae6449ea6609
BLAKE2b-256 cd092fd6df11d434a147a4325ad407b0b6f8d86319693bfc092cb51933c3d508

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