Skip to content

Use SOFA_ROOT naming convention everywhere in the docs #538

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

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Use SOFA_ROOT naming convention everywhere in the docs #538

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3155d8f
Use SOFA_ROOT naming convention everywhere in the docs
Sep 17, 2025
0c164c8
add simple comment
Sep 17, 2025
ab8cb22
Update docs/sphinx/source/content/Installation.rst
bakpaul Oct 2, 2025
1fc8134
Update docs/sphinx/source/content/Installation.rst
bakpaul Oct 2, 2025
719a3ac
Merge branch 'master' into doc-ubuntu-runSofa
bakpaul Oct 2, 2025
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
10 changes: 6 additions & 4 deletions docs/sphinx/source/content/Installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,12 +75,14 @@ Setup your environment
using runSofa
*************

Using SofaPython3 in runSofa requires loading the SofaPython3 plugin in your runSofa environment. If you downloaded and installed SOFA from the SOFA website (as explained above, see :ref:`getsofapython3`), you can load the SofaPython3 plugin using the PluginManager (in the GUI) or by auto-loading the plugin in runSofa: simply copy the file **plugin_list.conf.default** in *<SOFA_build>/lib*, and rename it **plugin_list.conf**, then add the line:
Using SofaPython3 in runSofa requires loading the SofaPython3 plugin in your runSofa environment. If you downloaded and installed SOFA from the SOFA website (as explained above, see :ref:`getsofapython3`), you can load the SofaPython3 plugin using the PluginManager (in the GUI) or by auto-loading the plugin in runSofa run the following script:
simply copy the file **plugin_list.conf.default** in *<SOFA_build>/lib*, and rename it **plugin_list.conf**, then add the line "SofaPython3 NO_VERSION" can be done like this:

.. code-block:: text

SofaPython3 NO_VERSION

cd <SOFA_ROOT>/build/v25.06/
Copy link
Contributor

@bakpaul bakpaul Oct 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
cd <SOFA_ROOT>/build/v25.06/
cd <SOFA_ROOT>

Copy link
Author

@emmanuelHa emmanuelHa Oct 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I let the v25.06 to be able to deal with different version of SOFA up to you.

cp lib/plugin_list.conf.default lib/plugin_list.conf.default.back
mv lib/plugin_list.conf.default lib/plugin_list.conf
{ echo "SofaPython3 NO_VERSION"; cat lib/plugin_list.conf; } > temp && mv temp lib/plugin_list.conf
..
Note that adding the line to the file **plugin_list.conf.default** in *<SOFA_build>/lib* would work, but you would need to add the line everytime you compile the code.

Expand Down
Loading