Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
niklasmueboe committed Sep 27, 2021
1 parent fb302bf commit e08d85d
Showing 1 changed file with 16 additions and 19 deletions.
35 changes: 16 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# SSAM-lite-server

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE)
[![DOI:10.1101/2021.09.2x.xxxxxxxx](http://img.shields.io/badge/DOI-10.1101/2021.09.2x.xxxxxxxx-B31B1B.svg)](https://doi.org/10.1101/2021.09.2x.xxxxxxxx)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5517607.svg)](https://doi.org/10.5281/zenodo.5517607)

... is a lightweight implementation of the [SSAM framework](https://www.nature.com/articles/s41467-021-23807-4).
It provides the functionality of SSAMs most popular and widely used features in a graphical user interface
with a few functions added for convenience and ease of use. After installation on a server it can be used by
Expand All @@ -26,6 +30,13 @@ https://ssam-lite.readthedocs.io/en/latest/installation.html#ssam-lite-server
https://ssam-lite.readthedocs.io


## Versioning

This project follows the [SemVer](https://semver.org) guidelines for versioning.

For a list of versions see the [releases](https://github.com/HiDiHlabs/ssam-lite-server/releases).


## Citations

TODO update Citation when ready
Expand All @@ -36,26 +47,12 @@ Sebastian Tiesmeyer, Shashwat Sahay, Niklas Mueller-Boetticher, Roland Eils, Seb
*bioRxiv*. doi: 10.1101/2021....


## License

MIT License
## Sample data

Copyright (c) 2021 Sebastian Tiesmeyer, Naveed Ishaque, Roland Eils, Berlin Institute of Health @ Charité
Multiple datasets to try out SSAM-lite have been prepared and are available for download on
Zenodo (https://zenodo.org/record/5517607).

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
## License

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
This project is licensed under the MIT License - for details please refer to the [LICENSE](./LICENSE) file.

0 comments on commit e08d85d

Please sign in to comment.