pyvcell
This is the python wrapper for vcell modeling and simulation for
- local scripting of spatial modeling, simulation, data analysis and visualization workflows using Virtual Cell technology
- 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
Parameters example
Geometry import example
1 maintainer
Metadata
1 maintainer
Release files for pyvcell 0.4.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pyvcell-0.4.1.tar.gz | 195.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pyvcell-0.4.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 641.6 kB
Release files / pyvcell-0.4.1.tar.gz
| Download URL | pyvcell-0.4.1.tar.gz |
|---|---|
| Size | 195.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b76c835a817936292ed7cf82e0014afbed5291daffade13efcb05bf6ed9feb4f
|
|
BLAKE2b-256 checksum How to use checksums |
e0504a0f12b617f9f047937ff63e5e6d3d778c5da82ecb6d00d213b73e91d4f4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.19 {"installer":{"name":"uv","version":"0.12.19","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.4.1-py3-none-any.whl
| Download URL | pyvcell-0.4.1-py3-none-any.whl |
|---|---|
| Size | 446.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8fa46ae37871c135c3cf7c3f80d227c4d445f9272f03d5b456f6d6efd6bd971e
|
|
BLAKE2b-256 checksum How to use checksums |
f1d0d9c65fce06863ff8c1598efd9fea95425030c191bc27b1a919956cd17f07
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.19 {"installer":{"name":"uv","version":"0.12.19","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}
|
