Skip to content

Conversation

@EveCharbie
Copy link
Collaborator

@EveCharbie EveCharbie commented Sep 19, 2025

We displaced all

  • the models into a common folder named examples/models/...
  • all the examples to show features were put in the folder toy_examples/[old folder name]/... (except for the getting_started folder)
  • the not so getting_started examples were put in the folder toy_examples/feature_examples/... and the real getting_started examples were kept in the getting_started/... forder

If you are getting started with bioptim, you should have a look at the folder getting_started, where you will find examples to show you the fundamentals of building an Optimal Control Problem with bioptim.
The first examples you should have a look are:


This change is Reviewable

@EveCharbie EveCharbie changed the title [WIP] Moving examples [RTR] Moving examples Sep 19, 2025
Copy link
Collaborator

@Ipuch Ipuch left a comment

Choose a reason for hiding this comment

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

@Ipuch reviewed 96 of 229 files at r1, 145 of 145 files at r2, all commit messages.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @EveCharbie)


bioptim/examples/getting_started/custom_phase_transitions.py line 209 at r2 (raw file):

def main():
    biorbd_model_path = ExampleUtils.examples_folder() + "/models/cube.bioMod"

.folder

Code quote:

examples_folder()

@codecov
Copy link

codecov bot commented Sep 22, 2025

Codecov Report

❌ Patch coverage is 33.33333% with 126 lines in your changes missing coverage. Please review.
✅ Project coverage is 77.37%. Comparing base (476d88d) to head (6490dd5).
⚠️ Report is 625 commits behind head on master.

Files with missing lines Patch % Lines
...ples/feature_examples/custom_constraint_weights.py 16.12% 52 Missing ⚠️
bioptim/examples/utils.py 63.63% 4 Missing ⚠️
...se_transition_uneven_variable_number_by_mapping.py 25.00% 3 Missing ⚠️
bioptim/examples/getting_started/basic_ocp.py 33.33% 2 Missing ⚠️
...amples/getting_started/custom_phase_transitions.py 33.33% 2 Missing ⚠️
...ioptim/examples/getting_started/custom_plotting.py 33.33% 2 Missing ⚠️
...xamples/getting_started/example_cyclic_movement.py 33.33% 2 Missing ⚠️
...xamples/getting_started/example_external_forces.py 33.33% 2 Missing ⚠️
...tim/examples/getting_started/example_multiphase.py 33.33% 2 Missing ⚠️
bioptim/examples/toy_examples/acados/cube.py 33.33% 2 Missing ⚠️
... and 34 more
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1023      +/-   ##
==========================================
- Coverage   78.62%   77.37%   -1.26%     
==========================================
  Files         159      182      +23     
  Lines       18608    20186    +1578     
==========================================
+ Hits        14631    15618     +987     
- Misses       3977     4568     +591     
Flag Coverage Δ
unittests 77.37% <33.33%> (-1.26%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@EveCharbie
Copy link
Collaborator Author

@pariterre or @Ipuch all tests have passed, I think this could be merged :)

@EveCharbie EveCharbie changed the title [RTR] Moving examples [RTM] Moving examples Sep 23, 2025
@EveCharbie EveCharbie requested a review from Ipuch September 23, 2025 07:08
Copy link
Collaborator Author

@EveCharbie EveCharbie left a comment

Choose a reason for hiding this comment

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

Reviewable status: 98 of 241 files reviewed, 1 unresolved discussion (waiting on @Ipuch)


bioptim/examples/getting_started/custom_phase_transitions.py line 209 at r2 (raw file):

Previously, Ipuch (Pierre Puchaud) wrote…

.folder

Done.

@pariterre pariterre merged commit fd601af into pyomeca:master Sep 25, 2025
21 of 24 checks passed
@Ipuch Ipuch mentioned this pull request Sep 26, 2025
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants