Skip to content

Latest commit

 

History

History
143 lines (116 loc) · 8.17 KB

README.md

File metadata and controls

143 lines (116 loc) · 8.17 KB
Raw

Documentation Test results Test coverage Code analysis License

Datanator-rest-api

REST API (OpenAPI 3) interface of Datanator, a toolkit for discovering the data needed for modeling the biochemistry of cells.

Contents

Overview

A central goal of synthetic biology is to rationally design organisms. Similarly, a central goal of precision medicine is to tailor therapy to each patient based on their unique genome. Many engineering fields use computer-aided design (CAD) tools driven by mechanistic models to efficiently design complex systems such as planes. Analogously, more comprehensive and more predictive models of biological systems, such as whole-cell models, are needed to help bioengineers and physicians design biomachines and medical therapy.

One of the biggest bottlenecks to achieving such models is collecting and aggregating the large amount of data needed for model construction and verification. Due to advances in genomics and increased emphasis on data sharing, there is now extensive data about a wide range of biochemical entities and processes such as data about metabolite concentrations, RNA and protein abundances, and reaction rates. However, it remains difficult to utilize this information for modeling because the data scattered across numerous databases and publications; the data is described using different formats, identifiers, and units; and there are inadequate tools for finding relevant data for modeling a specific biological system in a specific environment.

The Datanator toolkit seeks to address these problems for biochemical modeling by providing investigators an integrated database of molecular data and tools for discovering relevant data for modeling projects and other meta analyses. Please see the About page for more information about the goals and features of Datanator.

The Datanator toolkit is composed of the following packages:

  • Datanator: Tools for aggregating and integrating diverse data from diverse sources into a single dataset and searching these datasets
  • Datanator-db: MongoDB server for Datanator-data
  • Datanator-fulltext-db: ElasticSearch server for Datanator-data
  • Datanator-query-python: Tools for querying Datanator-db and Datanator-fulltext-db
  • Datanator-rest-api: This package, REST interface for Datanator-query-python
  • Datanator-frontend: A web-based graphical user interface to Datanator-db.

This package provides a pythonic interface to programmatically access data stored in Datanator-db and Datanator-fulltext-db.

Development, testing, installation, and usage

Users

Use the public, hosted deployment

We recommend that users use the public, hosted version of Datanator-rest-api at https://api.datanator.info.

Developers

Install and deploy Datanator-rest-api locally

We recommend that developers install and run Datanator-rest-api locally. Below are instructions for installing and running Datanator-rest-api locally.

  1. Install git and pipenv
apt-get install git pipenv
  1. Clone this repository
git clone https://github.com/karrlab/datanator_rest_api
  1. Install this package
cd /path/to/datanator_rest_api
pipenv install -e .
  1. Spin up an independent python environment
pipenv shell
  1. Setup environment variables (credentials for accessing databases)
export USERNAME=XXXXXXX
export PASSWORD=XXXXXXX
export SERVER=XXXXXXX
export AUTHDB=XXXXXXX
export READ_PREFERENCE=XXXXXX
  1. Launch a server.
python datanator_rest_api/core.py

File organization

This repository is organized as follows:

  • datanator_rest_api/:
    • routes/: API routes
    • server/: Compiler for definition files
    • spec/: Specifications for URL paths and data schema
      • paths/: Specifications for URL
      • schemas/: Specifications for data schema
        • ftx/: Specifications ftx-related data schema
        • kegg/: Specifications KEGG-related data schema
        • metabolites/: Specifications metabolite-related data schema
        • proteins/: Specifications protein-related data schema
        • reactions/: Specifications reaction-related data schema
        • RNA/: Specifications RNA-related data schema
        • taxon/: Specifications taxon-related data schema
    • util/: utility tools
  • tests/
    • routes/: - test scripts in routes directory
    • spec/: - test scripts in spec directory
    • util/: - test scripts in util directory
  • nginx/: NGINX specification for production server
  • CODE_OF_CONDUCT: code of conduct
  • LICENSE: license
  • Pipfile: package requirements
  • Pipfile.lock: finalized package configuration
  • README: overview of the application
  • Dockerfile: Specification for making a docker container

Development and deployment workflow

  1. Create a Git new branch
  2. Commit code to the new branch
  3. Push the branch to GitHub
  4. GitHub will automatically trigger CircleCI to run the unit test, integration tests, and other static analyses
  5. Use Coveralls to review the coverage of the tests
  6. As needed, add additional tests and fix any failing tests
  7. Once the new code passes the tests and has high coverage, create a pull request to merge the new branch into the master branch
  8. One of the main developers will review the pull request and request changes as necessary
  9. Once any necessary changes have been made, one of the main developers will approve the pull request
  10. GitHub will automatically trigger CircleCI to run the unit test, integration tests, and other static analyses for the master branch
  11. Once the CircleCI build succeeds, downstream dependencies will automatically be tested and built

Contributing to Datanator

We welcome contributions to Datanator via GitHub pull requests. Please contact the developers to coordinate potential contributions, and please see above for information about how to submit pull requests.

License

This package is released under the MIT license.

Development team

This package was developed by the Karr Lab at the Icahn School of Medicine at Mount Sinai in New York by the following individuals:

Questions and comments

Please submit an issue, or contact the Karr Lab with any questions or comments.

Acknowledgements

Datanator was developed with support from the Center for Reproducible Biomedical Modeling from the National Institute of Bioimaging and Bioengineering and the National Institute of General Medical Sciences of the National Institutes of Health and the National Science Foundation (awards P41EB023912 and R35GM119771).