Skip to main content

Schema for the Open Reaction Database

Project description

Open Reaction Database: Schema (ord-schema)

CI codecov

This repository contains the schema for the Open Reaction Database initiative; please see the documentation at https://docs.open-reaction-database.org.

This repository does not contain the database itself; that is stored in ord-data. Rather, ord-schema is designed to store the database schema and tools for creating, validating, and submitting data to the database.

Installation

If you have not previously installed rdkit via conda:

$ pip install ord-schema[rdkit]

Otherwise:

$ pip install ord-schema

To install in editable/development mode:

$ git clone https://github.com/open-reaction-database/ord-schema.git
$ cd ord-schema
$ python setup.py build  # Compile protocol buffers.
$ pip install -e .

Examples

The examples/ directory contains examples of dataset creation and use. To run locally, install with:

$ pip install "ord-schema[examples]"

Click here to run the examples with Binder: Binder

Project details


Download files

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

Source Distribution

ord-schema-0.3.17.tar.gz (91.8 kB view hashes)

Uploaded Source

Built Distribution

ord_schema-0.3.17-py3-none-any.whl (119.6 kB view hashes)

Uploaded Python 3

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