Skip to content

Commit

Permalink
Documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
lebarsfa committed Mar 6, 2024
1 parent 2acc5f5 commit c42ff66
Show file tree
Hide file tree
Showing 6 changed files with 30 additions and 19 deletions.
2 changes: 1 addition & 1 deletion doc/doc/install/01-installation-full-linux.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Then, check your installation `with the instructions of this page <03-start-cpp-
.. note::

For a Raspberry Pi running Raspbian Buster, download and extract ``codac_standalone_armv6hf_buster.zip`` from `<https://github.com/codac-team/codac/releases/latest/>`_, then in the ``example`` folder run:
For a Raspberry Pi running Raspbian Buster 32 bit, download and extract ``codac_standalone_armv6hf_buster.zip`` from `<https://github.com/codac-team/codac/releases/latest/>`_, then in the ``example`` folder run:

.. code-block:: bash
Expand Down
17 changes: 13 additions & 4 deletions doc/doc/install/01-installation-full-macos.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,32 +10,41 @@ Installing Codac on macOS for C++ use
Quick start
-----------

Install Homebrew package manager and build tools:
Install `Homebrew package manager <https://brew.sh/>`_ and build tools:

.. code-block:: bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
brew install wget autoconf automake libtool
brew install --cask cmake
Download and extract *e.g.* ``codac_standalone_x86_64_bigsur.zip`` (for macOS 11 Big Sur (x86_64)) from `<https://github.com/codac-team/codac/releases/latest/>`_, then in ``example`` folder run:
Download and extract *e.g.* ``codac_standalone_arm64_monterey.zip`` (for macOS 12 Monterey on a Mac with Apple silicon (arm64 processor), use ``codac_standalone_x86_64_monterey.zip`` for a Mac with an Intel processor (x86_64 processor), see https://support.apple.com/en-us/116943) from `<https://github.com/codac-team/codac/releases/latest/>`_, then in ``example`` folder run:

.. code-block:: bash
cmake . ; cmake --build . ; ./my_project
and check that "My first tube:Tube [0, 10]" appears.

Optionally, download and run `<https://github.com/ENSTABretagneRobotics/VIBES/releases/download/0.2.3/VIBes-0.2.2-osx.dmg>`_ (see also https://support.apple.com/HT211861) before running the project, and check that a tube appears in VIBes window.
Optionally, download and run `<https://github.com/ENSTABretagneRobotics/VIBES/releases/download/0.2.3/VIBes-0.2.2-osx.dmg>`_ (see also https://support.apple.com/HT211861) before running the project, and check that a tube appears in :ref:`VIBes viewer <sec-installation-graphics>`.


Building from sources
---------------------

You will probably need to install those prerequisites (assuming you installed `Homebrew package manager <https://brew.sh/>`_):
You will probably need to install those prerequisites:

.. code-block:: bash
brew install eigen
Optionally, for Python and documentation:

.. code-block:: bash
wget https://github.com/Homebrew/homebrew-core/raw/d2267b9f2ad247bc9c8273eb755b39566a474a70/Formula/doxygen.rb ; brew reinstall ./doxygen.rb ; brew pin doxygen
brew install graphviz
python -m pip install --upgrade pip
pip install --upgrade wheel setuptools sphinx breathe sphinx-issues sphinx-tabs sphinx_rtd_theme sphinx-reredirects
The logic to follow will then be similar to `Linux <01-installation-full-linux.html>`_. See also `Information for developers </dev/info_dev.html>`_.
17 changes: 7 additions & 10 deletions doc/doc/install/01-installation-full-windows.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ Check https://community.chocolatey.org/packages/codac.

.. rubric:: Using Visual Studio

Download and extract *e.g.* ``codac_standalone_x64_vc16.zip`` (for Visual Studio 2019) from `<https://github.com/codac-team/codac/releases/latest/>`_, open ``example\CMakelists.txt``, choose ``x64-Release`` configuration in Visual Studio (instead of ``x64-Debug``), double-click on ``main.cpp`` in the Solution Explorer and then click on the green Start button, finally check that "My first tube:Tube [0, 10]" appears.
Download and extract *e.g.* ``codac_standalone_x64_vc17.zip`` (for Visual Studio 2022) from `<https://github.com/codac-team/codac/releases/latest/>`_, open ``example\CMakelists.txt``, choose ``x64-Release`` configuration in Visual Studio (instead of ``x64-Debug``), double-click on ``main.cpp`` in the Solution Explorer and then click on the green Start button, finally check that "My first tube:Tube [0, 10]" appears.

Optionally, download and run `<https://github.com/ENSTABretagneRobotics/VIBES/releases/download/0.2.3/VIBes-0.2.3-win32.exe>`_ before running the project, and check that a tube appears in VIBes window.
Optionally, download and run `<https://github.com/ENSTABretagneRobotics/VIBES/releases/download/0.2.3/VIBes-0.2.3-win32.exe>`_ before running the project, and check that a tube appears in :ref:`VIBes viewer <sec-installation-graphics>`.


Building from sources
Expand All @@ -32,19 +32,16 @@ You will probably need to install these prerequisites (assuming you installed `C
choco install cmake git make patch winflexbison
choco install eigen
Then, install the desired compiler (*e.g.* ``choco install mingw --version=8.1.0``).
Then, install the desired compiler (*e.g.* ``choco install mingw --version=11.2.0.07112021``).

Optionally, for Python (*e.g.* ``choco install python --version=3.8.2``) and documentation:
Optionally, for Python (*e.g.* ``choco install python --version=3.10.4``) and documentation:

.. code-block:: bat
choco install doxygen.install graphviz
choco install doxygen.install --version=1.9.6
choco install graphviz
python -m pip install --upgrade pip
pip install --upgrade wheel setuptools
git clone --depth 1 -b v3.1.1 https://github.com/sphinx-doc/sphinx
cd sphinx
pip install .
pip install --upgrade breathe sphinx-issues sphinx-tabs sphinx_rtd_theme sphinx-reredirects
pip install --upgrade wheel setuptools sphinx breathe sphinx-issues sphinx-tabs sphinx_rtd_theme sphinx-reredirects
The logic to follow will then be similar to `Linux <01-installation-full-linux.html>`_ (note that for Visual Studio, commands such as ``make install`` need to be replaced with something similar to:

Expand Down
3 changes: 1 addition & 2 deletions doc/doc/install/02-start-py-project.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@ Start a Python project
| You are using C++?
| :ref:`sec-start-cpp-project`
| Codac is ready to be used on your computer.
| You can now import the ``codac`` package and start using it:
| Assuming :ref:`Codac Python package is installed <sec-installation-py>`, you can import the ``codac`` package and start using it:
.. code-block:: py
Expand Down
3 changes: 1 addition & 2 deletions doc/doc/install/03-start-cpp-project.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@ Start a C++ project
| You are using Python?
| :ref:`sec-start-py-project`
| Codac is ready to be used on your computer.
| You can now copy-paste the following example code in a file named :file:`main.cpp`:
| Assuming :ref:`Codac library is installed <sec-installation>`, you can copy-paste the following example code in a file named :file:`main.cpp`:
.. code-block:: c++

Expand Down
7 changes: 7 additions & 0 deletions doc/doc/install/04-start-matlab-project.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,10 @@ In order to visualize the tube, you need to launch before the :ref:`VIBes viewer
If everything is well installed on your computer, you should see the following window appear:

.. Figure:: img/helloworld.png

.. warning::

Octave support is more limited than MATLAB at the moment (and only briefly tested on Ubuntu 22.04 for now). `Pythonic <https://gitlab.com/gnu-octave/octave-pythonic>`_ needs to be installed to be able to call Python code from Octave. It has currently some limitations (see https://wiki.octave.org/Pythonic) such as:

* Missing `import` command. https://gist.github.com/lebarsfa/ebc19b143df77753842f920b4b680b84#file-import-m can be loaded in Octave as a workaround.
* Operators such as `+`, `-`, `*`, `/`, `==`, `!=`, etc. do not seem overloaded (see https://gitlab.com/gnu-octave/octave-pythonic/-/issues/129, note that these operators are supported by MATLAB, but some others might not be supported by MATLAB either, see the bottom of https://fr.mathworks.com/help/matlab/matlab_external/differences-between-matlab-python.html). The internal methods `__add__()`, `__sub__()`, `__neg__()`, `__mul__()`, `__truediv__()`, `__eq__()`, `__ne__()`, etc. can be used instead.

0 comments on commit c42ff66

Please sign in to comment.