The Higher Education and Research forge

Home My Page Projects Code Snippets Project Openings EMULSION public releases
Summary Activity Surveys SCM Listes Sympa

SCM Repository

index 2bbc592..273ae62 100644 (file)
@@ -16,18 +16,20 @@ System
     the documentation of your shell to adapt the commands below.
 
 Language
-    EMULSION is written in Python3 (version 3.6 or higher). In what
+    EMULSION is written in **Python 3** (version 3.6 or higher). In what
     follows, we assume that ``python3`` and ``pip3`` refer to your
     Python3 installation. If not, replace them by your own
     configuration in the commands below (e.g. with Windows:
     respectively ``python.exe`` and ``pip.exe``).
 
-    To install Python on your system, please consult `Python website <https://www.python.org/downloads/>`_
+    To install Python on your system, please consult
+    `Python website <https://www.python.org/downloads/>`_. When
+    installing on Windows, check the box "Add Python 3.x to PATH" to
+    make python commands available from the terminal.
 
 
-
-Install with ``pip``
-********************
+Install with ``pip`` (recommended)
+**********************************
 
 Linux and MacOS:
 ================
@@ -36,7 +38,7 @@ Linux and MacOS:
 
    sudo pip3 install emulsion
    init_emulsion
-   source $HOME/.basrc
+   source $HOME/.bashrc
 
 Depending on how you installed Python, ``sudo`` is sometimes
 optional.
@@ -44,9 +46,11 @@ optional.
 The second command (``init_emulsion``) initializes command-line
 completion (available with a bash shell, under Linux or MacOS), which allows
 to use ``TAB`` key to get suggestions on what is expected (options,
-files, parameters...) in the command.
+files, parameters...) in the command. It also creates (or modifies)
+the environment variable named ``PYTHONPATH`` to make EMULSION able to
+find code add-ons located in the same directory as your models.
 
-When installing with ``pip``, `documentation <https://sourcesup.renater.fr/emulsion-public>`_
+EMULSION `documentation <https://sourcesup.renater.fr/emulsion-public>`_
 is provided on-line.
 
 Windows
@@ -58,61 +62,28 @@ type:
 .. code-block:: batch
 
    pip.exe install emulsion
-   setx PYTHONPATH "%PYTHONPATH%;."
 
+To make EMULSION able to find code add-ons in the directory where your model
+files are located, you must declare (or modify) an environment
+variable named ``PYTHONPATH`` to add the current directory ("``.``").
 
+To do so, you can use the graphical interface (from System
+Preferences), or the terminal. The syntax depends on the kind of
+terminal you are using:
 
-Install with ``git``
-********************
+  - with the "Command Prompt" (``cmd.exe``), type:
 
-This procedure assumes that you have ``git`` already
-`installed on your system <https://git-scm.com/downloads>`_.
-It is provided here for Linux or MacOS.
+    .. code-block:: batch
 
-#. Install (or update) required packages
+       setx PYTHONPATH ".;%PYTHONPATH%"
 
-   .. code-block:: bash
+  - with "Windows Power Shell", type:
 
-      sudo pip3 install numpy scipy matplotlib pandas 'sympy<1.3' mpmath
-      sudo pip3 install networkx docopt jinja2 textx
-      sudo pip3 install sortedcontainers tqdm pyyaml colorama
-      sudo pip3 install bokeh sqlalchemy utm
+    .. code-block:: batch
 
-#. Clone the EMULSION repository
+       setx PYTHONPATH ".;$Env:PYTHONPATH"
 
-   .. code-block:: bash
 
