Skip to main content

A command-line tool and library to process and analyze data generated from technologies from Pixelgen Technologies.

Project description

Pixelator

PyPI - Python Version MIT DOI conda pypi Docker Repository on Quay Tests

Documentation | Installation | Usage | Contributing | Contact | License | Credits

Pixelator is a software package to process sequencing FASTQ from Molecular Pixelation (MPX) and Proximity Network (PNA) assays and analyze PXL data.

It provides the pixelator commandline tool to process FASTQ files and generate PXL files and reports and can be used as a python library for further downstream processing.

Pixelgen Technologies

© 2023 - Pixelgen Technologies AB

Documentation

More information about pixelator is available on the Pixelgen Technologies Software documentation site.

Installation

Pixelgen Technologies has developed and tested pixelator extensively in Ubuntu 20.04.6 LTS. However, pixelator should run on computers installed with any recent version of the major Linux distributions.

Pixelator is available on PyPi as pixelgen-pixelator and can be installed with pip. It is recommended to install pixelator in a separate virtual environment.

pip install pixelgen-pixelator

Additional installation instructions

For runnning some of the MPX related pixelator commands you will need to have fastp installed on you system. For installation instructions, please visit the fastp GitHub repository.

Installation from source

You can also install pixelator from source by cloning the repository.

git clone https://github.com/pixelgentechnologies/pixelator.git
cd pixelator
pip install .

Using docker

The pixelator command-line tool can be run with docker images available on the GitHub container registry.

docker pull ghcr.io/pixelgentechnologies/pixelator:latest
docker run ghcr.io/pixelgentechnologies/pixelator:latest pixelator --help

You can also use the containers provided by the biocontainers project on quay.io.

Usage

Our recommendation is to use pixelator via the specific Nextflow pipeline, nf-core/pixelator.

It should take only a few seconds to download the pipeline and approx. 20 min to run the default test dataset in a normal commodity computer.

However, with MPX data, we recommend running pixelator in specialized hardware with at least 32GB RAM.

Contributing

Contribution are welcome! Please check out the contributing guidelines for more information.

Contact

For feature requests or bug reports, please use the GitHub issues. For questions, comments, or suggestions you can use the GitHub discussions.

You can also email the development team at developers@pixelgen.com.

License

Pixelator is licensed under the MIT license.

Credits

Pixelator is developed and maintained by the developers at Pixelgen Technologies.

When using pixelator in your research, please cite the following publication if you are working with Proximity Network Assay data:

Filip Karlsson, Michele Simonetti, Christina Galonska, Max Karlsson, Hanna van Ooijen, Tomasz Kallas, Divya Thiagarajan, et al.. "Single-Cell Protein Interactomes by the Proximity Network Assay". bioRxiv 2025.06.19.660329; doi: https://doi.org/10.1101/2025.06.19.660329

And for Molecular Pixelation data, please cite:

Karlsson, Filip, Tomasz Kallas, Divya Thiagarajan, Max Karlsson, Maud Schweitzer, Jose Fernandez Navarro, Louise Leijonancker, et al. "Molecular pixelation: spatial proteomics of single cells by sequencing." Nature Methods, May 8, 2024. https://doi.org/10.1038/s41592-024-02268-9.

Main development happened thanks to:

A huge thank you to all code contributors!

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

pixelgen_pixelator-0.24.0.tar.gz (3.8 MB view details)

Uploaded Source

Built Distribution

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

pixelgen_pixelator-0.24.0-py3-none-any.whl (4.0 MB view details)

Uploaded Python 3

File details

Details for the file pixelgen_pixelator-0.24.0.tar.gz.

File metadata

  • Download URL: pixelgen_pixelator-0.24.0.tar.gz
  • Upload date:
  • Size: 3.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pixelgen_pixelator-0.24.0.tar.gz
Algorithm Hash digest
SHA256 398000009050e7ce3ecdfac606a215a6a189a49c9ac222fa9df6706b01c2a873
MD5 4739df3aa7708b7dcf7794fedc143c28
BLAKE2b-256 50d226b7d6ba0bb7cfc586a3a8f0b939263bdeae8a1c378d784284bb8832e3e6

See more details on using hashes here.

Provenance

The following attestation bundles were made for pixelgen_pixelator-0.24.0.tar.gz:

Publisher: publish-pypi.yml on PixelgenTechnologies/pixelator

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pixelgen_pixelator-0.24.0-py3-none-any.whl.

File metadata

File hashes

Hashes for pixelgen_pixelator-0.24.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2156211b09a325eb9d1a81a7c854370c0dc4b5cba8274bc5ca8d93ad38ac6200
MD5 dc3d058b61b58932a39fb9208599d558
BLAKE2b-256 2ed58610566d15faba7c2678d9daa4a46a471bdd6fc0d19ca32888f48f29113d

See more details on using hashes here.

Provenance

The following attestation bundles were made for pixelgen_pixelator-0.24.0-py3-none-any.whl:

Publisher: publish-pypi.yml on PixelgenTechnologies/pixelator

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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