Skip to content

Commit 6b4c070

Browse files
committed
Add user agreement and README
1 parent 1cb02d9 commit 6b4c070

File tree

2 files changed

+85
-8
lines changed

2 files changed

+85
-8
lines changed

README.md

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,30 @@
22
An open platform for sharing single-molecule localization microscopy data and tools.
33

44
## Key Features
5-
* Public localization data repository
6-
* Private sharing with secured url
7-
* 2D/3D Visualizing localization data in your web browser
8-
* Import `CSV` files, and export as `SMLM` format
9-
5+
* Open repository single-molecule localization data and tools
6+
* Storing data on [Zenodo](https://zenodo.org)
7+
* Open and extendable via [ImJoy](https://imjoy.io) plugins
8+
* Browser-based SMLM data viewer with 2D/3D, no installation required
9+
* Easy-to-use upload interface with file preview support
10+
* Import various type of file formats
1011
## The SMLM file format
1112

12-
ShareLoc platform relies on the [SMLM file format](https://github.com/imodpasteur/smlm-file-format), which makes the visualization and sharing more affordable.
13+
To enable faster preview and portable sharing, we developed a binary and losslessly compressed file format for storing localization tables and image patches.
14+
15+
For more details see: [SMLM file format](https://github.com/imodpasteur/smlm-file-format)
16+
17+
## Acknowledgements
18+
19+
The SMLM viewer plugin used in ShareLoc.XYZ is adapted from the Fairy Dust viewer developed by [Felix Woitzel](https://twitter.com/flexi23)(in collaboration with [Christophe Leterrier](https://twitter.com/christlet)).
20+
21+
## License
22+
23+
The source code of ShareLoc.XYZ platform is released under MIT license. The content hosted in ShareLoc.XYZ, including data and applications are owned by the original authors and made available according to the corresponding license.
24+
25+
Fairy Dust is released under MIT license, and we apply the same MIT license to the .
1326

27+
## Citation
28+
If you find ShareLoc.XYZ helpful for your research please consider cite ShareLoc.XYZ: [TODO]
29+
## Disclaimer Agreement
1430

15-
## Annotation Examples
16-
[TODO]
31+
By using the ShareLoc.XYZ website and/or viewing material on the website, you agree to become bound by the terms of this [User Agreement](./user-agreement.md). If you do not agree to the Disclaimer, Terms of Use, and Privacy Statements of this User Agreement, do not use this website or any portion thereof in any form or manner.

user-agreement.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# User Agreement
2+
3+
Last updated: June 30, 2021
4+
5+
## Interpretation and Definitions
6+
### Interpretation
7+
The words of which the initial letter is capitalized have meanings defined under the following conditions. The following definitions shall have the same meaning regardless of whether they appear in singular or in plural.
8+
9+
### Definitions
10+
For the purposes of this Disclaimer:
11+
12+
* Team (referred to as either "the Team", "We", "Us" or "Our" in this Disclaimer) refers to Imaging and Model Group at Institut Pasteur, Institut Pasteur, 25 rue du Docteur Roux, 75015 Paris, France.
13+
14+
* Service refers to the Website.
15+
* You means the individual accessing the Service, or the Team, or other legal entity on behalf of which such individual is accessing or using the Service, as applicable.
16+
* Website refers to ShareLoc.XYZ, accessible from https://shareloc.xyz
17+
18+
## Disclaimer
19+
The information contained on the Service is for general information purposes only.
20+
21+
The Team assumes no responsibility for errors or omissions in the contents of the Service.
22+
23+
In no event shall the Team be liable for any special, direct, indirect, consequential, or incidental damages or any damages whatsoever, whether in an action of contract, negligence or other tort, arising out of or in connection with the use of the Service or the contents of the Service. The Team reserves the right to make additions, deletions, or modifications to the contents on the Service at any time without prior notice.
24+
25+
The Team does not warrant that the Service is free of viruses or other harmful components.
26+
27+
## External Links Disclaimer
28+
The Service may contain links to external websites that are not provided or maintained by or in any way affiliated with the Team.
29+
30+
Please note that the Team does not guarantee the accuracy, relevance, timeliness, or completeness of any information on these external websites.
31+
32+
## Errors and Omissions Disclaimer
33+
The information given by the Service is for general guidance on matters of interest only. Even if the Team takes every precaution to insure that the content of the Service is both current and accurate, errors can occur. Plus, given the changing nature of laws, rules and regulations, there may be delays, omissions or inaccuracies in the information contained on the Service.
34+
35+
The Team is not responsible for any errors or omissions, or for the results obtained from the use of this information.
36+
37+
## Fair Use Disclaimer
38+
The Team may use copyrighted material which has not always been specifically authorized by the copyright owner. The Team is making such material available for criticism, comment, news reporting, teaching, scholarship, or research.
39+
40+
The Team believes this constitutes a "fair use" of any such copyrighted material as provided for in section 107 of the United States Copyright law.
41+
42+
If You wish to use copyrighted material from the Service for your own purposes that go beyond fair use, You must obtain permission from the copyright owner.
43+
44+
## Views Expressed Disclaimer
45+
The Service may contain views and opinions which are those of the authors and do not necessarily reflect the official policy or position of any other author, agency, organization, employer or Team, including the Team.
46+
47+
Content uploaded by users are their sole responsibility and the users will take full responsibility, liability and blame for any libel or litigation that results from something written in or as a direct result of something written in user provided content. The Team is not liable for any content published by users and reserve the right to delete any user uploaded content for any reason whatsoever.
48+
49+
## No Responsibility Disclaimer
50+
The information on the Service is provided with the understanding that the Team is not herein engaged in rendering legal, accounting, tax, or other professional advice and services. As such, it should not be used as a substitute for consultation with professional accounting, tax, legal or other competent advisers.
51+
52+
In no event shall the Team or its suppliers be liable for any special, incidental, indirect, or consequential damages whatsoever arising out of or in connection with your access or use or inability to access or use the Service.
53+
54+
## "Use at Your Own Risk" Disclaimer
55+
All information in the Service is provided "as is", with no guarantee of completeness, accuracy, timeliness or of the results obtained from the use of this information, and without warranty of any kind, express or implied, including, but not limited to warranties of performance, merchantability and fitness for a particular purpose.
56+
57+
The Team will not be liable to You or anyone else for any decision made or action taken in reliance on the information given by the Service or for any consequential, special or similar damages, even if advised of the possibility of such damages.
58+
59+
## Contact Us
60+
If you have any questions about this Disclaimer, You can contact Us:
61+
62+
By email: shareloc@pasteur.fr

0 commit comments

Comments
 (0)