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

Uploaded Python 3

File details

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

File metadata

  • Download URL: imzml_writer-1.1.6.tar.gz
  • Upload date:
  • Size: 50.9 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.6.tar.gz
Algorithm Hash digest
SHA256 7a02e3f5d7aa32d5ae91f48016f0a811a7adaf530947d3ee7d3d0db55a959491
MD5 7bf44b356a09b196ce705beae7437b64
BLAKE2b-256 6a2e3d376b08d39adc3f54b995e92c812cefcff6207110bef4ca0b38d38b2b5d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: imzml_writer-1.1.6-py3-none-any.whl
  • Upload date:
  • Size: 54.9 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 b2d39f514bcaf2a6329eb12f7230b6cc18013be43a5bb1f4161978fba145bd70
MD5 ee63b8ffd12ad51b5a8e5c7ffac7a942
BLAKE2b-256 65a66982a5ce8142ce4351012241c423abeda80ef0520a7556efe90a859a2d44

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