Giter Club home page Giter Club logo

bigg_models's Introduction

bigg_models

BiGG Models is a website for browsing gold-standard genome-scale models, described in our publication here:

King ZA, Lu JS, Dräger A, Miller PC, Federowicz S, Lerman JA, Ebrahim A, Palsson BO, and Lewis NE. (2015). BiGG Models: A platform for integrating, standardizing, and sharing genome-scale models. Nucl Acids Res. doi:10.1093/nar/gkv1049.

This repository includes the web server and front-end for BiGG Models. The database is managed by COBRAdb. You can see our plans for new BiGG Models features in the Development Roadmap.

Installation

To install BiGG Models, first, follow the OME installation instructions: https://github.com/SBRG/ome/blob/bigg/INSTALL.md

Then, do the following to get BiGG Models up and running:

  1. Download the code with git clone [email protected]:SBRG/bigg_models.git
  2. cd bigg_models
  3. Install with python setup.py develop (may need to sudo or add --user)
  4. Generate the PostgreSQL indices by running bin/make_database_indices.
  5. Generate the static models by running bin/make_all_static_models.
  6. Start the server with python -m bigg_models.server --port=8910

Alternative installation: Docker

BiGG Models can also be installed with Docker. Everything you need is here, thanks to @psalvy:

https://github.com/psalvy/bigg-docker

Testing BiGG Models

Tests are run in both the ome and BiGG Models codebases using pytest. Running py.test with ome will create a temporary database and load it with a few simple test models. These tests can be run at any time. Running py.test with BiGG Models will run a series of test that are specific to the models currently available at http://bigg.ucsd.edu. These tests can only be run after the whole database is loaded.

Dumping and restoring the database

The latest database dumps are available in this Dropbox folder:

https://www.dropbox.com/sh/ye05djxrpxy37da/AAD6GrSRTt4MRfuIpprlnLYba?dl=0

We generally dump the database with this command:

pg_dump -Fc bigg > bigg_database.dump

And then restore like this:

pg_restore -c -d bigg bigg_database.dump

Generate a schema browser

Install and run schemaSpy. For example, here are the Mac OS X instructions:

brew install graphviz

brew tap gbeine/homebrew-java
brew install postgresql-jdbc

java -jar bin/schemaSpy_5.0.0.jar -t pgsql -db bigg -u username -s public \
  -o docs/schema -host localhost -port 5432 \
  -dp /usr/local/Cellar/postgresql-jdbc/9.3-1102/libexec/postgresql-9.3-1102.jdbc3.jar

Then open docs/schema/index.html in a web browser.

License

This codebase is released under the MIT license. The license information for the BiGG Models website hosted at SBRG and the associated models can be found here: http://bigg.ucsd.edu/license.

bigg_models's People

Contributors

zakandrewking avatar jslu9 avatar aebrahim avatar pillmill avatar npusarla avatar npmcdn-to-unpkg-bot avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.