Skip to content

Update SimulariumIO Readme #197

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ascibisz wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update SimulariumIO Readme #197

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
## Simularium repositories
This repository is part of the Simularium project ([simularium.allencell.org](https://simularium.allencell.org)), which includes repositories:
- [simulariumIO](https://github.com/simularium/simulariumio) - Python package that converts simulation outputs to the format consumed by the Simularium viewer website
- [simularium-engine](https://github.com/simularium/simularium-engine) - C++ backend application that interfaces with biological simulation engines and serves simulation data to the front end website
- [octopus](https://github.com/simularium/octopus) - Python application that serves simulation data to the front end website
- [simularium-viewer](https://github.com/simularium/simularium-viewer) - NPM package to view Simularium trajectories in 3D
- [simularium-website](https://github.com/simularium/simularium-website) - Front end website for the Simularium project, includes the Simularium viewer

## Simularium Project Status
While we are continuing to support Simularium, **active development on new features is currently paused**. As a result, new feature request will not be addressed immediately.
Copy link
Contributor

@toloudis toloudis May 14, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not totally sure of the benefit of doing this. I would like to think that if we get significant requests we might be nimble enough to consider each one individually. Mostly I would be afraid of discouraging people from communicating about issues.

<br/>

---
Expand Down Expand Up @@ -95,6 +97,7 @@ Upload your file to a public Dropbox or Google Drive folder or an AWS S3 bucket,
* Smoldyn (http://www.smoldyn.org/)
* SpringSaLaD (https://vcell.org/ssalad)
* Molecular dynamics trajectories via MDAnalysis (https://www.mdanalysis.org/)
* NERDSS (https://mjohn218.github.io/NERDSS/)
* Conversions for data from custom engines can be implemented using the TrajectoryConverter class
* Also accepts metrics data for plots to display alongside spatial data

Expand Down Expand Up @@ -152,6 +155,7 @@ See the Tutorial for the simulation engine you're using for details:
* [Smoldyn Tutorial](examples/Tutorial_smoldyn.ipynb)
* [SpringSaLaD Tutorial](examples/Tutorial_springsalad.ipynb)
* [Molecular Dynamics Tutorial](examples/Tutorial_md.ipynb)
* [NERDSS Tutorial](examples/Tutorial_nerdss.ipynb)

An overview for data from ReaDDy:
```python
Expand Down
Loading