Skip to content

Commit

Permalink
Update installation.rst
Browse files Browse the repository at this point in the history
Details on how to install full features of do_mpc
  • Loading branch information
4flixt committed Sep 11, 2023
1 parent 1b390c5 commit 25279c5
Showing 1 changed file with 39 additions and 14 deletions.
53 changes: 39 additions & 14 deletions documentation/source/installation.rst
Expand Up @@ -18,38 +18,55 @@ Requirements

Option 1: **PIP**
*****************
Simply use **PIP** and install **do-mpc** from the terminal.
This has the advantage that **do-mpc** is always in your Python path
and can be used throughout your projects.

1. Install **do-mpc**:
1. Installation

::
- Installation of core features:

pip install do-mpc
.. code-block:: shell
Tested on Windows and Linux (Ubuntu 19.04).
pip install do_mpc
- Installation of additional features:

.. code-block:: shell
pip install do-mpc[full]
- Depending on your operating system you might have to execute the following to install the full version:

.. code-block:: shell
pip install 'do-mpc[full]'
**PIP** will also
take care of dependencies and you are immediately ready to go.
take care of dependencies and you are immediately ready to go. We usually recommend to install first the core features
and only install the full version if the additional features are required.

Use this option if you plan to use **do-mpc** without altering the source code,
e.g. write extensions.

2. Get example documents:

All resources can be obtained from our `release notes`_ page.
Please find the example files that match your currently installed **do-mpc** version
in the respective section.
To get started, we recommend to download the provided examples from our `Github repository`_.
These example files might change with different versions of ``do_mpc`` and we try to bundle the respective examples with each release.
Check our `release notes`_ page and find the example files that match your currently installed **do-mpc** version.

You can check the installed version by importing ``do_mpc`` and typing:

.. code-block:: python
print(do_mpc.__version__)
.. _`release notes`: release_notes.html
.. _`Github repository`: https://github.com/do-mpc/do-mpc/tree/master/examples

Option 2: **Clone from Github**
*******************************
More experienced users are advised to clone or fork the most recent version of **do-mpc**
from `GitHub <https://github.com/do-mpc/do-mpc>`_:

::
.. code-block:: shell
git clone https://github.com/do-mpc/do-mpc.git
Expand Down Expand Up @@ -77,6 +94,14 @@ When installing CasADi via PIP or Anaconda
you obtain the pre-compiled CasADi package.
To use MA27 (or other HSL solver in this setup) please follow these steps:

Windows
^^^^^^^

We recommend using Windows Subsystem for Linux (`WSL`_). Follow the instructions for Linux after you have entered the Linux shell.

_`WSL`: https://learn.microsoft.com/en-us/windows/wsl/install


Linux
^^^^^
(Tested on Ubuntu 19.10)
Expand Down

0 comments on commit 25279c5

Please sign in to comment.