Skip to main content

CNSistent Logo

PyPI version PyPI downloads Documentation Status Tests

CNSistent is a Python tool for processing and analyzing copy number data. It is designed to work with data from a variety of sources. The tool is designed to be easy to use, and to provide a comprehensive set of analyses and visualizations.

READ THE DOCS HERE

CNSistent can be used as a Python package, or downloaded together with the respective data (PCAWG, TRACERx, TCGA, genomic locations):

Installation

Option 1: Full package with the data

git clone git@github.com:ICCB-Cologne/CNSistent.git
cd CNSistent
pip install -e ".[plot]"
wget -O out.tar.gz https://zenodo.org/records/14547456/files/out.tar.gz 
mkdir -p out
tar -xzf out.tar.gz -C ./out 
rm out.tar.gz

Note: the input data are part of the repository. The processed data can be downloaded and decompressed directly as shown above. Alternative is to generate the by running the ./scripts/data_process.sh and ./scripts/data_aggregate.sh.

Option 2: PIP package only

pip install CNSistent

The plotting API (cns.fig_*, cns.plot_*) needs matplotlib, which is not installed by default, as none of the CLI commands require it. To use it, install the plot extra:

pip install "CNSistent[plot]"

Numba is installed by default and is used to compile the aggregation and clustering kernels. It is not strictly required, pip install --no-deps environments without it still work, at roughly half the aggregation speed.

Data

The input dataset is also availble on Zenodo: DOI

The processed data is available on Zenodo: DOI

Deep learning code is available on Zenodo: DOI

Acessions

The contents of the data folder were obtained by processing the following sources, accessed in December 2023.

TCGA data obtained from ASCATv3 at: https://github.com/VanLoo-lab/ascat/tree/master/ReleasedData
Cite: https://www.pnas.org/doi/full/10.1073/pnas.1009843107
The results published here are in part based upon data generated by the TCGA Research Network: https://www.cancer.gov/tcga.

PCAWG data obtained from: https://dcc.icgc.org/releases/PCAWG/consensus_cnv Cite: https://www.nature.com/articles/s41587-019-0055-9

TRACERx data obtained from: https://zenodo.org/records/7649257
Cite: https://www.nature.com/articles/s41586-023-05729-x

COSMIC cancer set obtained from: https://cancer.sanger.ac.uk/census
Cite: https://www.ncbi.nlm.nih.gov/pmc/articles/PMC6450507

Human genome gene set obtained using PyENSEMBL (2023). Cite: https://academic.oup.com/nar/article/51/D1/D933/6786199

Cytoband, Gap data obtained from: https://genome.ucsc.edu Cite: https://www.nature.com/articles/35057062

Common fragile sites obtained from the HumCFS database: https://webs.iiitd.edu.in/raghava/humcfs/ Cite: https://www.ncbi.nlm.nih.gov/pmc/articles/PMC6394038 The HumCFS GRCh38/hg38 sites are cleaned and lifted over to hg19 (UCSC chain) by scripts/build_fragile_sites.py; see cns/utils/fragile_sites.py for the processing details.

Licenses

Cite Adam Streck, Roland F Schwarz, CNSistent integration and feature extraction from somatic copy number profiles, GigaScience, Volume 14, 2025, giaf104. The code is available under the MIT License. The data and text files in the data and docs folders are available under the CC BY-NC 4.0 license.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cnsistent-1.1.1.tar.gz (80.8 kB view details)

Uploaded Source

Built Distribution

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

cnsistent-1.1.1-py3-none-any.whl (87.7 kB view details)

Uploaded Python 3

File details

Details for the file cnsistent-1.1.1.tar.gz.

File metadata

  • Download URL: cnsistent-1.1.1.tar.gz
  • Upload date:
  • Size: 80.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for cnsistent-1.1.1.tar.gz
Algorithm Hash digest
SHA256 dcc20a2da8ac1a3bece961a80d89bbcf47a5595996ca2106fbeaa091a264d39b
MD5 98998fc3b80e1669c27fec0bef09a154
BLAKE2b-256 88929d793bb26467e1dbf75b3a5ad447eeb35a4c80185b4b3a549a778a43ca97

See more details on using hashes here.

Provenance

The following attestation bundles were made for cnsistent-1.1.1.tar.gz:

Publisher: publish-pypi.yml on schwarzlab-ccb/CNSistent

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

File details

Details for the file cnsistent-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: cnsistent-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 87.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for cnsistent-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0847af353d9482d2ef6274ac926e7f9a5d2a9a63c829e61254c3a1a451b91da9
MD5 c680c5660f4d91bd91ffb5153cdae7d8
BLAKE2b-256 64b517f634d4dca101840ab8b0038d13e741c9d1141cfa2534087dcd2b386e07

See more details on using hashes here.

Provenance

The following attestation bundles were made for cnsistent-1.1.1-py3-none-any.whl:

Publisher: publish-pypi.yml on schwarzlab-ccb/CNSistent

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

Release history Release notifications | RSS feed

This release

1.1.1 This release

2 files

1.1.0

2 files

1.0.0

2 files

0.9.0

2 files

0.8.0

2 files

0.7.3

2 files

0.7.1

2 files

0.7.0

2 files

0.6.4

2 files

0.6.3

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page