Skip to content

Commit

Permalink
Doxygen documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
adkoele committed Dec 9, 2024
1 parent 5e3d50a commit d1fb710
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 45 deletions.
39 changes: 0 additions & 39 deletions .github/workflows/main

This file was deleted.

6 changes: 3 additions & 3 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,14 @@ jobs:
uses: mattnotmitt/[email protected]
with:
# Path to Doxyfile
doxyfile-path: "./Doxyfile" # default is ./Doxyfile
doxyfile-path: "./docs/Doxygen/Doxyfile" # default is ./Doxyfile
# Working directory
working-directory: "." # default is .
working-directory: "./docs/Doxygen" # default is .

- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
# Default Doxyfile build documentation to html directory.
# Change the directory if changes in Doxyfile
publish_dir: ./html
publish_dir: ./docs/Doxygen/html
6 changes: 3 additions & 3 deletions paper.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 'Biomech-Sim-Toolbox: A MATLAB toolbox for human movement simulation and analysis'
title: 'BioMAC-Sim-Toolbox: A MATLAB toolbox for human movement simulation and analysis'
tags:
- MATLAB
- Biomechanics
Expand Down Expand Up @@ -57,7 +57,7 @@ On the one hand, we can use so-called predictive simulations [@ackermann:2010; @
On the other hand, we can use so-called reconstructive simulations to estimate variables that cannot or were not measured directly by minimizing a data tracking error [@dorschky:2019a;@nitschke:2023;@nitschke:2024]. Such wide-spread measurements and their biomechanical analysis are vital to be able to
reach this understanding of human movement.

Here, we present `Biomech-Sim-Toolbox`, a MATLAB toolbox that can be used to create simulations of human movement
Here, we present `BioMAC-Sim-Toolbox`, a MATLAB toolbox that can be used to create simulations of human movement
and analyse human movements. The main functionality of the toolbox is that it solves trajectory optimization problems, or optimal control problems, for human musculoskeletal dynamics models. These dynamics models combine multibody
dynamics to model the movements of the skeleton with muscle dynamics models to model the dynamics of muscular
contraction and activation. In the trajectory optimization problem, the muscle stimulations are found that minimize an objective. This objective generally includes terms to minimize muscular effort and to minimize a tracking error
Expand Down Expand Up @@ -138,7 +138,7 @@ Figure sizes can be customized by adding an optional second parameter:

# Acknowledgements

We acknowledge contributions from Marko Ackermann, Dieter Heinrich, Maria Eleni Athanasiadou, Chuyi Wang, Christopher Löffelmann, Linus Hötzel, Utkarsha Shukla, Tobias Luckfiel, Heiko Schlarb. The development of the Biomech-Sim-Toolbox was supported by adidas AG and by the Deutsche Forschungsgemeinschaft (DFG, German Research Foundation) through Project-ID442419336, SFB 1483 - EmpkinS and through Project-ID520189992
We acknowledge contributions from Marko Ackermann, Dieter Heinrich, Maria Eleni Athanasiadou, Chuyi Wang, Christopher Löffelmann, Linus Hötzel, Utkarsha Shukla, Tobias Luckfiel, Heiko Schlarb. The development of the BioMAC-Sim-Toolbox was supported by adidas AG and by the Deutsche Forschungsgemeinschaft (DFG, German Research Foundation) through Project-ID442419336, SFB 1483 - EmpkinS and through Project-ID520189992

# TODOS
- Check mu in 2D normal and 3D contact model
Expand Down

0 comments on commit d1fb710

Please sign in to comment.