website/install.md

   1 # How to install NEPI
   2
   3 ## Quick install
   4
   5 The recommended way is to pull NEPI from the [python package index archive](pypi.python.org) using `pip`.
   6
   7     sudo pip install nepi
   8
   9 Most likely this is all you need to do to run simple scripts from the tutorials.
  10
  11 Alternatively, you may specify a specific version number, e.g.:
  12
  13     sudo pip install nepi==6.0.4
  14
  15
  16 ## Getting `pip`
  17
  18 If you receive `command not found` when invoking `pip`, you will need to install this utility. Depending on your linux distribution, you can use
  19
  20 * Fedora / RedHat / CentOS
  21
  22     `sudo yum install python-pip`
  23
  24 * Debian - ubuntu
  25
  26     `sudo apt-get install python-pip`
  27
  28 ## python2 *vs* python3
  29
  30 If you want to use python3, depending on how your system is configured, you might need to invoke
  31
  32     sudo pip3 install nepi
  33
  34 and to `yum` or `apt-get` the `python3-pip` package instead.
  35
  36 ## More dependencies
  37
  38 The following optional packages can be useful in some setups, but are not automatically pulled by `pip` because of their size and/or because they require additional binary tools in turn:
  39
  40 * `sudo pip install matplotlib`
  41 * `sudo pip install pygraphviz`
  42
  43 Of course, here again you might wish to use `pip3` instead.
  44
  45 # Installing from sources
  46
  47 *Alternative* approaches, more suitable to developers, are as follows. This is **not the recommended approach** though:
  48
  49 ## Install for all users
  50
  51     git clone git://git.onelab.eu/nepi.git
  52     cd nepi
  53     sudo make install
  54
  55 ## Use NEPI without installing:
  56
  57     git clone git://git.onelab.eu/nepi.git
  58     cd nepi
  59     export PYTHONPATH=$(pwd)
  60     cd somewhere_else
  61     python3 your-script.nepi
  62
  63
  64 # Older sheet
  65 You can also see the [original installation sheet for NEPI 3](http://nepi.inria.fr/Install/WebHome)