Create new version v1.1.0. Data integration pipeline now does disk space check and skips data transfer if destination files already exist.
This commit is contained in:
41
README.md
41
README.md
@ -3,10 +3,10 @@
|
||||
|
||||
## Description
|
||||
|
||||
**DIMA** (Data Integration and Metadata Annotation) is a Python package developed to support the findable, accessible, interoperable, and reusable (FAIR) data transformation of multi-instrument data at the **Laboratory of Atmospheric Chemistry** as part of the project **IVDAV**: *Instant and Versatile Data Visualization During the Current Dark Period of the Life Cycle of FAIR Research*, funded by the [ETH-Domain ORD Program Measure 1](https://ethrat.ch/en/measure-1-calls-for-field-specific-actions/).
|
||||
**DIMA** (Data Integration and Metadata Annotation) is a Python package for data curation and HDF5 conversion of multi-instrument scientific data. It was developed to support the Findable, Accessible, Interoperable, and Reusable (**FAIR**) data transformation efforts at the **Laboratory of Atmospheric Chemistry** at the PSI Center for Energy and Environmental Sciences.
|
||||
|
||||
The **FAIR** data transformation involves cycles of data harmonization and metadata review. DIMA facilitates these processes by enabling the integration and annotation of multi-instrument data into the HDF5 format. This data may originate from diverse experimental campaigns, including **beamtimes**, **kinetic flow tube studies**, **smog chamber experiments**, and **field campaigns**.
|
||||
|
||||
The **FAIR** data transformation involves cycles of data harmonization and metadata review. DIMA facilitates these processes by enabling the integration and annotation of multi-instrument data in HDF5 format. This data may originate from diverse experimental campaigns, including **beamtimes**, **kinetic flowtube studies**, **smog chamber experiments**, and **field campaigns**.
|
||||
|
||||
|
||||
## Key features
|
||||
@ -248,31 +248,28 @@ relative_humidity:
|
||||
```
|
||||
</details>
|
||||
|
||||
# Editing this README
|
||||
## Authors
|
||||
|
||||
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
|
||||
This toolkit was developed by:
|
||||
|
||||
## Suggestions for a good README
|
||||
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
|
||||
- Juan F. Flórez-Ospina
|
||||
- Lucia Iezzi
|
||||
- Natasha Garner
|
||||
- Thorsten Bartels-Rausch
|
||||
|
||||
## Badges
|
||||
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
|
||||
All authors are affiliated with the **PSI Center for Energy and Environmental Sciences**, 5232 Villigen PSI, Switzerland.
|
||||
|
||||
## Visuals
|
||||
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
|
||||
|
||||
## Installation
|
||||
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
|
||||
|
||||
## Usage
|
||||
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
|
||||
|
||||
## Support
|
||||
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
|
||||
|
||||
## Roadmap
|
||||
If you have ideas for releases in the future, it is a good idea to list them in the README.
|
||||
- For general correspondence: [thorsten.bartels-rausch@psi.ch](mailto:thorsten.bartels-rausch@psi.ch)
|
||||
- For implementation-specific questions: [juan.florez-ospina@psi.ch](mailto:juan.florez-ospina@psi.ch), [juanflo16@gmail.com](mailto:juanflo16@gmail.com)
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Funding
|
||||
|
||||
This work was funded by the **ETH-Domain Open Research Data (ORD) Program – Measure 1**.
|
||||
|
||||
It is part of the project **IVDAV**: *Instant and Versatile Data Visualization During the Current Dark Period of the Life Cycle of FAIR Research*, funded by the [ETH-Domain ORD Program Measure 1](https://ethrat.ch/en/measure-1-calls-for-field-specific-actions/), which is described in more detail at the [ORD Program project portal](https://open-research-data-portal.ch/projects/instant-and-versatile-data-visualization-during-the-current-dark-period-of-the-life-cycle-of-fair-research/).
|
||||
|
||||
|
||||
---
|
Reference in New Issue
Block a user