-      git clone https://git.renater.fr/emulsion-public.git
-      cd emulsion-public
-
-#. Add the local directory and ``src`` directory to your ``PYTHONPATH`` environment
-   variable.
-
-   .. code-block:: bash
-
-      echo "export PYTHONPATH=$(pwd)/src:." >>$HOME/.bashrc
-
-#. Install command-line completion (optional but very convenient).
-
-   .. code-block:: bash
-
-      echo "source $(pwd)/src/emulsion/scripts/emulsion-completion.sh" >>$HOME/.bashrc
-
-   Command-line completion (available with a bash shell, under Linux
-   or MacOS) allows to use ``TAB`` key to get suggestions on what is
-   expected (options, files, parameters...) in the command.
-
-#. Create command ``emulsion``:
-
-   .. code-block:: bash
-
-      echo "alias emulsion='python3 -m emulsion'" >>$HOME/.bashrc
-
-#. Force the shell to update your init file:
-
-   .. code-block:: bash
-
-      source $HOME/.bashrc
 
 
 Install third-party software
@@ -148,9 +119,17 @@ installed the executable files (especially ``dot.exe``).
 For instance, if ``dot.exe`` is located in
 ``C:\Program Files (x86)\Graphviz\bin``, just type:
 
-.. code-block:: batch
+  - in the "Command Prompt":
 
-  setx PATH "%PATH%;C:\Program Files (x86)\Graphviz\bin"
+    .. code-block:: batch
+
+      setx PATH "C:\Program Files (x86)\Graphviz\bin;%PATH%"
+
+  - in "Windows Power Shell":
+
+    .. code-block:: batch
+
+      setx PATH "C:\Program Files (x86)\Graphviz\bin;$Env:PATH"
 
 
 Test your installation
@@ -168,12 +147,12 @@ Extract the archive, open a terminal in the ``models`` directory, then type:
 
 This should produce the following output::
 
-    Simulation level: herd
-    Generated state machine diagram img/Quickstart_age_group_machine.png
-    Generated state machine diagram img/Quickstart_life_cycle_machine.png
-    Generated state machine diagram img/Quickstart_health_state_machine.png
+    Simulation level:herd
+    Generated state machine diagram img/Quickstart_age_group_machine.svg
+    Generated state machine diagram img/Quickstart_life_cycle_machine.svg
+    Generated state machine diagram img/Quickstart_health_state_machine.svg
     100%|*************************************************************| 10/10
-    Simulation finished in 9.48 s
+    Simulation finished in 12.37 s
     Outputs stored in outputs/counts.csv
     Outputs plot in file: img/Quickstart.html
 
@@ -199,3 +178,57 @@ and the following figures should appear in your navigator:
 
 .. image:: ../_images/Quickstart_others.png
    :align: left
+
+
+
+Alternative: install with ``git``
+*********************************
+
+This procedure assumes that you have ``git`` already
+`installed on your system <https://git-scm.com/downloads>`_.
+It is provided here for Linux or MacOS.
+
+#. Install (or update) required packages
+
+   .. code-block:: bash
+
+      sudo pip3 install numpy scipy matplotlib pandas 'sympy==1.1.1' mpmath
+      sudo pip3 install networkx docopt jinja2 textx
+      sudo pip3 install sortedcontainers tqdm pyyaml colorama
+      sudo pip3 install bokeh sqlalchemy utm
+
+#. Clone the EMULSION repository
+
+   .. code-block:: bash
+
+      git clone https://git.renater.fr/emulsion-public.git
+      cd emulsion-public
+
+#. Add the local directory and ``src`` directory to your ``PYTHONPATH`` environment
+   variable.
+
+   .. code-block:: bash
+
+      echo "export PYTHONPATH=$(pwd)/src:." >>$HOME/.bashrc
+
+#. Install command-line completion (optional but very convenient).
+
+   .. code-block:: bash
+
+      echo "source $(pwd)/src/emulsion/scripts/emulsion-completion.sh" >>$HOME/.bashrc
+
+   Command-line completion (available with a bash shell, under Linux
+   or MacOS) allows to use ``TAB`` key to get suggestions on what is
+   expected (options, files, parameters...) in the command.
+
+#. Create command ``emulsion``:
+
+   .. code-block:: bash
+
+      echo "alias emulsion='python3 -m emulsion'" >>$HOME/.bashrc
+
+#. Force the shell to update your init file:
+
+   .. code-block:: bash
+
+      source $HOME/.bashrc