Skip to main content

Schema resources for the National Microbiome Data Collaborative (NMDC)

Project description

National Microbiome Data Collaborative Schema

PyPI - License PyPI version

The NMDC is a multi-organizational effort to integrate microbiome data across diverse areas in medicine, agriculture, bioenergy, and the environment. This integrated platform facilitates comprehensive discovery of and access to multidisciplinary microbiome data in order to unlock new possibilities with microbiome data science.

This repository mainly defines a LinkML schema for managing metadata from the National Microbiome Data Collaborative (NMDC).

Repository Contents Overview

Some products that are maintained, and tasks orchestrated within this repository are:

  • Maintenance of LinkML YAML that specifies the NMDC Schema
  • Makefile targets for converting the schema from it's native LinkML YAML format to other artifact like JSON Schema
  • Build, deployment and distribution of the schema as a PyPI package
  • Automatic publishing of refreshed documentation upon change to the schema, accessible here

Background

The NMDC Introduction to metadata and ontologies primer provides some the context for this project.

See also these slides describing the schema.

Maintaining the Schema

See MAINTAINERS.md for instructions on maintaining and updating the schema.

NMDC metadata downloads

See https://github.com/microbiomedata/nmdc-runtime/#data-exports

Ecosystem Diagram

flowchart TD
    subgraph nmdc-schema repo
    ly([NMDC LinkML YAML files])
    lg(generated artifacts)
    ly-.make all.->lg
    end
    subgraph Data Validation
    click ly href "https://github.com/microbiomedata/nmdc-schema/tree/main/src/schema" _top
    d[(Some data)]
    v[[Validation process]]
    v--Has input-->d
    v--Has input-->ly
    end
    subgraph MIxS
    m([MIxS Schema])
    end
    subgraph SubmissionPortal
    sppg[(Postgres)]
    spa[Portal API]
    sppg<-->spa
    click spa href "https://data.dev.microbiomedata.org/docs" _top
    ps[Pydantic schema]
    end
    subgraph MongoDB
    mc[(Collections)]
    ms[Implicit schema]
    ma[Search API]
    mc<-->ma
    click ma href "https://api.dev.microbiomedata.org/docs" _top
    end
    mc --Ingest--> sppg
    subgraph DH Template Prep
    saf[sheets_and_friends repo]
    sps([Submission Portal Schema])
    dhjs[Data Harmoizer JS, etc.]
    saf-->sps-->dhjs
    end
    dhjs-->SubmissionPortal
    subgraph DataMapping
    sa[sample-annotator repo]
    end
    spa-->sa-..->ma
    ly-..->ps
    sj[some json]
    ly-..->sj-..->MongoDB-..->ps

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nmdc_schema-7.1.0.tar.gz (440.5 kB view details)

Uploaded Source

Built Distribution

nmdc_schema-7.1.0-py3-none-any.whl (449.4 kB view details)

Uploaded Python 3

File details

Details for the file nmdc_schema-7.1.0.tar.gz.

File metadata

  • Download URL: nmdc_schema-7.1.0.tar.gz
  • Upload date:
  • Size: 440.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.16

File hashes

Hashes for nmdc_schema-7.1.0.tar.gz
Algorithm Hash digest
SHA256 f781b50c19d07c411f7ddb75191449bae28711917b97d56ce8ef99559eeb3ec5
MD5 a80ba8e2344eb85b3242f04e50574dc9
BLAKE2b-256 1d8fa3c38769223e2c03b1eb397584a866b1278c506f7c794f52512646613b60

See more details on using hashes here.

Provenance

File details

Details for the file nmdc_schema-7.1.0-py3-none-any.whl.

File metadata

  • Download URL: nmdc_schema-7.1.0-py3-none-any.whl
  • Upload date:
  • Size: 449.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.16

File hashes

Hashes for nmdc_schema-7.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1e126d420c2fa75c22a2f51f3e59aa440a8190379b2db5dcb89c237d31f2df6e
MD5 e7c0dd1e11fa0864501902a650df0e12
BLAKE2b-256 2bc5c50a89af00100e9c5d2cdde3011e7bd822e1f2200ac5a190295a0b4496a8

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page