Skip to content

Commit

Permalink
update readme for cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexPatrie committed Sep 3, 2024
1 parent 078a912 commit dbd1118
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
![GitHub CI](https://github.com/biosimulators/bio-compose/actions/workflows/ci.yaml/badge.svg)
![GitHub CD](https://github.com/biosimulators/bio-compose/actions/workflows/cd.yaml/badge.svg)
[![Documentation](https://readthedocs.org/projects/biocompose/badge/?version=latest)](https://biocompose.readthedocs.io/en/latest)
[Convert Smoldyn outputs to Simularium](https://colab.research.google.com/drive/17uMMRq3L3KqRIXnezahM6TtOtJYK8Cu6#scrollTo=6n5Wf58hthFm)

# **BioCompose**: Create, execute, and introspect reproducible composite simulations of dynamic biological systems.
#### __This service utilizes separate containers for REST API management, job processing, and datastorage with MongoDB, ensuring scalable and robust performance.__

Expand All @@ -17,13 +17,15 @@ The complete `BioCompose` documentation can be found here: https://biocompose.re
The primary method of user-facing interaction for this service is done through the use of a high-level "notebook" api called `bio_check`.
A convenient notebook demonstrating the functionality of this service is hosted on Google Colab and can be accessed by clicking the above "Open In Colab" badge.

[View the template notebook as markdown](documentation/verification_api_demo.md)


Installation of this tooling can be performed using PyPI as such:

```bash
pip install bio-compose
```

#### Alternatively, **the REST API can be accessed via Swagger UI here: [https://biochecknet.biosimulations.org/docs](https://biochecknet.biosimulations.org/docs)**

## Smoldyn to Simularium conversion:

A convienient template notebook for converting the outputs of Smoldyn simulations to Simularium trajectories can be
[found here.](https://colab.research.google.com/drive/17uMMRq3L3KqRIXnezahM6TtOtJYK8Cu6#scrollTo=6n5Wf58hthFm)

0 comments on commit dbd1118

Please sign in to comment.