Skip to main content

C-COMPASS (Cellular COMPartmentclASSifier) is an advanced open-source software tool designed for the quantitative analysis of fractionated proteomics samples.

Project description

C-COMPASS

PyPI Documentation DOI

C-COMPASS (Cellular COMPartmentclASSifier) is an open-source software tool designed to predict the spatial distribution of proteins across cellular compartments. It uses a neural network-based regression model to analyze multilocalization patterns and integrate protein abundance data while considering different biological conditions. C-COMPASS is designed to be accessible to users without extensive computational expertise, featuring an intuitive graphical user interface.

The data analyzed by C-COMPASS typically derives from proteomics fractionation samples that result in compartment-specific protein profiles. Our tool can be used to analyze datasets derived from various experimental techniques.

C-COMPASS Overview

Key Features

  • Protein Localization Prediction: Use a neural network to predict the spatial distribution of proteins within cellular compartments.
  • Dynamic Compartment Composition Analysis: Model changes in compartment composition based on protein abundance data under various conditions.
  • Comparison of Biological Conditions: Compare different biological conditions to identify and quantify relocalization of proteins and re-organization of cellular compartments.
  • Multi-Omics Support: Combine your proteomics experiment with different omics measurements such as lipidomics to bring your project to the spacial multi-omics level.
  • User-Friendly Interface: No coding skills required; the tool features a simple GUI for conducting analysis.

Documentation

Further documentation is available at https://c-compass.readthedocs.io/en/latest/.

Installation

Single-file executables

Single-file executables that don't require a Python installation are available on the release page for Linux, Windows, and macOS (>=Sequoia/15). Download the appropriate file for your operating system and run it.

On Windows, make sure to install the Microsoft C and C++ (MSVC) runtime libraries before (further information, direct download).

Unreleased versions can be downloaded from Build and Package. (Click on the latest run, then choose the version for your operating system from the "Artifacts" section. Requires a GitHub account.)

Via pip

# install
pip install ccompass

# launch the GUI
ccompass
# or alternatively: `python -m ccompass`

C-COMPASS currently requires Python>=3.11.

On Ubuntu linux, installing the python3-tk package is required:

sudo apt-get install python3-tk

To install the latest development version from GitHub, use:

pip install 'git+https://github.com/ICB-DCM/C-COMPASS.git@main#egg=ccompass'

Troubleshooting

If you encounter any issues during installation, please refer to the troubleshooting guide.

Usage

See also https://c-compass.readthedocs.io/en/latest/usage.html.

  • The GUI will guide you through the process of loading and analyzing your proteomics dataset, including fractionation samples and Total Proteome samples.
  • Follow the on-screen instructions to perform the analysis and configure settings only if required
  • Standard parameters should fit for the majority of experiments. You don't need to change the default settings.

Contributing

Contributions to C-COMPASS are welcome!

For further information, please refer to https://c-compass.readthedocs.io/en/latest/contributing.html.

Example Data

A simulated dataset and pre-defined sessions for testing purpose are available at https://zenodo.org/records/15223914.

A sample session based on a real and larger dataset is available at https://zenodo.org/records/18484676.

License

C-COMPASS is licensed under the BSD 3-Clause License.

Citation

If you use C-COMPASS in your research, please cite the following publication:

@Article{HaasWei2025,
  author           = {Haas, Daniel T. and Weindl, Daniel and Kakimoto, Pamela and Trautmann, Eva-Maria and Schessner, Julia P. and Mao, Xia and Gerl, Mathias J. and Gerwien, Maximilian and Müller, Timo D. and Klose, Christian and Cheng, Xiping and Hasenauer, Jan and Krahmer, Natalie},
  journal          = {Nature Methods},
  title            = {{C-COMPASS}: a user-friendly neural network tool profiles cell compartments at protein and lipid levels},
  year             = {2025},
  issn             = {1548-7105},
  month            = dec,
  doi              = {10.1038/s41592-025-02880-3},
  publisher        = {Springer Science and Business Media LLC},
}

Contact

For any questions, contact daniel.haas@helmholtz-munich.de or post an issue at https://github.com/ICB-DCM/C-COMPASS/issues/.

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

ccompass-2.0.1.tar.gz (317.5 kB view details)

Uploaded Source

File details

Details for the file ccompass-2.0.1.tar.gz.

File metadata

  • Download URL: ccompass-2.0.1.tar.gz
  • Upload date:
  • Size: 317.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ccompass-2.0.1.tar.gz
Algorithm Hash digest
SHA256 3b031773440bc4bb91b19a053b91511b41aa2c2fa3792b65d3855ea5fa79ee26
MD5 f7a68f92897d6dad146022f364dbff0c
BLAKE2b-256 4be44a2cdd0a5e5e1d02f6f31550b019cd128292a111855cddceef95aa8feaf7

See more details on using hashes here.

Provenance

The following attestation bundles were made for ccompass-2.0.1.tar.gz:

Publisher: deploy_release.yml on ICB-DCM/C-COMPASS

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