diff --git a/doc/source/img/software/ohmpi_2024_architecture.png b/doc/source/img/software/ohmpi_2024_architecture.png new file mode 100644 index 0000000000000000000000000000000000000000..32cb790f192f6ddf2d978643a2fc7648497939d2 Binary files /dev/null and b/doc/source/img/software/ohmpi_2024_architecture.png differ diff --git a/doc/source/source_rst/software/architecture.rst b/doc/source/source_rst/software/architecture.rst index ca25b7f618c4f2f65159f5e27ae842e6f7710e60..36e5d323e8e2f9fce40fdec058399dd3cdd735d2 100644 --- a/doc/source/source_rst/software/architecture.rst +++ b/doc/source/source_rst/software/architecture.rst @@ -5,7 +5,7 @@ The OhmPi V2024 software has been completely re-structured to enable increased f functionalities used to interact with the OhmPi instrument via a web interface, IoT communication protocols (e.g. MQTT) and/or directly through the Python API. -.. figure:: ../../img/architecture.png +.. figure:: ../../img/software/ohmpi_2024_architecture.png Software architecture of OhmPi V2024. diff --git a/doc/source/source_rst/software/installation.rst b/doc/source/source_rst/software/installation.rst index 0052606f9cf10fe97dd35241e9d660bb45bbf434..95c1f5bc802d4834c4726ba05f1e80994674b4d0 100644 --- a/doc/source/source_rst/software/installation.rst +++ b/doc/source/source_rst/software/installation.rst @@ -1,12 +1,24 @@ -Installation +Getting started ************ -Step 1: Connect to the Raspberry Pi -=================================== +Step 1: Set up the Raspberry Pi +================================== +First, install an operating system on the Raspberry Pi by following the official instructions_. +.. _instructions` : https://www.raspberrypi.com/documentation/computers/getting-started.html#install-an-operating-system + +Then connect to the Raspberry Pi either via ssh or using an external monitor. + +For all questions related to Raspberry Pi operations, please refer to the official documentation_. +.. _documentation: https://www.raspberrypi.com/documentation/ Step 2: Clone the OhmPi project =============================== +You need to clone the OhmPi repository on the Raspberry Pi with the following command: +.. code-block:: bash + + $ git clone https://gitlab.irstea.fr/reversaal/OhmPi.git + Step 3: Run the installation script =================================== @@ -46,4 +58,6 @@ If you need to leave the virtual environment, simply type: .. code-block:: bash - $ deactivate \ No newline at end of file + $ deactivate + +Following these steps, you are now ready to operate the OhmPi. \ No newline at end of file