Skip to content

Commit

Permalink
Add authors and small edits to the doc
Browse files Browse the repository at this point in the history
  • Loading branch information
ghiggi committed May 12, 2023
1 parent 1383232 commit 45e1599
Show file tree
Hide file tree
Showing 6 changed files with 56 additions and 13 deletions.
18 changes: 18 additions & 0 deletions AUTHORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Project Contributors

The following people have made contributions to this project:

<!--- Use your GitHub account or any other personal reference URL --->
<!--- If you wish to not use your real name, please use your github username --->
<!--- The list should be alphabetical by last name if possible, with github usernames at the bottom and the istitution --->

<!--- See https://gist.github.com/djhoese/52220272ec73b12eb8f4a29709be110d for auto-generating parts of this list --->

- [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
10 changes: 3 additions & 7 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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>`__



Expand Down Expand Up @@ -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 <https://github.com/ltelab/disdrodb/blob/main/AUTHORS.md>`__ file.
24 changes: 24 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -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.
3 changes: 3 additions & 0 deletions docs/source/authors.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. _list_authors:

.. mdinclude:: ../../AUTHORS.md
8 changes: 4 additions & 4 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -50,7 +50,7 @@ Documentation
l0_processing
contributors_guidelines
maintainers_guidelines

authors



Expand Down
6 changes: 4 additions & 2 deletions docs/source/sensor_configs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 45e1599

Please sign in to comment.