metador-core

Core of Metador, the FAIR metadata-first research data management framework.

https://github.com/materials-data-science-and-informatics/metador-core

Keywords

fair framework hdf5 metadata python3 rdm

Keywords from Contributors

interactive ecosystem-modeling mesh interpretability profiles distribution sequences generic projection standardization

Last synced: 4 months ago · JSON representation ·

Repository

Core of Metador, the FAIR metadata-first research data management framework.

Basic Info

Host: GitHub
Owner: Materials-Data-Science-and-Informatics
License: mit
Language: Python
Default Branch: main
Homepage:
Size: 13.7 MB

Statistics

Stars: 4
Watchers: 2
Forks: 0
Open Issues: 26
Releases: 2

Topics

fair framework hdf5 metadata python3 rdm

Created almost 4 years ago · Last pushed about 2 years ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation Authors Codemeta

metador-core

The core library of the Metador framework. It provides:

an interface for managing structured and validated metadata (MetadorContainer)
an API to manage immutable (but still "patchable") HDF5 files (IH5Record)
an extensible entry-points based plugin system for defining plugin groups and plugins
core plugin group types and interfaces (schemas, packers, widgets, ...)
general semantically aligned schemas that can be used and extended
visualization widgets for common data types based on Bokeh and Panel
generic dashboard presenting (meta)data for which suitable widgets are installed

Installation

You can install the current stable version of Metador from PyPI:

pip install metador-core

Getting Started

If you successfully installed the package, check out the tutorial notebooks.

These are intended to showcase what Metador has to offer and get you started with usage and development of your own schemas, widgets or other plugins.

To explore the notebooks interactively, clone this repo, install it, and then run:

pip install notebook jupyter notebook ./docs/notebooks

You can use the metador-extension-cookiecutter template to generate a well-structured Python package repository that you can use to quickly get started with Metador plugin development.

Compatibility and Known Issues

Currently this package supports Python >=3.8.

We will try to support all still officially updated versions of Python, unless forced to drop it for technical reasons.

You can find more information on using and contributing to this repository in the documentation.

How to Cite

If you want to cite this project in your scientific work, please use the citation file in the repository.

Acknowledgements

We kindly thank all authors and contributors.

This project was developed at the Institute for Materials Data Science and Informatics (IAS-9) of the Jülich Research Center and funded by the Helmholtz Metadata Collaboration (HMC), an incubator-platform of the Helmholtz Association within the framework of the Information and Data Science strategic initiative.

Owner

Name: Materials Data Science and Informatics
Login: Materials-Data-Science-and-Informatics
Kind: organization

Repositories: 8
Profile: https://github.com/Materials-Data-Science-and-Informatics

Citation (CITATION.cff)

cff-version: 1.2.0
type: software
message: If you use this software, please cite it using these metadata.

title: metador-core
version: 0.1.2
abstract: Core of Metador, the metadata-first research data management framework.
repository-code: "https://github.com/Materials-Data-Science-and-Informatics/metador-core"
license: MIT
keywords:
- metadata
- rdm
- FAIR
- framework
- python
authors:
- family-names: Pirogov
  given-names: Anton
  email: a.pirogov@fz-juelich.de
  orcid: https://orcid.org/0000-0002-5077-7497
contact:
- family-names: Pirogov
  orcid: https://orcid.org/0000-0002-5077-7497
  given-names: Anton
  email: a.pirogov@fz-juelich.de
url: https://github.com/Materials-Data-Science-and-Informatics/metador-core

CodeMeta (codemeta.json)

