Skip to content
Virtual Cell Framework
Java Perl HTML Python Shell Groovy Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.travis
bionetgen
docker
exampleModels
localsolvers
nativelibs
ojdbc6
pythonScripts
thriftBuild
ucp
vcell-admin
vcell-api
vcell-apiclient
vcell-client
vcell-core
vcell-imagej-helper
vcell-imagej
vcell-math
vcell-opt
vcell-oracle
vcell-sbmlsim-api
vcell-sbmlsim
vcell-server
vcell-util
vcell-vmicro
.dockerignore
.gitignore
.mailmap
.travis.yml
Dockerfile-api_NOT_USED
Dockerfile-batch_NOT_USED
Dockerfile-clientgen_NOT_USED
Dockerfile-master_NOTUSED
README.md
README_Debugging.md
README_certs.md
README_flow_control.md
README_git_trav_appv_dhub.md
README_orphan.md
license.txt
pom.xml
vcell.sh

README.md

VCell - a modeling and simulation framework for computational cell biology

The vcell documentation in Markdown format (*.md) is edited in eclipse using the WikiText plugin

Join the chat at https://gitter.im/virtualcell/vcell

The VCell is a comprehensive framework for modeling and simulation of cell biology from biological pathways down to cell biophysics. VCell supports biochemical network and rule-based modeling and electrophysiology in compartmental modeing and within cellular geometry.

Simulation capabilities include ODEs, Reaction-Diffusion equations within cellular geometry, Gillespie and Hybrid stochastic solvers, Particle based spatial simulations, network free simulations and cell kinetimatics (moving boundary problems).

The VCell software consists of:

  1. a standalone modeling and simulation tool (vcell-client)
  2. a shared server providing a centralized model database, cluster computing and shared storage (vcell-server, vcell-api)
  3. simulation solvers written in C++/Fortran/Python and developed as part of the project as well as third party solvers and analysis.

Download VCell

http://vcell.org which hosts a free VCell Server for cluster computing and shared database.
Prebuilt installers for vcell-client are available for Windows, Mac and Linux.
http://vcell.org/webstart Location of VCell clients web page links to
-----Public installers path naming scheme= {Alpha,Beta,Rel,Test,...}/VCell_{Alpha,Beta,Rel}_{macos,unix,windows-x64,windows}latest{64,32}bit.{dmg,sh.exe}
-----Install4J updates.xml (read remotely by VCell client when starting to determine if a newer version of VCell has been deployed)
-----BioFormats jar (used by running VCell clients when importing image data, can't be shiiped directly with VCell, license issue)

Building VCell

This VCell github project includes all Java/Python source code required to build both the VCell client and the VCell Server.
The simulation solver source code is available as a separate project (http://github.com/jcschaff/vcell-solvers).

Building and Running VCell Client as a standalone tool

Requirements: Git, Maven, and Java JDK 1.8 or later

# to build vcell client
git clone https://github.com/virtualcell/vcell
cd vcell
mvn clean install dependency:copy-dependencies
# to run vcell client quickly
./vcell.sh

Building and Running VCell Client/Server

service has 1 image and configuration, manages 1 or more containers, container is a running image
All services defined in ./swarm/docker-compose.yml (collection of services,volumes, dependencies,...)

VCell Server Installation General Requirements

  • Linux
  • Git, Maven, and Java JDK 1.8 or later to build vcell-client and vcell-server
  • Docker (swarm mode)
  • Singularity (Linux) or Singularity in a Virtual Machine (Macos needs VirtualBox and Vagrant)
  • PostgreSQL or Oracle database
  • SLURM service for batch scheduling
  • Obtain an Install4J license if creating client installers

0a) Creating certs details
--(TLS/SSL website for (vcellapi.cam.uchc.edu,vcell-api.cam.uchc.edu)
--Microsoft authenticode codesigning (to prevent install4j from being rejected on windows clients)
--Apple codesigning for macos (prevents from mac refusing install4j install))
0b) Understanding VCell services detailed instructions

  1. NEW VCell Server Node configuration detailed instructions
    -----1a) Create new Docker swarm with node or Add node to existing Docker swarm detailed instructions
    -----1b) Finish NEW VCell Server Node configuration detailed instructions
  2. Building VCell Client/Server Software detailed instructions
    2a) Github/Travis/Appveyor/Dockerhub Details detials
  3. Deploying VCell Client/Server software detailed instructions
    3a) VCell System Flow-Control details
  4. Server Administration detailed instructions (.e.g restarting VCell services)
  5. Debugging detailed instructions (.e.g debug vcell client/server)

serverconfig.sh file must be customized for your configuration (see vcell/docker/swarm/serverconfig-uch.sh).

License

Virtual Cell software is licensed under the MIT open source license.

You can’t perform that action at this time.