Skip to main content

VCP CLI - A command-line interface (CLI) to the Chan Zuckerberg Initiative's Virtual Cell Platform (VCP)

Project description

Virtual Cells Platform Command Line Interface

Build Status License

A command-line interface for interacting with the Virtual Cells Platform ("VCP").

Requirements

  • Python 3.10+
  • On MacOS or Windows WSL, you will need a terminal app.
  • For the benchmarks commands, you will need to be running on an Intel/AMD64 architecture CPU with NVIDIA GPU, running Linux with NVIDIA drivers.
  • For other commands (e.g. data) you will need a Virtual Cells Platform account (register here)

Installation

Core Installation (Minimal)

Install only the core CLI functionality (auth, config, version commands):

pip install vcp-cli

This installs a minimal footprint (<50MB) without heavy dependencies like MLflow, boto3, or benchmarking tools.

Full Installation

Install all features (model, data, and benchmarks commands):

pip install vcp-cli[all]

Selective Installation

Install only the features you need:

# For model operations only
pip install vcp-cli[model]

# For data operations only
pip install vcp-cli[data]

# For benchmarks only
pip install vcp-cli[benchmarks]

# Combine multiple features
pip install vcp-cli[model,data]

Optional Feature Groups:

  • model - Model operations (init, stage, submit) - requires MLflow, numpy, copier, GitPython
  • data - Data operations (search, download, describe) - requires boto3 for S3 downloads
  • benchmarks - Benchmark operations (run, list, get) - requires cz-benchmarks, anndata

Documentation

Available at https://chanzuckerberg.github.io/vcp-cli/

License

This package is licensed under the MIT License.

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

vcp_cli-0.48.0.tar.gz (174.1 kB view details)

Uploaded Source

Built Distribution

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

vcp_cli-0.48.0-py3-none-any.whl (208.1 kB view details)

Uploaded Python 3

File details

Details for the file vcp_cli-0.48.0.tar.gz.

File metadata

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

File hashes

Hashes for vcp_cli-0.48.0.tar.gz
Algorithm Hash digest
SHA256 d9db3592f761b3502b41c356aa2725dcd98cee5ca43048dad71376b0cb286a1a
MD5 724e6dfe7f8eb3fd6996db60ff1718d4
BLAKE2b-256 d4308e2637c56eee178e484c34bf54f1e34f868ef3cd054a468b345c815b23ea

See more details on using hashes here.

Provenance

The following attestation bundles were made for vcp_cli-0.48.0.tar.gz:

Publisher: publish-pypi.yml on chanzuckerberg/vcp-cli

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

File details

Details for the file vcp_cli-0.48.0-py3-none-any.whl.

File metadata

  • Download URL: vcp_cli-0.48.0-py3-none-any.whl
  • Upload date:
  • Size: 208.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for vcp_cli-0.48.0-py3-none-any.whl
Algorithm Hash digest
SHA256 488f694da9514cf5be3f5b2fc52b94b0e917fce3c2e1f51dc05d6f4ebec9e877
MD5 033b105393f6a504746a0688e30c2171
BLAKE2b-256 dde3e65325ea7d09a4fafc8120ea23cbf5340fd70787f69e899c3feca138a9ca

See more details on using hashes here.

Provenance

The following attestation bundles were made for vcp_cli-0.48.0-py3-none-any.whl:

Publisher: publish-pypi.yml on chanzuckerberg/vcp-cli

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