Closed FilippoOggionni closed 3 years ago
After a discussion with @jo11he, we think that leaving the code snippets is not so useful, but a link to the API should be sufficient (in addition to the acceleration model setup guide available here).
@DominicDirkx I have started modifying the page until "Spherical Harmonic Gravity" (not included), so essentially the introduction and "Point Mass Gravity". I pushed to this branch, but I will attach a screenshot here. I am looking forward to hearing your feedback, so we can decide if/how to proceed 😄
Just to add, the code snippets, which were appreciated by the students, will be moved from such webpage to the API, under each function's "Example" section. The API system is already equipped with that possibility, so we just need to add them to the yaml files. @jo11he and I already tested this and we can confirm it works.
The rationale for this is the following:
A more higher-level rationale backing up the bullet points above is the following distinction (still work-in-progress, but that's what we reached consensus about, if I am not mistaken):
As a result of this, the user guide should be "essential" when listing a set of several models (e.g., acceleration) that are employed in the same way, but they just differ on the input parameter side. Hence, to keep it essential, examples should not be there, but somewhere else (API).
These can be personal views, so they are up for discussion, but we think it is important that we state clearly and agree on the different purposes of the user guide and the API in order to:
Following a private Slack discussion with @DominicDirkx (link), we have agreed that the list of acceleration models should present all available accelerations and for each only the following content should be present:
The following accelerations are in tudat-space but not in the API:
The following accelerations are in the API but not in tudat-space:
Other TODO points (also written on the rst file here):
@DominicDirkx I pushed here my changes so far.
I have also moved the examples from tudat-space to the API (in the yaml files), but there is a sphinx rendering error for code snippets, so I have not pushed those changes yet. Hopefully we can solve that together with @ggarrett13
Update: syntax errors in example code blocks was solved (see pull request above).
Connect the list of available acceleration models available here to the API and make it more essential.