From dbd11182f5928ad67cae78669c4a725457ec0dc9 Mon Sep 17 00:00:00 2001 From: "spaceBearAmadeus (Alex)" Date: Tue, 3 Sep 2024 09:31:18 -0400 Subject: [PATCH] update readme for cleanup --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 52d918f..db57df5 100644 --- a/README.md +++ b/README.md @@ -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.__ @@ -17,9 +17,6 @@ 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 @@ -27,3 +24,8 @@ 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) \ No newline at end of file