{
  "@context": [
    "https://doi.org/10.5063/schema/codemeta-2.0",
    "https://w3id.org/software-iodata",
    "https://raw.githubusercontent.com/jantman/repostatus.org/master/badges/latest/ontology.jsonld",
    "https://schema.org",
    "https://w3id.org/software-types"
  ],
  "@type": "SoftwareSourceCode",
  "applicationCategory": [
    "Scientific/Engineering",
    "Software Development > Libraries > Application Frameworks"
  ],
  "audience": [
    {
      "@type": "Audience",
      "audienceType": "Developers"
    },
    {
      "@type": "Audience",
      "audienceType": "Science/Research"
    }
  ],
  "author": [
    {
      "@id": "https://orcid.org/0000-0002-5077-7497",
      "@type": "Person",
      "familyName": "Pirogov",
      "givenName": "Anton"
    }
  ],
  "codeRepository": "https://github.com/Materials-Data-Science-and-Informatics/metador-core",
  "description": "Core of Metador, the metadata-first research data management framework.",
  "developmentStatus": "https://www.repostatus.org/#wip",
  "identifier": "metador-core",
  "keywords": [
    "FAIR",
    "framework",
    "metadata",
    "python",
    "rdm"
  ],
  "license": "http://spdx.org/licenses/MIT",
  "maintainer": {
    "@type": "Person",
    "email": "a.pirogov@fz-juelich.de",
    "familyName": "Pirogov",
    "givenName": "Anton"
  },
  "name": "metador-core",
  "operatingSystem": "POSIX > Linux",
  "runtimePlatform": "Python 3",
  "softwareHelp": "https://github.com/Materials-Data-Science-and-Informatics/metador-core",
  "softwareRequirements": [
    {
      "@type": "SoftwareApplication",
      "identifier": "'version':",
      "name": "'version':",
      "runtimePlatform": "Python 3",
      "version": "'^0.9.0'}"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "Flask",
      "name": "Flask",
      "runtimePlatform": "Python 3",
      "version": "^2.1.3"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "Pillow",
      "name": "Pillow",
      "runtimePlatform": "Python 3",
      "version": "^9.1.1"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "Pint",
      "name": "Pint",
      "runtimePlatform": "Python 3",
      "version": "^0.21"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "h5py",
      "name": "h5py",
      "runtimePlatform": "Python 3",
      "version": "^3.10.0"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "importlib-metadata",
      "name": "importlib-metadata",
      "runtimePlatform": "Python 3",
      "version": "^4.11.4"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "isodate",
      "name": "isodate",
      "runtimePlatform": "Python 3",
      "version": "^0.6.1"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "overrides",
      "name": "overrides",
      "runtimePlatform": "Python 3",
      "version": "^7.0.0"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "pandas",
      "name": "pandas",
      "runtimePlatform": "Python 3",
      "version": "^2.0.3"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "panel",
      "name": "panel",
      "runtimePlatform": "Python 3",
      "version": "^0.14.0"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "param",
      "name": "param",
      "runtimePlatform": "Python 3",
      "version": "^1.13.0"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "phantom-types",
      "name": "phantom-types",
      "runtimePlatform": "Python 3",
      "version": "^2.1.0"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "pydantic",
      "name": "pydantic",
      "runtimePlatform": "Python 3",
      "version": "^1.10.12"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "pydantic-yaml",
      "name": "pydantic-yaml",
      "runtimePlatform": "Python 3",
      "version": "^1.1.1"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "python",
      "name": "python",
      "runtimePlatform": "Python 3",
      "version": "^3.8"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "python-magic",
      "name": "python-magic",
      "runtimePlatform": "Python 3",
      "version": "^0.4.25"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "rdflib",
      "name": "rdflib",
      "runtimePlatform": "Python 3",
      "version": "^6.2.0"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "runtype",
      "name": "runtype",
      "runtimePlatform": "Python 3",
      "version": "^0.3.5"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "simple-parsing",
      "name": "simple-parsing",
      "runtimePlatform": "Python 3",
      "version": "^0.0.20"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "typer",
      "name": "typer",
      "runtimePlatform": "Python 3",
      "version": "{'extras': ['all'"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "typing-extensions",
      "name": "typing-extensions",
      "runtimePlatform": "Python 3",
      "version": "^4.6.0"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "wrapt",
      "name": "wrapt",
      "runtimePlatform": "Python 3",
      "version": "^1.14.1"
    }
  ],
  "targetProduct": {
    "@type": "CommandLineApplication",
    "executableName": "metador",
    "name": "metador",
    "runtimePlatform": "Python 3"
  },
  "url": "https://github.com/Materials-Data-Science-and-Informatics/metador-core",
  "version": "0.1.2"
}

GitHub Events

Total

Last Year

Committers

Last synced: 8 months ago

All Time

Total Commits: 237
Total Committers: 6
Avg Commits per committer: 39.5
Development Distribution Score (DDS): 0.266

Past Year

Commits: 0
Committers: 0
Avg Commits per committer: 0.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
a.pirogov	a**v@f**e	174
Anton Pirogov	a****v	48
Mustafa Soylu	m**u@f**e	7
FionaDmello	4****o	6
dependabot[bot]	4****]	1
Jens Bröder	j**r@f**e	1

Committer Domains (Top 20 + Academic)

fz-juelich.de: 3

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 66
Total pull requests: 4
Average time to close issues: about 2 months
Average time to close pull requests: 10 days
Total issue authors: 4
Total pull request authors: 3
Average comments per issue: 0.59
Average comments per pull request: 0.5
Merged pull requests: 4
Bot issues: 0
Bot pull requests: 1

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

apirogov (60)
broeder-j (4)
Jas2Ma (1)
mustafasoylu (1)

Pull Request Authors

mustafasoylu (2)
dependabot[bot] (1)
FionaDmello (1)

Top Labels

Issue Labels

enhancement (47) prio:B (14) prio:A (14) internals (14) standards!!! (7) note (5) UX (5) bug (5) documentation (4) semantics (4) good first issue (3) widgets (2) help wanted (1)

Pull Request Labels

enhancement (2) dependencies (1)

Packages

Total packages: 1
Total downloads:
- pypi 16 last-month

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 4
Total maintainers: 3

pypi.org: metador-core

Core of Metador, the metadata-first research data management framework.

Homepage: https://github.com/Materials-Data-Science-and-Informatics/metador-core
Documentation: https://github.com/Materials-Data-Science-and-Informatics/metador-core
License: MIT
Latest release: 0.1.1
published over 2 years ago

Versions: 4
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 16 Last month

Rankings

Dependent packages count: 6.6%

Average: 25.4%

Stargazers count: 25.5%

Forks count: 30.5%

Dependent repos count: 30.6%

Downloads: 33.7%

Maintainers (3)

apirogov hofmann_v mustafasoylu

Last synced: 4 months ago

metador-core

Science Score: 54.0%

Keywords

Keywords from Contributors

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

metador-core

Installation

Getting Started

Compatibility and Known Issues

How to Cite

Acknowledgements

Owner

Citation (CITATION.cff)

CodeMeta (codemeta.json)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

pypi.org: metador-core

Rankings

Maintainers (3)