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 without heavy dependencies like MLflow 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)
  • data - Data operations (search, download, describe)
  • benchmarks - Benchmark operations (run, list, get)

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.50.0.tar.gz (181.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.50.0-py3-none-any.whl (216.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vcp_cli-0.50.0.tar.gz
  • Upload date:
  • Size: 181.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.50.0.tar.gz
Algorithm Hash digest
SHA256 219b1168d5931da602fe0e3cf37b69d54dfd53a96f10fb67aca6fb1084811998
MD5 d88d51c299c7f0361e12e0c7c588719f
BLAKE2b-256 753579f28c15209145aa16570270e307ed5e6ff2ff594262ace7b5a8aad263e4

See more details on using hashes here.

Provenance

The following attestation bundles were made for vcp_cli-0.50.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.50.0-py3-none-any.whl.

File metadata

  • Download URL: vcp_cli-0.50.0-py3-none-any.whl
  • Upload date:
  • Size: 216.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.50.0-py3-none-any.whl
Algorithm Hash digest
SHA256 54ae53ad039e1b2c06d574417fbb7b58d486b22a15d1a12d507ad68f917fbf80
MD5 5c2d2c443523e840f2c486681fb4b5dc
BLAKE2b-256 0677248ff55924c6f5bdbbfa4463713df1b0a248f8803ee0abfd1c8240f2327a

See more details on using hashes here.

Provenance

The following attestation bundles were made for vcp_cli-0.50.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