Skip to content

Adds migration isntructions for new emio package hierarchy #60

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
HanaeRateau wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Adds migration isntructions for new emio package hierarchy #60

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
17 changes: 16 additions & 1 deletion docs/Developers/migrate-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,22 @@ This document outlines the steps required to migrate your simulation python scri
**If not mentioned here**, your scripts should work without any modification.
:::

## Migrate from v24.12 to v25.12
## Migrate from v25.12 to v26.06

In order to avoid possible conflicts, all the Emio-related Python packages have been moved to the new `emio` package. This means that the use of the `parts`, `utils` packages and `parameters` module is now deprecated. You will have until v26.12 to update your code.

To use them, start from the `emio` package. Also, the `Emio`, `EmioGUI` classes and `getParserArgs` function are now available directly from the `emio` package.

For example:

```python
from emio import Emio, getParserArgs # The Emio class is available directly from the emio package
from emio.parts.controllers.assemblycontroller import AssemblyController # parts modules are available from emio.parts
from emio.utils.header import addHeader, addSolvers # utils modules are now available from emio.utils
import emio.parameters as parameters # parameters module is available from emio
```

## Migrate from v24.12 to v25.06

1. `Sofa.ImGui.getRobotConnection()` has been removed. Use `Sofa.ImGui.getRobotConnectionToggle()` instead.
Corresponding error message: `AttributeError: module 'Sofa.ImGui' has no attribute 'getRobotConnection'`
Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-v25.12/Developers/migrate-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This document outlines the steps required to migrate your simulation python scri
**If not mentioned here**, your scripts should work without any modification.
:::

## Migrate from v24.12 to v25.12
## Migrate from v24.12 to v25.06

1. `Sofa.ImGui.getRobotConnection()` has been removed. Use `Sofa.ImGui.getRobotConnectionToggle()` instead.
Corresponding error message: `AttributeError: module 'Sofa.ImGui' has no attribute 'getRobotConnection'`
Expand Down
Loading