diff --git a/AUTHORS.md b/AUTHORS.md deleted file mode 100644 index 964562c..0000000 --- a/AUTHORS.md +++ /dev/null @@ -1,5 +0,0 @@ -# Contributors - -* Stijn Van Hoey -* Nicolas Noé -* Peter Desmet diff --git a/CHANGELOG.md b/CHANGELOG.md index 6739a75..a67d160 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,33 +1,3 @@ # Changelog -## Version 0.3.0 - -- Add getting started examples to README (#55, #65) -- Simplify regex to look for valid file names (#60) -- Use HDF5, PVOL, VP, VPTS, VPTS CSV, ODIM consistently in documentation (#58) -- Make use of production, uat or dummy S3 bucket where appropriate (#59) -- Update contributors and copyright holder (to INBO) - -## Version 0.2.2 - -- Hotfix for Docker deployment continued -- Handle wrong function import - -## Version 0.2.1 - -- Hotfix for Docker deployment - -## Version 0.2.0 - -- Add support for uppercase radarcode in file names (#53) -- Improve logs and alert handling to AWS cloudwatch/SNS and make sure routine does not stop on single file failure (#54) -- Improve documentation (#55) - -## Version 0.1.0 - -- Integrate functions from [odimh5](https://pypi.org/project/odimh5) to read ODIM HDF5 files -- Support for converting ODIM HDF5 files to the VPTS CSV data standard -- S3 data storage integration -- CLI endpoint for the transfer of ODIM HDF5 files from Baltrad to the Aloft S3 bucket -- CLI endpoint for the conversion from ODIM HDF5 files to daily/monthly aggregates as VPTS CSV format -- Setup CI with Github Actions +See . \ No newline at end of file diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..c5af82c --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,34 @@ +cff-version: 1.2.0 +type: software +license: MIT +title: 'vptstools: Transfer and convert vertical profile time series data' +version: 0.4.0 +abstract: >- + vptstools is a Python library to transfer and convert VPTS data. + VPTS (vertical profile time series) express the density, speed and direction + of biological signals such as birds, bats and insects within a weather radar + volume, grouped into altitude layers (height) and measured over time + (datetime). +authors: + - given-names: Stijn + family-names: Van Hoey + orcid: https://orcid.org/0000-0001-6413-3185 + - given-names: Nicolas + family-names: Noé + orcid: https://orcid.org/0000-0002-9503-4750 + - given-names: Pieter + family-names: Huybrechts + affiliation: Research Institute for Nature and Forest (INBO) + orcid: https://orcid.org/0000-0002-6658-6062 + - given-names: Peter + family-names: Desmet + email: peter.desmet@inbo.be + affiliation: Research Institute for Nature and Forest (INBO) + orcid: https://orcid.org/0000-0002-8442-8025 +repository-code: https://github.com/enram/vptstools +url: https://enram.github.io/vptstools/ +date-released: '2024-10-22' +keywords: +- data transformation +- aeroecology +- weather radar diff --git a/README.md b/README.md index 6799b50..34f0026 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,12 @@ # vptstools + [![Project generated with PyScaffold](https://img.shields.io/badge/-PyScaffold-005CA0?logo=pyscaffold)](https://pyscaffold.org/) [![PyPI-Server](https://img.shields.io/pypi/v/vptstools.svg)](https://pypi.org/project/vptstools/) [![.github/workflows/release.yml](https://github.com/enram/vptstools/actions/workflows/release.yml/badge.svg)](https://github.com/enram/vptstools/actions/workflows/release.yml) +[![repo status](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) +[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.13959705.svg)](https://doi.org/10.5281/zenodo.13959705) + vptstools is a Python library to transfer and convert VPTS data. VPTS (vertical profile time series) express the density, speed and direction of biological signals such as birds, bats and insects within a weather radar volume, grouped into altitude layers (height) and measured over time (datetime). diff --git a/docs/authors.md b/docs/authors.md deleted file mode 100644 index ced47d0..0000000 --- a/docs/authors.md +++ /dev/null @@ -1,4 +0,0 @@ -```{include} ../AUTHORS.md -:relative-docs: docs/ -:relative-images: -```