https://github.com/echemdb/manuscript_echemdb_rdm

Supporting information to a manuscript describing echemdb's approach to RDM.
https://github.com/echemdb/manuscript_echemdb_rdm

Last synced: 3 months ago
JSON representation

Supporting information to a manuscript describing echemdb's approach to RDM.

• Host: GitHub
• URL: https://github.com/echemdb/manuscript_echemdb_rdm
• Owner: echemdb
• License: other
• Created: 2024-07-04T18:42:14.000Z (11 months ago)
• Default Branch: master
• Last Pushed: 2025-02-11T21:16:46.000Z (3 months ago)
• Last Synced: 2025-02-11T22:26:19.273Z (3 months ago)
• Size: 44.9 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![DOI](https://zenodo.org/badge/824276671.svg)](https://zenodo.org/doi/10.5281/zenodo.13739617)

# Welcome to manuscript_echemdb_rdm

This repository contains supporting information for the manuscript denoted [A Lightweight Approach to Getting Data Ready for Data Management Solutions](https://arxiv.org/abs/2409.07083).

The manuscript illustrates how [echemdb's](https://github.com/echemdb/) toolbox can be used for local research data management.

It provides information on file naming convention (FNC), automatic/programmatic metadata acquisition, and converting data into [frictionless Data Packages](https://datapackage.org/).

Furthermore, the [unitpackages](https://echemdb.github.io/unitpackage/) API is introduced (based on the [frictionless Python framework](https://framework.frictionlessdata.io/)), which allows creating, interacting, and exploring these Data Packages.

The examples from the manuscript and the usage of our tools for RDM applications are also illustrated in a [specific documentation](https://echemdb.github.io/rawtofigure/intro.html).

## Structure

The doc folder contains Jupyter notebooks on

* [how ro get started with local data management](./doc/getting_started.md)

* [illustrating automatic annotation of metadata with watchdog](./doc/tag_data.ipynb)

* [providing usage examples for the unitpackage API](./doc/unitpackage_demo.ipynb)

and a folder with

* [data used in the notebooks or shown in the manuscript](./doc/data/)

* [metadata templates for the fileobserver](./doc/files/)

## Installation

The required packages can be found in the [environment.yml](environment.yml), which can be installed manually, with pip, or conda/mamba in a specific environment.

```sh

conda env create -f environment.yml

```

More details on requirements and installation instructions can be found in the [Getting started](getting_started.md) section.