README.md 1.53 KB
Newer Older
Clement Frainay's avatar
Clement Frainay committed
1
![](https://forgemia.inra.fr/uploads/-/system/project/avatar/864/met4J_logo.png?width=64)
Unknown's avatar
Unknown committed
2
3
4
5
# Met4J

## Java library for metabolic networks

Clement Frainay's avatar
Clement Frainay committed
6
7
**Met4J is an open-source Java library dedicated to the structural analysis of metabolic networks. It also came with a toolbox gathering CLI for several analyses relevant to metabolism-related research.**

8
9
10
11
12
13
14
### Modules

Met4j is composed by several maven modules:
- [met4j-core](met4j-core/README.md): it's the key module which contains all the core 
classes for handling metabolic networks
- [met4j-io](met4j-io/README.md): for importing/exporting metabolic networks in several 
formats (SBML, MetExploreXml, KEGG)
cfrainay's avatar
cfrainay committed
15
- [met4j-graph](met4j-graph/README.md): for performing graph-based topological analysis of metabolic networks.
16
17
18
19
20
21
22

The other modules are for the moment not documented or still in progress.



### Installation

lcottret's avatar
Doc    
lcottret committed
23
24
25
26
27
28
#### From Maven

Install all modules :
```
<dependency>
<groupId>fr.inrae.toulouse.metexplore</groupId>
lcottret's avatar
lcottret committed
29
30
<artifactId>met4j-toolbox</artifactId>
<version>0.5.2</version>
lcottret's avatar
Doc    
lcottret committed
31
32
33
34
35
36
37
38
</dependency>
```

or a specific module (example : met4j-core ):
```
<dependency>
<groupId>fr.inrae.toulouse.metexplore</groupId>
<artifactId>met4j-core</artifactId>
lcottret's avatar
lcottret committed
39
<version>0.5.2</version>
lcottret's avatar
Doc    
lcottret committed
40
41
42
</dependency>
```

lcottret's avatar
lcottret committed
43
44
Replace the version number by the last version of met4j.

45
46
47
48
49
#### From gitlab

```
git clone https://forgemia.inra.fr/metexplore/met4j.git;
cd met4j;
lcottret's avatar
lcottret committed
50
mvn clean install 
51
52
53
54
55
56
57
58
59
60
61
62
```

### Tutorial

You can find tutorials by clicking on the module links above.
Examples can be found here:
https://forgemia.inra.fr/metexplore/tutorialmet4j