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 mission of the NMDC is to build a FAIR microbiome data sharing network, through infrastructure, data standards, and community building, that addresses pressing challenges in environmental sciences. The NMDC platform is built on top of a unified data model (schema) that weaves together existing standards and ontologies to provide a systematic representation of all aspects of the microbiome data life cycle.

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

Documentation

The documentation for the NMDC schema can be found at https://microbiomedata.github.io/nmdc-schema/. This documentation is aimed at consumers of NMDC data and metadata, it describes the different data elements used to describe studies, samples, sample processing, data generation, workflows, and downstream data objects.

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

The remainder of this page is primary for the internal maintainers and contributors to the NMDC schema

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

Maintaining the Schema

See DEVELOPMENT.md for instructions on setting up a development environment.

See MAINTAINERS.md for instructions on using that development environment to maintain the schema.

Makefiles

Makefiles are text files people can use to tell make (a computer program) how it can make things (or—in general—do things). In the world of Makefiles, those things are called targets.

This repo contains 2 Makefiles:

  • Makefile, based on the generic Makefile from the LinkML cookiecutter
  • project.Makefile, which contains targets that are specific to this project

Here's an example of using make in this repo:

# Deletes all files in `examples/output`.
make examples-clean

The examples-clean target is defined in the project.Makefile. In this repo, the Makefile includes the project.Makefile. As a result, make has access to the targets defined in both files.

Data downloads

The NMDC's metadata about biosamples, studies, bioinformatics workflows, etc. can be obtained from our nmdc-runtime API. Try entering "biosample_set" or "study_set" into the collection_name box at https://api.microbiomedata.org/docs#/metadata/list_from_collection_nmdcschema__collection_name__get

Or use the API programmatically! Note that some collections are large, so the responses are paged.

You can learn about the other available collections at https://microbiomedata.github.io/nmdc-schema/Database/

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-10.3.0.tar.gz (675.6 kB view details)

Uploaded Source

Built Distribution

nmdc_schema-10.3.0-py3-none-any.whl (701.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nmdc_schema-10.3.0.tar.gz
  • Upload date:
  • Size: 675.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for nmdc_schema-10.3.0.tar.gz
Algorithm Hash digest
SHA256 41bdaa219a61881a23784db971788a580cf8da30496caf8fa40acc7b90c4e561
MD5 5b951e674d745541b1d7a221c861fee6
BLAKE2b-256 6d1f4ad25df55e7fd8a1b0d13bef7da3426aa8d2c48384cca4776152e77cd3dd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nmdc_schema-10.3.0-py3-none-any.whl
  • Upload date:
  • Size: 701.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for nmdc_schema-10.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f1c70e8374fa3a1d555eb4338e5cf430e8f0e112b20986d4528d6112003614ba
MD5 932660086838d892220a57c33e2912fb
BLAKE2b-256 f79ef12e02d11d4b32c7b263a6eab9dd882f56944691045e0fc85776750109ad

See more details on using hashes here.

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