Workflow: creation of examples and uploading to tudatpy-examples

[MiguelAvillez]

Right now, new examples have to be manually copied from the tudat-space repo to tudatpy-examples (or vice-versa), as well as manually converted from jupyter notebooks to py files (or the other way around).

Ideally, the examples should only be modified as jupyter files in tudat-space and automatically copied as jupyter and py files to tudatpy-examples.

If that automatic workflow is not possible (or at least while it isn't implemented), people working on examples should only modify them in the tudat-space repo. Only afterwards should they be copied to the tudatpy-examples repo. The goal is to have all the more recent versions of the examples in a single repo and in a single file type (to avoid having the two repos with a mix of new and old files), as the likelihood of someone forgetting to copy the examples to the repo they are not using relatively large.

[larshinueber]

Hi @MiguelAvillez,

I fully agree that there should be a single place where all the example notebooks are stored, to avoid having to keep two files in sync and updated.
Regarding the repository, from the perspective of a new contributer, in my opinion it would be more intuitive for tudatpy-examples to be the repository storing the leading version. Just from looking at the descriptions of the repository in the tudat-team README, I wouldn't expect to find the examples in the "repository from which our website is generated.". Additionally, they would be hidden quite deep in the repository structure.

Assuming that tudatpy-examples is the leading repository, tudatpy-examples could be added as a submodule to tudat-space, which would resolve any ambiguity as there are no more notebooks stored in tudat-space. The only thing to update would be the commit of the submodule.

I would therefore propose the following workflow:

• tudatpy-examples becomes the leading repository for example applications
• tudatpy-examples is added as a submodule to tudat-space (implemented in Use submodule for example notebooks tudat-space#148
• On a push in the master branch in tudatpy-examples, the commit of the submodule in tudat-space is updated (implemented in Github action to sync tudat-space submodule #47)
• On a push of a notebook in tudatpy-examples, the corresponding python script is automatically generated, if not already present (to be implemented)

What do you think? Any feedback is appreciated!

[DominicDirkx]

Done!