Implementing musculoskeletal model driven by FES

[Kev1CO]

All Submissions:

• Have you followed the guidelines in our Contributing document [docs/contribution.md]?
• Have you checked to ensure there aren't other open [Pull Requests] for the same update/change?
• Have you opened/linked the issue related to your pull request?
• Have you used the tag [WIP] for ongoing changes, and removed it when the pull request was ready?
• When ready to merge, have you sent a comment pinging @Kev1CO in it?

New Feature Submissions:

1. Does your submission pass the tests (if not please explain why this is intended)?
2. Did you write a proper documentation (docstrings and ReadMe)
3. Have you linted your code locally prior to submission (using the command: black . -l120 --exclude "external/*")?

Changes to Core Features:

• Have you added an explanation of what your changes do and why you'd like us to include them?
• Have you written new examples for your core changes, as applicable?
• Have you written new tests for your core changes, as applicable?

---

This change is 

[Kev1CO]

cocofest/__init__.py line 12 at r1 (raw file):

from .optimization.fes_ocp import OcpFes
from .optimization.fes_identification_ocp import OcpFesId
from .optimization.fes_ocp_dynamics import FESActuatedBiorbdModelOCP

OcpFesMsk ?

[Kev1CO]

cocofest/__init__.py line 8 at r1 (raw file):

from .models.hmed2018 import DingModelIntensityFrequency
from .models.hmed2018_with_fatigue import DingModelIntensityFrequencyWithFatigue
from .models.dynamical_model import FESActuatedBiorbdModel

Not the perfect name

[codecov]

Codecov Report

Attention: 61 lines in your changes are missing coverage. Please review.

Comparison is base (4c187c2) 79.08% compared to head (bc81f3c) 87.37%.
Report is 2 commits behind head on main.

Files	Patch %	Lines
cocofest/optimization/fes_ocp_dynamics.py	85.97%	38 Missing ⚠️
cocofest/models/dynamical_model.py	87.87%	16 Missing ⚠️
cocofest/custom_objectives.py	40.00%	6 Missing ⚠️
cocofest/models/ding2003.py	95.45%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #52      +/-   ##
==========================================
+ Coverage   79.08%   87.37%   +8.29%     
==========================================
  Files          17       17              
  Lines        1659     1909     +250     
==========================================
+ Hits         1312     1668     +356     
+ Misses        347      241     -106     

Flag	Coverage Δ
unittests	87.37% <88.68%> (+8.29%)	⬆️

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.

[Kev1CO]

cocofest/custom_objectives.py line 86 at r1 (raw file):

        Returns
        -------
        The difference between the two keys

modify docstring

[Kev1CO]

cocofest/models/ding2003.py line 129 at r1 (raw file):

        Returns
        -------
        The value of the derivative of each state dx/dt at the current time t

modify docstring

[Kev1CO]

need tests on new dynamical model before merge

[Kev1CO]

done

Reviewable status: 0 of 59 files reviewed, all discussions resolved

---

cocofest/__init__.py line 8 at r1 (raw file):

Previously, Kev1CO wrote…

Not the perfect name

done

---

cocofest/__init__.py line 12 at r1 (raw file):

Previously, Kev1CO wrote…

OcpFesMsk ?

done

[Kev1CO]

Reviewed 4 of 40 files at r1, 3 of 19 files at r2, 46 of 50 files at r3, 6 of 6 files at r4, all commit messages.
Reviewable status: complete! all files reviewed, all discussions resolved (waiting on @Kev1CO)

[Kev1CO]

[Kev1CO]

Make updated readme
remove read_data and multistart

[Kev1CO]

Reviewed 16 of 19 files at r5, 14 of 14 files at r6, all commit messages.
Reviewable status: complete! all files reviewed, all discussions resolved (waiting on @Kev1CO)