FLeCS

Flexible and Learnable Cell Simulator

Documentation

Please refer to the documentation.

Installation

Pip

You need to have Python 3.8 or newer installed on your system. If you don't have Python installed, we recommend installing Mambaforge.

There are several alternative options to install flecst:

1. Install the latest development version:

pip install git+https://github.com/bertinus/flecs.git@main

Conda

To install the conda environment, please run

conda env create -f environment.yml
conda activate flecs
pip install -e .

Information to edit the documentation

We use mkdocs. More information is available on how to get started and how to deploy the documentation.

The most important commands are:

• mkdocs serve: starts a local server to preview your documentation.
• mkdocs build
• mkdocs gh-deploy: builds the docs, then commits and pushes them to the gh-pages branch of the repository.

Release notes

See the changelog.

Contact

For questions and help requests, you can reach out in the scverse discourse. If you found a bug, please use the issue tracker.

Citation

t.b.a