Skip to content

Commit

Permalink
doc: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
haowang-bioinfo committed Oct 14, 2020
1 parent 861e263 commit e0237a6
Showing 1 changed file with 40 additions and 9 deletions.
49 changes: 40 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,29 +17,60 @@ Manuscript under preparation

#### Model Keywords

**Utilisation:** experimental data reconstruction, multi-omics integrative analysis, _in silico_ strain design, model template
**Utilisation:** multi-omics integrative analysis, predictive simulation
**Field:** metabolic-network reconstruction
**Type of Model:** reconstruction, curated
**Model Source:** YeastMetabolicNetwork
**Model Source:** Human-GEM
**Omic Source:** genomics, metabolomics
**Taxonomy:** _Saccharomyces cerevisiae_
**Taxonomy:** _Mus musculus_
**Metabolic System:** general metabolism
**Tissue:**
**Bioreactor:**
**Cell type:**
**Cell line:**
**Strain:** S288C
**Condition:** aerobic, glucose-limited, defined media
**Condition:** generic metabolism


### Installation
### Model Overview

{{ Be mindful of users who do not have a typical background - provide a clear overview of the required software. Also, there might be different requirements for users and collaborators. }}
|Taxonomy | Template Model | Reactions | Metabolites| Genes |
| ------------- |:-------------:|:-------------:|:-------------:|:-----:|
|_Mus musculus_ | Human-GEM | | | |


### Usage
## Installation

{{ Describe how to load and save the model. }}
### Required Software
* A functional MATLAB installation (MATLAB 7.3 and higher).
* The [RAVEN toolbox](https://github.com/SysBioChalmers/RAVEN).
* The [COBRA toolbox](https://github.com/opencobra/cobratoolbox) (not necessary for most functionality).


### Dependencies - Recommended Software
* The libSBML MATLAB API (version [5.13.0](https://sourceforge.net/projects/sbml/files/libsbml/5.13.0/stable/MATLAB%20interface/) is recommended).
* [Gurobi Optimizer](http://www.gurobi.com/registration/download-reg) for any simulations.


### Installation Instructions
* Clone the [master branch](https://github.com/SysBioChalmers/Human-GEM/tree/master) of this repository, or [download the latest release](https://github.com/SysBioChalmers/Human-GEM/releases/latest).
* Add the directory to your MATLAB path (instructions [here](https://se.mathworks.com/help/matlab/ref/addpath.html?requestedDomain=www.mathworks.com)).


## Usage

#### Loading/saving the model

`Mouse-GEM.mat` (Recommended if on `master` branch)
* Load and save using the built-in MATLAB `load()` and `save()` functions.

`Mouse-GEM.xml` (SBML format)
* Load using the `importModel.m` function (from [RAVEN Toolbox](https://github.com/SysBioChalmers/RAVEN))
* Save using the `exportModel.m` function (from [RAVEN Toolbox](https://github.com/SysBioChalmers/RAVEN))


## Websites

- [Metabolic Atlas](https://metabolicatlas.org/) enables visualization and exploration of Human-GEM content.


### Contributing
Expand Down

0 comments on commit e0237a6

Please sign in to comment.