README.md 2.7 KB
Newer Older
Sylvain Arreckx's avatar
Sylvain Arreckx committed
1
2
3
4
5
<div align="center">
    <img src="docs/src/assets/header.svg?maxAge=0" width="80%">
</div>
<br>

Laurent Heirendt's avatar
Laurent Heirendt committed
6
7
# Constraint-Based Reconstruction and EXascale Analysis

St. Elmo's avatar
St. Elmo committed
8
[docs-img]:https://img.shields.io/badge/docs-latest-blue.svg
Laurent Heirendt's avatar
Laurent Heirendt committed
9
[docs-url]: http://lcsb-biocore.github.io/COBREXA.jl
10

Laurent Heirendt's avatar
Laurent Heirendt committed
11
12
[ci-img]: https://github.com/LCSB-BioCore/COBREXA.jl/actions/workflows/ci.yml/badge.svg?branch=master&event=push
[ci-url]: https://github.com/LCSB-BioCore/COBREXA.jl/actions/workflows/ci.yml
St. Elmo's avatar
St. Elmo committed
13

Laurent Heirendt's avatar
Laurent Heirendt committed
14
15
[cov-img]: https://codecov.io/gh/LCSB-BioCore/COBREXA.jl/branch/master/graph/badge.svg?token=3AE3ZDCJJG
[cov-url]: https://codecov.io/gh/LCSB-BioCore/COBREXA.jl
St. Elmo's avatar
St. Elmo committed
16
17
18

[contrib]: https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat

Laurent Heirendt's avatar
Laurent Heirendt committed
19
[![contributions welcome][contrib]](https://github.com/LCSB-BioCore/COBREXA.jl/issues)
St. Elmo's avatar
St. Elmo committed
20
21
22
23

| **Documentation** | **Tests** | **Coverage** |
|:--------------:|:-------:|:---------:|
| [![docs-img]][docs-url] | [![CI][ci-img]][ci-url] | [![codecov][cov-img]][cov-url] |
St. Elmo's avatar
St. Elmo committed
24

25
This is package aims to provide constraint based reconstruction and analysis tools at the exa-scale in Julia.
St. Elmo's avatar
St. Elmo committed
26

St. Elmo's avatar
St. Elmo committed
27

St. Elmo's avatar
St. Elmo committed
28
29
## Installation

30
To install this package: `] add ???`. See the documentation for more information.
St. Elmo's avatar
St. Elmo committed
31

St. Elmo's avatar
St. Elmo committed
32
## Quick Example
Laurent Heirendt's avatar
Laurent Heirendt committed
33

34
Let's use `COBREXA.jl` to perform classic flux balance analysis on an *E. coli* community.
St. Elmo's avatar
St. Elmo committed
35
```julia
36
using COBREXA
Laurent Heirendt's avatar
Laurent Heirendt committed
37
38
39

# download the model
model_file = COBREXA.Downloads.download("http://bigg.ucsd.edu/static/models/iJO1366.json", "iJO1366.json")
St. Elmo's avatar
St. Elmo committed
40

41
# Import E. coli models (models have pretty printing)
Laurent Heirendt's avatar
Laurent Heirendt committed
42
43
44
model_1 = read_model(model_file)
model_2 = read_model(model_file)
model_3 = read_model(model_file)
St. Elmo's avatar
St. Elmo committed
45

46
47
# Build an exascale model
exascale_model = join(model_1, model_2, model_3,...)
St. Elmo's avatar
St. Elmo committed
48
```
St. Elmo's avatar
St. Elmo committed
49
More funcionality is described in the documention, e.g. model construction and analysis in pure Julia.
St. Elmo's avatar
St. Elmo committed
50

St. Elmo's avatar
St. Elmo committed
51
### Citations
St. Elmo's avatar
St. Elmo committed
52
1) Ebrahim, A., Lerman, J.A., Palsson, B.O. & Hyduke, D. R. (2013). COBRApy: COnstraints-Based Reconstruction and Analysis for Python. BMC Systems Biology, 7(74). https://doi.org/10.1186/1752-0509-7-74
St. Elmo's avatar
update    
St. Elmo committed
53
2) Heirendt, L., Arreckx, S., Pfau, T. et al. (2019). Creation and analysis of biochemical constraint-based models using the COBRA Toolbox v.3.0. Nat Protoc 14, 639–702. https://doi.org/10.1038/s41596-018-0098-2
St. Elmo's avatar
St. Elmo committed
54
3) Noor, E., Bar-Even, A., Flamholz, A., Lubling, Y., Davidi, D., & Milo, R. (2012). An integrated open framework for thermodynamics of reactions that combines accuracy and coverage. Bioinformatics, 28(15), 2037–2044. https://doi.org/10.1093/bioinformatics/bts317
St. Elmo's avatar
St. Elmo committed
55
4) Chang, A., Jeske, L., Ulbrich, S., Hofmann, J., Koblitz, J., Schomburg, I., Neumann-Schaal, M., Jahn, D., Schomburg, D.. (2021). BRENDA, the ELIXIR core data resource in 2021: new developments and updates. Nucleic Acids Research, 49(D1). https://doi.org/10.1093/nar/gkaa1025