Skip to content

[doc] Fix links in FirstSteps #526

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

Merged
bakpaul merged 2 commits into from
Jul 24, 2025
Merged

[doc] Fix links in FirstSteps #526

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4c97f29
[doc] Fix links in FirstSteps
hugtalbot Jul 24, 2025
bc47326
help readibility
hugtalbot Jul 24, 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
4 changes: 2 additions & 2 deletions docs/sphinx/source/content/FirstSteps.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ With runSofa
* open runSofa without any argument once and then add libSofaPython3 in the plugin manager
* or add -l SofaPython3 in this command line.

For more information, please refer to the documentation: `What is a plugin > Plugin loading<https://sofa-framework.github.io/doc/plugins/what-is-a-plugin/#plugin_loading>`_
For more information, please refer to the documentation: `Plugin loading <https://sofa-framework.github.io/doc/plugins/what-is-a-plugin/#plugin_loading>`_.

Once the SofaPython3 plugin is loaded, you can load a simulation from a python script directly in runSofa.
Assuming you want to run a script named "example.py", you can run the following command:
Expand All @@ -32,7 +32,7 @@ With the python3 interpreter
SOFA simulation can also be executed from a python environment (including jupyter notebook).
To do so, the Python environment must be filled in for SOFA python modules.
Located in *site-packages/* repositories, the path to these libraries should be added to the ``PYTHONPATH``.
The section "`Setup your python3 environment <https://sofapython3.readthedocs.io/en/latest/content/Installation.html#using-python3>`_" section details how to configure it.
The Installation section details the `requirements to execute a simulation withing a python3 interpreter <https://sofapython3.readthedocs.io/en/latest/content/Installation.html#using-python3>`_" section details how to configure it.

Once your python environment is properly configured, you will be able to import SOFA python modules (e.g. ``import Sofa``).
By running your simulation from a python interpreter, you will be responsible for:
Expand Down
6 changes: 3 additions & 3 deletions docs/sphinx/source/content/Installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ Before running your simulations, you must make sure to define the following envi
After that, all you need to do is open a Console (cmd.exe) and run: ``runSofa -lSofaPython3``


It must be noted that depending on the plugins you use, you might have to add the *site-packages/* paths associated to these plugins to your ``PYTHONPATH``.
⚠️ It must be noted that depending on the plugins you use, you might have to add the *site-packages/* paths associated to these plugins to your ``PYTHONPATH``.
These are usually located in */path_to_plugin/lib/python3/site-packages*.

To discover, how to use SOFA in any python3 interpreter, please refer to the associated `FirstSteps section <https://sofapython3.readthedocs.io/en/latest/content/FirstSteps.html#with-the-python3-interpreter>`_
Expand All @@ -139,6 +139,6 @@ To discover, how to use SOFA in any python3 interpreter, please refer to the ass
Get support
***********

To freely get technical assistance from the community, please do not hesitate to join the `SofaPython3 GitHub forum <https://github.com/sofa-framework/sofapython3/discussions>`_ and post there any question related to SofaPython3.
🙋 To freely get technical assistance from the community, please do not hesitate to join the `SofaPython3 GitHub forum <https://github.com/sofa-framework/sofapython3/discussions>`_ and post there any question related to SofaPython3.

To quickly level up on SOFA, never hesitate to request `SOFA training sessions <https://www.sofa-framework.org/sofa-events/sofa-training-sessions/>`_.
👨‍🏫 To quickly level up on SOFA, never hesitate to request `SOFA training sessions <https://www.sofa-framework.org/sofa-events/sofa-training-sessions/>`_.
Loading