Installation
============

Installing Python
-----------------

To install |rameau|, a working version of Python 3.8 or higher has to be
installed on your computer. You are free to install any Python IDE distribution
you want.

Installing |rameau|
-------------------

The easiest way is to use the Python Package Index (PyPI), where many official
python packages are gathered. To get the latest version of rameau, open the
Anaconda Prompt, a Windows Command Prompt (also called command window) or a
Linux terminal and type:

.. code-block:: bash

    pip install rameau

Update |rameau|
---------------

If you have already installed rameau, it is possible to update
|rameau| easily. To update, open a Anaconda/Windows command prompt or a Linux
terminal and type:

.. code-block:: bash

    pip install --upgrade rameau

Required dependencies
---------------------

|rameau| depends on a number of Python packages which are automatically
installed when using the package manager `pip`. The following packages
are necessary for installing |rameau|:

* `numpy <https://numpy.org>`_
* `pandas <https://pandas.pydata.org>`_

Other optional, but recommended dependencies include:

* `jupyter <https://jupyter.org/>`_ for running notebooks
* `matplotlib <https://matplotlib.org>`_ for plotting results