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.52.0.tar.gz (194.0 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.52.0-py3-none-any.whl (231.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vcp_cli-0.52.0.tar.gz
  • Upload date:
  • Size: 194.0 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.52.0.tar.gz
Algorithm Hash digest
SHA256 1ba2847c371844f47dba20a08e5c391c4aa4f86437462ed8f3e7cb6f915bdf83
MD5 8a1d19b8cd8257f1a49d6ad2cff8ca3e
BLAKE2b-256 5912963c58d0f7a45ec97e51edcb0cb99557ba446bf13f9cedab89b18892281c

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: vcp_cli-0.52.0-py3-none-any.whl
  • Upload date:
  • Size: 231.9 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.52.0-py3-none-any.whl
Algorithm Hash digest
SHA256 520f9aab3bee2dfcb6741b6b3a4ffbb5f8056574f165d735d298f6e560a99e88
MD5 3e5b772b0ec538b555683d584ecc9545
BLAKE2b-256 309c2ed8afa3bbf2bc01dded6da5f0a66cd25d1c995c6321ecc681d91440ce9b

See more details on using hashes here.

Provenance

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