-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #7 from HiDiHlabs/nmb
update README.md
- Loading branch information
Showing
1 changed file
with
66 additions
and
61 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,61 +1,66 @@ | ||
| # SSAM-lite-server | ||
|
|
||
| ... 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 | ||
| researchers as browser-based web app. | ||
|
|
||
|
|
||
| Author: Sebastian Tiesmeyer ([email protected])<sup>1</sup> | ||
|
|
||
| <sup>1</sup> Digital Health Center, Berlin Institute of Health (BIH) at Charité – Universitätsmedizin, Berlin, Germany | ||
|
|
||
| ## Choose your flavour | ||
|
|
||
| You might also want to check out the [SSAM-lite](https://github.com/HiDiHlabs/ssam-lite) implementation. | ||
|
|
||
| For a guide to help you choose read https://ssam-lite.readthedocs.io/en/latest/local_vs_server.html | ||
|
|
||
| ## Installation | ||
|
|
||
| https://ssam-lite.readthedocs.io/en/latest/installation.html#ssam-lite-server | ||
|
|
||
|
|
||
| ## Documentation | ||
|
|
||
| https://ssam-lite.readthedocs.io | ||
|
|
||
|
|
||
| ## Citations | ||
|
|
||
| TODO update Citation when ready | ||
|
|
||
| Sebastian Tiesmeyer, Shashwat Sahay, Niklas Mueller-Boetticher, Roland Eils, Sebastian Mackowiak, Naveed Ishaque. | ||
| 2021. | ||
| "[SSAM-lite: a light-weight web-based framework for analysis of spatially resolved transcriptomics data](https://biorxiv.org)" | ||
| *bioRxiv*. doi: 10.1101/2021.... | ||
|
|
||
|
|
||
| ## License | ||
|
|
||
| MIT License | ||
|
|
||
| Copyright (c) 2021 Sebastian Tiesmeyer, Naveed Ishaque, Roland Eils, Berlin Institute of Health @ Charité | ||
|
|
||
| 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. | ||
|
|
||
| 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. | ||
| # SSAM-lite-server | ||
|
|
||
| [](./LICENSE) | ||
| [](https://doi.org/10.1101/2021.09.2x.xxxxxxxx) | ||
| [](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 | ||
| researchers as browser-based web app. | ||
|
|
||
|
|
||
| Author: Sebastian Tiesmeyer ([email protected])<sup>1</sup> | ||
|
|
||
| <sup>1</sup> Digital Health Center, Berlin Institute of Health (BIH) at Charité – Universitätsmedizin, Berlin, Germany | ||
|
|
||
| ## Choose your flavour | ||
|
|
||
| You might also want to check out the [SSAM-lite](https://github.com/HiDiHlabs/ssam-lite) implementation. | ||
|
|
||
| For a guide to help you choose read https://ssam-lite.readthedocs.io/en/latest/local_vs_server.html | ||
|
|
||
| ## Installation | ||
|
|
||
| https://ssam-lite.readthedocs.io/en/latest/installation.html#ssam-lite-server | ||
|
|
||
|
|
||
| ## Documentation | ||
|
|
||
| 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 | ||
|
|
||
| Sebastian Tiesmeyer, Shashwat Sahay, Niklas Mueller-Boetticher, Roland Eils, Sebastian Mackowiak, Naveed Ishaque. | ||
| 2021. | ||
| "[SSAM-lite: a light-weight web-based framework for analysis of spatially resolved transcriptomics data](https://biorxiv.org)" | ||
| *bioRxiv*. doi: 10.1101/2021.... | ||
|
|
||
|
|
||
| ## Sample data | ||
|
|
||
| Multiple datasets to try out SSAM-lite have been prepared and are available for download on | ||
| Zenodo (https://zenodo.org/record/5517607). | ||
|
|
||
|
|
||
| ## License | ||
|
|
||
| This project is licensed under the MIT License - for details please refer to the [LICENSE](./LICENSE) file. | ||
| ======= | ||
| 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. |