[ROADMAP] STAPLE 0.1 (first stable release)

[modenaxe]

trafficstars

@renaultJB I have created this item in discussion to discuss few ideas for a roadmap.

So for now I have developed the algorithms further in order to have:

1. consistent fields for the outputs of the morphological algorithms (see README)
2. consistent dimensions of the main vectors (V, Origin, etc)
3. an option of creating the models with proper local reference system (both of the geometry and of the joint reference systems)

I think that before releasing a stable version we still need:

1. a solid documentation
2. a patellofemoral joint, or at least the tools to develop it
3. some functions to add muscles

About these points:

1. the sphynx suggestion could really help, especially if we manage to have automatic Actions from GitHub building the documentation again automatically when we push something new.
2. I have updated the patella_GIBOC functions to work in STAPLE (not pushed yet). The patellofemoral joint is still a bit clunky but I think it's a good baseline for us or others to work on.
3. the muscles will be a major features (change of version as well) and I am working on those but they will come out as publications first I think.

In conclusion, I think that once we have points 1. + 2. we can release as v0.1 (stable). Let me know what you think, I will setup a milestone accordingly, which we can modify later if necessary.

[renaultJB]

@modenaxe It is all very clear to me.

About point 1. I'll try to make progress on the topic. I am not familiar with automatic github actions. I will look into it. I've found those links that seems interesting :

• github-pages-python-sphinx
• Publishing sphinx-generated docs on github
• gist : Sphinx example. Automatically generate docs and host on github pages.
• sphinx-travis-ci-github-pages-full-integration-for-auto-docs-publishing

But for now I will focus on the raw material: actually writting or converting comments.

About point 2. I'll review the code when I've finish the documentation.

[modenaxe]

@renaultJB these resources look great, I will have a proper look in the next days.

About point 2), I am almost done porting the old GIBOC code for the patella to STAPLE plus I have developed an advanced example for creating a proper patellofemoral joint. The constraints are sensitive to the initial position of the bones but I just want to provide a starting point for future development from us or other users, not a generic solution for modelling the joint. So wait to check the code until I push the new files to the repository, please.