Skip to main content

Cell Maps Pipeline Utilities

https://img.shields.io/pypi/v/cellmaps_utils.svg https://app.travis-ci.com/idekerlab/cellmaps_utils.svg?branch=main Documentation Status Code Coverage Zenodo DOI badge

Contains utilities needed by various tools in the cell maps toolkit.

Dependencies

Compatibility

  • Python 3.8+

Installation

git clone https://github.com/idekerlab/cellmaps_utils
cd cellmaps_utils
make dist
pip install dist/cellmaps_utils*whl

Run make command with no arguments to see other build/deploy options including creation of Docker image

make

Output:

clean                remove all build, test, coverage and Python artifacts
clean-build          remove build artifacts
clean-pyc            remove Python file artifacts
clean-test           remove test and coverage artifacts
lint                 check style with flake8
test                 run tests quickly with the default Python
test-all             run tests on every Python version with tox
coverage             check code coverage quickly with the default Python
docs                 generate Sphinx HTML documentation, including API docs
servedocs            compile the docs watching for changes
testrelease          package and upload a TEST release
release              package and upload a release
dist                 builds source and wheel package
install              install the package to the active Python's site-packages

Before running tests, please install pip install -r requirements_dev.txt

For developers

To deploy development versions of this package

Below are steps to make changes to this code base, deploy, and then run against those changes.

  1. Make changes

Modify code in this repo as desired

  1. Build and deploy

# From base directory of this repo cellmaps_hierarchyeval
pip uninstall cellmaps_utils -y ; make clean dist; pip install dist/cellmaps_utils*whl

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template

History

0.9.0 (2025-07-03)

  • Add statistics generator for ro-crates

  • Fix provenance bugs for new versions of ro-crate

0.8.0 (2025-04-23)

  • Set maximum supported version of scipy to <1.11

  • Added tworeplchallenge and solution_generator commands to cellmaps_utilscmd.py. These commands generate a Kaggle challenge and solution from a SEC-MS dataset

  • Updated to PEP 517 compliant build system

0.7.0 (2025-03-05)

  • Add compute_hierarchy_robustness method to HierarchyDiff class to assess the robustness of a hierarchy based on Jaccard similarity across multiple alternative hierarchies.

0.6.0 (2025-02-05)

  • Add HierarchyDiff class with compare_hierarchies method to compare two hierarchies in CX2 format, and output a hierarchy with robustness score of each system.

  • Add version bounds for required packages.

  • Add convert_hierarchical_network_to_hcx (utility function that aids convertion of a hierarchical network in CX2 to HCX) and add_hcx_members_annotation (adds ‘HCX::members’ attribute to nodes) to hcx_utils

  • Fixes in IF and APMS tools

0.5.0 (2024-09-05)

  • Add HiDeFToHierarchyConverter, a class to convert a edge list and node list in HiDeF format to hierarchy in HCX.

  • Add InteractomeToDDOTConverter and DDOTToInteractomeConverter, classes to convert network in CX2 format to DDOT format and vice versa, HierarchyToDDOTConverter and DDOTToHierarchyConverter, classes to convert hierarchy network in HCX format to DDOT and vice versa.

0.4.0 (2024-07-02)

  • Updated provenance utils, added checks in for missing data in input RO-Crate, and allowing to continue but logging errors in the process

  • Add HierarchyToHiDeFConverter, a class to convert a hierarchy network (in CX2 format) to a HiDeF format nodes and edges lists.

  • Add NDExHierarchyUploader, a class for uploading hierarchy and its parent network to NDEx.

  • Updated cellmaps_utilscmd.py apmsconverter, ifconverter, crisprconverter to support tissue as well as output data_info.json file to resulting RO-Crate so subsequent tools can more easily get provenance information

  • Updated cellmaps_utilscmd.py crisprconverter to consume .h5ad files and updated readme.txt file

0.3.0 (2024-04-15)

  • Bumped fairscape-cli dependency to 0.2.0

0.2.0 (2024-02-20)

  • Bumped fairscape-cli dependency to 0.1.14 to support schemas

  • Added support for schema to data_dict parameter in ProvenanceUtil.register_dataset()

  • Added --release flag to cellmaps_utilscmd.py rocratetable and in output table renamed “Name of Computation” to “Name” as well as added “Type”, “Cell Line”, “Treatment”, “Gene set”, and “Version” to table output

  • Set default logging level to ERROR for cellmaps_utilscmd.py command

0.1.0 (2024-01-01)

  • First release on PyPI.

Metadata

Release files for cellmaps-utils 0.9.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cellmaps-utils 0.9.0
File Size Uploaded
cellmaps_utils-0.9.0.tar.gz 580.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for cellmaps-utils 0.9.0
File Interpreter ABI Platform
cellmaps_utils-0.9.0-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 651.6 kB

Release files / cellmaps_utils-0.9.0.tar.gz

Download URL cellmaps_utils-0.9.0.tar.gz
Size 580.8 kB
Tags Source
SHA-256 checksum
How to use checksums
c4f62a18953a0a75d42dfa25e71aa2b9c5f035008b6a2945899a039d4f1e474d
BLAKE2b-256 checksum
How to use checksums
14659b09b3eb2513afa1f516e54e82e729fe14fc13544e8b3f8a16b3a87c56af
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.8.18

Release files / cellmaps_utils-0.9.0-py2.py3-none-any.whl

Download URL cellmaps_utils-0.9.0-py2.py3-none-any.whl
Size 70.9 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
1c72113744193de59cd523db927a9bde27dd4757adff149e64e41b5a41f952a3
BLAKE2b-256 checksum
How to use checksums
b2aa908e9dc8ab67085646e8847a2e0f1b0dc1ffdca118de973d8d94a576e665
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.8.18

Release history Release notifications | RSS feed

This release

0.9.0 This release

2 release files

0.8.0

2 release files

0.7.0

2 release files

0.6.0

2 release files

0.5.0

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page