Skip to content

Commit

Permalink
readme and todo update
Browse files Browse the repository at this point in the history
  • Loading branch information
Ipuch committed Dec 6, 2022
1 parent c7d05cf commit 83096d0
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 7 deletions.
54 changes: 54 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,57 @@ Inverse and Forward approach are implemented.
| License | <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/license-MIT-success" alt="License"/></a> |
| Continuous integration | [![Build status](https://ci.appveyor.com/api/projects/status/axakr33c79eo0xal/branch/main?svg=true)](https://ci.appveyor.com/project/Ipuch/bionc/branch/main) |
| Code coverage | [![codecov](https://codecov.io/gh/ipuch/bionc/branch/main/graph/badge.svg)](https://codecov.io/gh/ipuch/bionc) |

# Table of Contents

[Installation - from source](#installation---from-source)

[A first practical example](#a-first-practical-example)
- [The import](#the-import)
- [Building a model from scratch](#building-a-model-from-scratch)
- [Building a model from a c3d file](#building-a-model-from-a-c3d-file)
[Mathematical backends](#mathematical-backends)
[Natural coordinates reminders](#natural-coordinates-reminders)

[A more in depth look at the `bioptim` API](#a-more-in-depth-look-at-the-bioptim-api)
todo

# Installation - from source
One can install the package from source using the following command:
```
python setup.py install
```

# A first practical example
The easiest way to learn bionc is to dive into it.
So let's build our first model.
Please note that this tutorial is designed to recreate example which builds a lower limb model (Pelvis, Thigh, Shank, Foot).

## The import
The first step is to import the classes we will need.
```python
from bionc import (
AxisTemplate,
BiomechanicalModelTemplate,
MarkerTemplate,
SegmentTemplate,
NaturalSegmentTemplate,
C3dData,
BiomechanicalModel,
JointType,
)
```

## Building a model from scratch

todo

## Building a model from a c3d file

todo

# Mathematical backends
This toolbox support two mathematical backends: `numpy` and `casadi`.
todo

# Natural coordinates reminders
9 changes: 2 additions & 7 deletions TODO
Original file line number Diff line number Diff line change
@@ -1,14 +1,9 @@
Todo list for the development of the project bioNC

The template would be great to build generic biomechanical models based on experimental data.

Todo: list for the development of the project bioNC
InertiaParameters need to be generated in SCS or in NSCS ? it can be both...

model creation - on the way
- from experimental data ? (see the template)
model creation:
- from biomod ?
- from opensim ?

add a methode to add joints to the model
add a class to add muscles to the model
add a class to add ligaments to the model

0 comments on commit 83096d0

Please sign in to comment.