https://github.com/virtualcell/libvcell

https://github.com/virtualcell/libvcell

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/virtualcell/libvcell
• Owner: virtualcell
• License: mit
• Created: 2025-03-09T14:14:56.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2026-02-27T21:06:52.000Z (4 months ago)
• Last Synced: 2026-02-28T01:39:06.504Z (4 months ago)
• Language: Java
• Size: 3.98 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# libvcell

[![Release](https://img.shields.io/github/v/release/virtualcell/libvcell)](https://img.shields.io/github/v/release/virtualcell/libvcell)

[![Build status](https://img.shields.io/github/actions/workflow/status/virtualcell/libvcell/main.yml?branch=main)](https://github.com/virtualcell/libvcell/actions/workflows/main.yml?query=branch%3Amain)

[![codecov](https://codecov.io/gh/virtualcell/libvcell/branch/main/graph/badge.svg)](https://codecov.io/gh/virtualcell/libvcell)

[![Commit activity](https://img.shields.io/github/commit-activity/m/virtualcell/libvcell)](https://img.shields.io/github/commit-activity/m/virtualcell/libvcell)

[![License](https://img.shields.io/github/license/virtualcell/libvcell)](https://img.shields.io/github/license/virtualcell/libvcell)

libvcell is a subset of VCell algorithms intended to support the [pyvcell](https://pypi.org/project/pyvcell/) python package.

- **Github repository**: 

- **Documentation** 

## Getting started with your project

First, create a repository on GitHub with the same name as this project, and then run the following commands:

```bash

git init -b main

git add .

git commit -m "init commit"

git remote add origin git@github.com:virtualcell/libvcell.git

git push -u origin main

```

Finally, install the environment and the pre-commit hooks with

```bash

make install

```

You are now ready to start development on your project!

The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.

To finalize the set-up for publishing to PyPI or Artifactory, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/publishing/#set-up-for-pypi).

For activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/mkdocs/#enabling-the-documentation-on-github).

To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/codecov/).

## Releasing a new version

- Create an API Token on [PyPI](https://pypi.org/).

- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/virtualcell/libvcell/settings/secrets/actions/new).

- Create a [new release](https://github.com/virtualcell/libvcell/releases/new) on Github.

- Create a new tag in the form `*.*.*`.

- For more details, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/cicd/#how-to-trigger-a-release).

---

Repository initiated with [fpgmaas/cookiecutter-poetry](https://github.com/fpgmaas/cookiecutter-poetry).