From 2a3160ad2cc262d558f14a6614ce53003f46f742 Mon Sep 17 00:00:00 2001 From: jcschaff Date: Mon, 3 Jun 2024 10:15:37 -0400 Subject: [PATCH] updated README.md --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 49dfec8dd..337cf1b1b 100644 --- a/README.md +++ b/README.md @@ -14,4 +14,17 @@ Virtual Cell solvers [virtualcell/vcell-solvers](https://github.com/virtualcell/ ## The Virtual Cell Project The Virtual Cell is a modeling and simulation framework for computational biology. For details see http://vcell.org and http://github.com/virtualcell. -## Python Bindings (more to come) +## Docker container +the vcell-fvsolver is available as a docker container at ghcr.io/virtualcell/vcell-fvsolver. + +## Standalone executables +FiniteVolume executable can be build on Windows, MacOS, and Linux (see .github/workflows/cd.yml for details). The executables are available in the release section of this repository. + +## Python API - pyvcell_fvsolver +The Python API for the VCell Finite Volume solver is a low level wrapper which +accepts VCell solver input files (.fvinput, .vcg) +and generates the output files (.log, .zip, .mesh, .meshmetrics, .hdf5). The +.functions file is not used by the solver, but is helpful for interpreting the +results in the context of the original model. + +This package is intented to be used by the Virtual Cell Python API, pyvcell (coming soon).