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.2.tar.gz (49.8 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.2-py3-none-any.whl (53.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for imzml_writer-1.1.2.tar.gz
Algorithm Hash digest
SHA256 081ee1c303218efad1f90bd3ff06dc177a1865e8a540651361575447ee2ba83a
MD5 0f1d791aa2805dd88909654cccb71a8c
BLAKE2b-256 2ddf3bddb03d2d500fa18c8e96ed6dca2567b193879a8e7ca285a4992a2fc539

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for imzml_writer-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d9e8af9959d84eeceb9c779b04fbc22fa69334ccdc18e546e0f710d6c1978db6
MD5 8782ad8413557c36d0c099813d88b2bf
BLAKE2b-256 07e90a673023bc17c899f3c9367f2de7262fba0ecba1fcfb99866a3488f12f9a

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