Use entry points

[HugoFara]

Current standard use case for the library:

• The user imports pylinkage
• It defines a linkage of its liking
• Views the linkage with a function
• Defines any score function
• Somehow optimize everything?
• View the result again? What linkage?

If you change any parameter, the workflow is likely to be ran again. This is a tedious process.

What I'm thinking of:

• The user imports pylinkage in a linkage.py file.
• This file contains at least three functions:
  • define_linkage(dimensions, init_position) -> Linkage
  • optimize_linkage(dimensions, init_position) -> score
• With that we create the entry points "pylinkage-gui" and "pylinkage".
  • To view a linkage pylinkage-gui linkage.py
  • To optimize pylinkage linkage.py.

I strongly advice again using OOP on front-end as it will be confusing for users. On the back-end side that may be a good option.

[HugoFara]

Will close this issue for now as it is ill-scoped. Now the situation is:

• Working on a linkage: use a Python Notebook. We provide several examples already. Import/export feature already cover the cases where you want to do optimization only.
• Access from other scripts: we now provide an API in server mode, which should be well.

The only use-case that is uncovered would be a CLI, but that would be a different issue posting.