From 45e15991b6f5a73792f2581c11fe3601602e48cb Mon Sep 17 00:00:00 2001 From: ghiggi Date: Fri, 12 May 2023 10:17:37 +0200 Subject: [PATCH] Add authors and small edits to the doc --- AUTHORS.md | 18 ++++++++++++++++++ CONTRIBUTING.rst | 10 +++------- SECURITY.md | 24 ++++++++++++++++++++++++ docs/source/authors.rst | 3 +++ docs/source/index.rst | 8 ++++---- docs/source/sensor_configs.rst | 6 ++++-- 6 files changed, 56 insertions(+), 13 deletions(-) create mode 100644 AUTHORS.md create mode 100644 SECURITY.md create mode 100644 docs/source/authors.rst diff --git a/AUTHORS.md b/AUTHORS.md new file mode 100644 index 00000000..326af451 --- /dev/null +++ b/AUTHORS.md @@ -0,0 +1,18 @@ +# Project Contributors + +The following people have made contributions to this project: + + + + + + + +- [Alexis Berne](https://people.epfl.ch/alexis.berne?lang=en) - EPFL +- [Gionata Ghiggi (ghiggi)](https://github.com/ghiggi) - EPFL +- [Jacopo Grazioli (jacgraz)](https://github.com/jacgraz) - EPFL +- [Saverio Guzzo (saveriogzz)](https://github.com/saveriogzz) - TU DELFT +- [Kim Candolfi (KimCandolfi)](https://github.com/KimCandolfi) - EPFL +- [Régis Longchamp (regislon)](https://github.com/regislon) - EPFL +- [Son Pham-Ba (sphamba)](https://github.com/sphamba) - EPFL +- [Charlotte Gisèle Weil (charlottegiseleweil)](https://github.com/charlottegiseleweil) - EPFL diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 6f9213e8..999f5923 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -19,7 +19,6 @@ and read through the following documnents : - `Contributing environment setup <#contributing-environment-setup>`__ - `Contributing process <#contributing-process>`__ - `Code review checklist <#code-review-checklist>`__ -- `Financial contribution <#financial-contribution>`__ @@ -477,13 +476,10 @@ Code review checklist .. _section-2: -Financial Contribution ----------------------- - -We also welcome financial contributions. Please contact us directly. Credits ------- -Thank you to all the people who have already contributed to DISDRODB. -repository! +Thank you to all the people who have already contributed to DISDRODB repository! + +If you have contributed data and/or code to disdrodb, add your name to the `AUTHORS.md `__ file. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 00000000..b3b5c7e6 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,24 @@ +# Security Policy + +## Supported Versions + +disdrodb is currently pre-1.0 and includes some changes in every release. As such we can't +guarantee that releases before 1.0 will see security updates except for the most recent +release. After 1.0, you can expect more stability in the interfaces and security fixes to be +backported more regularly. + +| Version | Supported | +| ------- | ------------------ | +| 0.x.x (latest) | :white_check_mark: | +| < 0.0.17 | :x: | + +## Unsafe YAML Loading + +disdrodb allows for unsafe loading of YAML configuration files. Any YAML files +from untrusted sources should be sanitized of possibly malicious code. + +## Reporting a Vulnerability + +Do you think you've found a security vulnerability or issue in this project? Let us know by sending +a message to the maintainers. Please include as much information on +the issue as possible like code examples, documentation on the issue in other packages, etc. diff --git a/docs/source/authors.rst b/docs/source/authors.rst new file mode 100644 index 00000000..ab68d0d9 --- /dev/null +++ b/docs/source/authors.rst @@ -0,0 +1,3 @@ +.. _list_authors: + +.. mdinclude:: ../../AUTHORS.md diff --git a/docs/source/index.rst b/docs/source/index.rst index 090c607f..c5a6d421 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -3,7 +3,7 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to disdroDB's documentation! +Welcome to disdrodb's documentation! ======================================= DISDRODB: A global database of raindrop size distribution observations @@ -31,8 +31,8 @@ difficult to share, analyse, compare and re-use. Additionally, very limited software is currently publicly available for DSD processing. -This software aims to define a standard format to save disdrometer data. - +This software aims to define a standard format to save disdrometer data and to create a decentralized archive to promote the exchange of data across the scientific community. +Currently, disdrodb enables to process data acquired from the OTT Parsivel (``OTT_Parsivel``), OTT Parsivel2 (``OTT_Parsivel2``), Thies Laser Precipitation Monitor (``ThiesLPM``) and RD-80 (``RD_80``) disdrometers. Documentation @@ -50,7 +50,7 @@ Documentation l0_processing contributors_guidelines maintainers_guidelines - + authors diff --git a/docs/source/sensor_configs.rst b/docs/source/sensor_configs.rst index e29d07af..2ffdced4 100644 --- a/docs/source/sensor_configs.rst +++ b/docs/source/sensor_configs.rst @@ -5,8 +5,10 @@ Add new sensor configs DISDRODB tailor the processing of the disdrometer measurements according to the instrument type and characteristics. -Several sensor configurations are already implemented and can be seen -by typing the command: +Currently, disdrodb enables to process data acquired from the OTT Parsivel (``OTT_Parsivel``), OTT Parsivel2 (``OTT_Parsivel2``), Thies Laser Precipitation Monitor (``ThiesLPM``) and RD-80 (``RD_80``) disdrometers. + + +The sensor configurations already implemented can be listed by typing the command: .. code-block:: python