Commit 83fd25b6 authored by VIGNET Pierre's avatar VIGNET Pierre
Browse files

Update README

parent ad6ec52b
......@@ -61,7 +61,7 @@ You can install these dependencies with the following command:
## Python requirements
When `cadbiom` library is installed, the following Python packages
**are automatically** installed from pypi repository:
**are automatically** installed from PyPI repository:
* lxml
* networkx
......@@ -72,15 +72,19 @@ When `cadbiom` library is installed, the following Python packages
### Virtual environment
As always, the use of a Python virtual environment
(via [virtualenvwrapper](https://virtualenvwrapper.readthedocs.io/en/latest/)) is **strongly advised**.
This is not a mandatory step but it is a good practice to use virtual environments
to separate projects from each other.
* Install virtualenvwrapper:
pip install virtualenvwrapper
* Edit your `.bashrc` or `.zshrc` file to source the `virtualenvwrapper.sh` script with these lines:
* Edit your .bashrc or .zshrc file to source the virtualenvwrapper.sh script with these lines:
export WORKON_HOME=~/.virtualenvs
mkdir -p $WORKON_HOME
......@@ -91,16 +95,17 @@ The location of this script may vary depending on your Linux distro
* Restart your terminal or run:
source /usr/bin/virtualenvwrapper.sh
source /usr/bin/virtualenvwrapper.sh
* Create your virtualenv:
mkvirtualenv cadbiom -p /usr/bin/python2.7
mkvirtualenv cadbiom -p /usr/bin/python2.7
* Later if you want to reactivate the virtualenv:
workon cadbiom
......@@ -108,13 +113,15 @@ The location of this script may vary depending on your Linux distro
Cadbiom software requires a SAT solver which is
proposed as a Python wrapper by an independant library (pycryptosat).
**This package is automatically installed as a dependency of the Cadbiom library.**
*For now, an non official version of pycryptosat is on pypi and it is used by packages;
For now, we maintain and use a non official version of pycryptosat which is compatible
with PyPI (by design, the original software can not and will not be distributed like this).
Source of the fork if you want to compile it manually:
Here you will find the fork if you want to compile it manually:
[Cryptominisat repository](https://gitlab.inria.fr/pvignet/pycryptosat/tree/5.0.1_cmake_dev)*
Here you will find the installation commands of the pycryptosat package:
And here are the installation commands to compile the pycryptosat package from our sources:
git clone --branch 5.0.1_cmake_dev git@gitlab.irisa.fr:0000B8EG/pycryptosat.git
cd pycryptosat
......@@ -124,59 +131,54 @@ Here you will find the installation commands of the pycryptosat package:
### Cadbiom
If you want to install from pypi, just do:
pip install cadbiom-cmd
pip install cadbiom-gui
If you want to install the library with its GUI, and command line in one command,
after the git clone step, just do:
make install
---
For the library itself:
* From Python Package Index:
pip install cadbiom_cmd
* From the current repository
cd library && make install
Cadbiom package is available on PyPI (Python Package Index), the official third-party
software repository for Python language.
For the command line tool:
* [Library](https://pypi.python.org/pypi/cadbiom>)
* [Command line](https://pypi.python.org/pypi/cadbiom-cmd>)
* [GUI](https://pypi.python.org/pypi/cadbiom-gui)
You can install these packages with the following command on all systems that run Python interpreter:
* From Python Package Index:
pip install cadbiom-cmd cadbiom-gui
pip install cadbiom_cmd
The package of the library itself (`cadbiom`) is automatically installed as a dependency
when the gui or the command line is installed via pip.
* From the current repository
#### For developers
cd library && make install
cd ../command_line && make install
If you want to install from the sources, the library with its GUI and command line,
just do:
```bash
git clone https://gitlab.inria.fr/pvignet/cadbiom
```
For the GUI:
and then:
* From Python Package Index:
```bash
make install
```
pip install cadbiom_gui
If you want to make changes in the code without having to reinstall the packages,
it is **strongly advised** to use the following command:
```bash
make dev_install
```
* From the current repository
#### Uninstall
cd library && make install
cd ../gui && make install
Depending on the installation method you have chosen in the previous chapter:
```bash
make uninstall
# or
make dev_uninstall
```
# Structure of packages
#### Structure of packages
The library contains the cadbiom folder with 4 modules:
......@@ -189,7 +191,7 @@ The command line tool exposes the command `cadbiom_cmd` to the current context.
The gui package exposes the command `cadbiom` to the current context.
# Utilization
# Use
## Command line
......
Supports Markdown
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