Skip to main content

pyvcell

Release Build status codecov Commit activity License

This is the python wrapper for vcell modeling and simulation for

  1. local scripting of spatial modeling, simulation, data analysis and visualization workflows using Virtual Cell technology
  2. access to Virtual Cell remote APIs - with public access or as an authenticated Virtual Cell user.

Local simulation, analysis and visualization with pyvcell

download or create new spatial models

  • load/save VCML (Virtual Cell’s native format - import/export to VCell UI)
  • load/save SBML (Systems Biology Markup Language)
  • load from Antimony (friendly textual language for SBML)
  • create/edit any VCML object (e.g. species, model, geometry) programmatically

local editing with Python objects

  • edit parameters. add/remove/edit species, compartments, reactions, initial conditions, diffusion coefficients
  • create/edit geometry objects, create/edit vcell applications and simulations

run local simulations

  • run local spatial simulations (for reactions, diffusion, and advection) stored in local workspace.

analyze local simulation result:

  • Time-series summary statistics available as NumPy arrays.
  • spatiotemporal arrays stored as Zarr datastores and available as NumPy arrays.
  • 3D mesh data using VTK unstructured grids, analyzed with VTK

local visualization

  • built-in plotting and 3D visualization via Matplotlib and VTK/PyVista
  • make your own plots or 3D renderings.

installation

The easiest way to install pyvcell is by using the Python Package Index and pip. We highly recommend setting up a virtual environment for dependency management. Run the following command to install pyvcell from PyPI

pip install pyvcell

Usage

import pyvcell.vcml as vc
biomodel = vc.load_vcml_file('path/to/your/model.vcml')
results = vc.simulate(biomodel, "sim1")
results.plotter.plot_concentrations()

Documentation

Full documentation is available at https://virtualcell.github.io/pyvcell/

Examples:

Antimony example

Open in Colab

Parameters example

Open in Colab

Geometry import example

Open in Colab

Metadata

Release files for pyvcell 0.5.1

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

Source distribution (sdist)

Source distribution for pyvcell 0.5.1
File Size Uploaded Provenance
pyvcell-0.5.1.tar.gz 219.6 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for pyvcell 0.5.1
File Interpreter ABI Platform
pyvcell-0.5.1-py3-none-any.whl Python 3 none any Details

Total release size: 676.2 kB

Release files / pyvcell-0.5.1.tar.gz

Download URL pyvcell-0.5.1.tar.gz
Size 219.6 kB
Tags Source
SHA-256 checksum
How to use checksums
39b2a76c64f3e17f829279120bce1edd88705a10bd6fe4403f7c1d468b0c34c9
BLAKE2b-256 checksum
How to use checksums
1032cccf10b3fb77f64538be433fdc59ce5099be19ccf0f209278b80e5dc0c9a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / pyvcell-0.5.1-py3-none-any.whl

Download URL pyvcell-0.5.1-py3-none-any.whl
Size 456.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0c383dc6850136a17bd1bbab45990a369d4fcf0f88f784e77d703967668da0da
BLAKE2b-256 checksum
How to use checksums
dc311858ab6913f398e1d0ec9a4aa7ec4a0e00fade1f8f5ec5022d5e688aec97
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for pyvcell 0.5.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.5.1 This release

2 release files No provenance

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