MAJ terminée. Nous sommes passés en version 14.6.2 . Pour consulter les "releases notes" associées c'est ici :

https://about.gitlab.com/releases/2022/01/11/security-release-gitlab-14-6-2-released/
https://about.gitlab.com/releases/2022/01/04/gitlab-14-6-1-released/

Commit 8ca76123 authored by VIGNET Pierre's avatar VIGNET Pierre
Browse files

[doc] Last corrections for installation process

parent c4fbee30
......@@ -43,13 +43,15 @@ However, it should be possible to install the software suite under Microsoft Win
which offers a large collection of GNU and Open Source tools, and provides on Microsoft Windows,
functionalities similar to a GNU/Linux environment.
Except for projects like cygwin, the porting for Microsoft Windows of native Python 2.7 applications
embedding extensions written in at least C++11 and newer is impossible may lead to erratic behavior
of programs and their plugins.
We use a sat solver written in C ++, and except for projects like Cygwin,
the porting on Microsoft Windows of native Python 2.7 applications
embedding extensions written in at least C++11 and newer is impossible in a safe way, because it
may lead to erratic behavior of programs and their plugins.
The explanation finds its origin as much in the version of Python 2.7 today (2018) widely depreciated
and in the version of the compiler used at the time to distribute it,
as in the architecture of the (C) libraries under Windows
as in the architecture of the (C, C++) libraries under Windows
(whose symbols are not versioned like those in libraries under GNU / Linux)
(more information `here on the Microsoft Developer Network (MSDN) blog <https://blogs.msdn.microsoft.com/vcblog/2014/06/10/the-great-c-runtime-crt-refactoring/>`_).
......@@ -57,7 +59,10 @@ as in the architecture of the (C) libraries under Windows
System requirements
-------------------
CADBIOM is mainly developed in Python 2.7. Before running Cadbiom, the following system packages have to be installed from the distribution packages library (or similar, depending on your operating system).
CADBIOM is mainly developed in Python 2.7. This Python environment must be installed on
your computer.
Before running Cadbiom, the following system packages have to be installed from the distribution
packages library (or similar, depending on your operating system).
**Most of these packages are already installed on basic GNU/Linux systems.**
As you will see, **most of the packages are required only by the Cadbiom GUI**,
......@@ -71,7 +76,7 @@ Debian-like systems (Ubuntu)
- libxml2-dev
- libxslt1-dev (Library providing the Gnome XSLT engine)
- pkg-config (Optional, can fix errors when installing pygraphviz and when config is not loaded, see `Troubleshooting <installation.html#troubleshooting>`_ section)
- libgraphviz-dev (GUI layouts)
- libgraphviz-dev (GUI for graph layout algorithms)
- python-gtk2 (GUI)
- python-glade2 (GUI)
- python-gtksourceview2 (GUI)
......@@ -105,65 +110,69 @@ Setting up a virtual environment
--------------------------------
As always, the use of a Python virtual environment
(via `virtualenvwrapper <https://virtualenvwrapper.readthedocs.io/en/latest/>`_) is **strongly advised**.
(via `virtualenvwrapper <https://docs.python-guide.org/dev/virtualenvs/>`_) is **strongly advised**.
This is not a mandatory step but it is a good practice to separate projects from each other.
This is not a mandatory step but it is a good and a **simple** practice to separate projects
from each other in order to avoid conflicts between dependencies.
* Install virtualenvwrapper:
.. code-block:: bash
pip install virtualenvwrapper
$ pip install --user 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:
.. code-block:: bash
export WORKON_HOME=~/.virtualenvs
mkdir -p $WORKON_HOME
# The location of this script may vary depending on your Linux distro.
# See also ~.local/bin/
# Maybe you would better to add this directory to your $PATH variable.
source /usr/bin/virtualenvwrapper.sh
$ export PATH=$PATH:~/.local/bin
$ export WORKON_HOME=~/.virtualenvs
$ mkdir -p $WORKON_HOME
$ # The location of this script may vary depending on your GNU/Linux distro
$ # and depending of your installation procedure with pip.
$ # See ~/.local/bin/ or /usr/bin
$ source ~/.local/bin/virtualenvwrapper.sh
* Restart your terminal or run:
.. code-block:: bash
source ~/.bashrc
$ source ~/.bashrc
* Create your virtualenv:
.. code-block:: bash
mkvirtualenv cadbiom -p /usr/bin/python2.7
$ mkvirtualenv cadbiom -p /usr/bin/python2.7
* Later if you want to work in the virtualenv:
* Later, if you want to work in the virtualenv:
.. code-block:: bash
workon cadbiom
$ workon cadbiom
Installation
------------
Install the released version
----------------------------
Cadbiom package is available on PyPI (Python Package Index), the official third-party
Cadbiom packages are available on PyPI (Python Package Index), the official third-party
software repository for Python language.
* `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:
You can install these packages with the following command on all systems with a Python environment with ``pip``:
.. code-block:: bash
pip install cadbiom-cmd cadbiom-gui
$ pip install cadbiom-cmd cadbiom-gui
.. note:: Don't forget to add the flag ``--user`` to the command above if you don't use
virtual environment or if you do not have root privileges on your system.
.. note:: The package of the library itself (``cadbiom``) is automatically installed as a dependency
when the gui or the command line is installed via pip.
.. note:: The package of the library itself (``cadbiom``) is automatically installed
as a dependency when the gui or the command line is installed via pip.
At this point 2 commands are available in your shell:
......@@ -172,43 +181,64 @@ At this point 2 commands are available in your shell:
- ``cadbiom_cmd``: Launch the command line program.
For developers
--------------
Install the development version
-------------------------------
Install from sources
~~~~~~~~~~~~~~~~~~~~
If you want to install from the sources, the library with its GUI and command line,
just do:
If you have Git installed on your system, it is also possible to install the development
version of Cadbiom.
Before installing the development version, you may need to uninstall the standard version
of Cadbiom using ``pip``:
.. code-block:: bash
git clone https://gitlab.inria.fr/pvignet/cadbiom
$ pip uninstall cadbiom cadbiom-gui cadbiom-cmd
and then:
Then do:
.. code-block:: bash
make install
$ git clone https://gitlab.inria.fr/pvignet/cadbiom
$ cd cadbiom
$ make dev_install
If you want to make changes in the code without having to reinstall the packages,
it is **strongly advised** to use the following command:
The ``make dev_install`` command uses ``pip install -e .[dev]`` command which allows
you to follow the development branch as it changes by creating links in the right places
and installing the command line scripts to the appropriate locations.
Please note that your changes in the code are directly usable without having to reinstall the packages.
Then, if you want to update Cadbiom at any time, in the same directory do:
.. code-block:: bash
make dev_install
$ git pull
Uninstall
~~~~~~~~~
Depending on the installation method you have chosen in the previous chapter:
Just do:
.. code-block:: bash
$ make dev_uninstall
Testing
~~~~~~~
Cadbiom uses the Python `pytest <https://pytest.org/>`_ testing package.
You can test the packages from the source directory with:
.. code-block:: bash
make uninstall
# or
make dev_uninstall
$ make unit_tests
Very outdated release (archived)
......
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