Commit d403531c authored by VIGNET Pierre's avatar VIGNET Pierre

Replace INSTALL file by an updated & proper README.md

parent 6d0ad711
################################################
# #
# CADBIOM INSTALLATION INSTRUCTIONS #
# #
# http://cadbiom.genouest.org/ #
# #
################################################
################################################
# LICENCE #
################################################
CADBIOM is freely available on cadbiom.genouest.org,
distributed under the terms of the
GNU General Public License.
################################################
# INSTALLATION #
################################################
CADBIOM is mainly developed in Python 2.7
(1) Before running Cadbiom, the following
Python packages have to be installed :
- python-pygraphviz
- python-lxml
- python-networkx
- python-gtksourceview2
For Debian / Ubuntu users, you will find them
on the distribution packages library.
(2) Unpack cadbiom.tar.gz
It contains the cadbiom folder with :
- antlr3 (folder)
- bio_models (folder)
- gt_gui (folder)
- models (folder)
- solver_32 (folder)
- solver_64.py (folder)
- cadbiom_des.py (file)
(3) CADBIOM software requires a SAT solver,
according to your distribution, 32 bits and
64 bits versions are proposed.
Add the appropriate folder (solver_32 or solver_64)
to your PYTHONPATH .
If the proposed versions of SAT solver do not work,
sources are available on CADBIOM website.
(4) Run the following command in your shell :
python cadbiom_des.py
################################################
# #
# CADBIOM INSTALLATION INSTRUCTIONS #
# #
# http://cadbiom.genouest.org/ #
# #
################################################
# Installation
CADBIOM is mainly developed in Python 2.7
## System requirements
Before running Cadbiom, the following system packages
have to be installed from the distribution packages library :
* python-gtksourceview2
* python-dev
* libxml2-dev
* libxslt1-dev
* graphviz-dev
## Python requirements
Before running Cadbiom, the following Python packages
have to be installed from pypi repository :
* lxml==3.6.4
* networkx==1.11
* pygraphviz==1.3.1
* pyCryptoMS==0.1
Note: Cadbiom software requires a SAT solver which is
proposed as a Python wrapper by an independant library (pyCryptoMS).
You can install these dependencies with the following command:
make build
or:
python2.7 install -r requirements.txt
## Cadbiom package
Unpack cadbiom.tar.gz;
It contains the cadbiom folder with :
- antlr3 (folder)
- bio_models (folder)
- gt_gui (folder)
- models (folder)
- cadbiom_des.py (file)
- Makefile (file)
- README.md
# Utilization
Run the following command in your shell :
make run
or:
python cadbiom_des.py
# License
CADBIOM is freely available on cadbiom.genouest.org,
distributed under the terms of the
GNU General Public License.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment