search

tudat-team / tudat-space

An introduction and guide to tudat-space.
https://tudat-space.readthedocs.io
14 stars 17 forks source link

Feature/integrator propagator refactor #79

Closed DominicDirkx closed 1 year ago

DominicDirkx commented 1 year ago 
The examples still have to be adapted to the new inputs to translational(), correct? I would have, but it is more time efficient if you quickly run through them, because the syntax is still somewhat new to me, so it would take longer. I can do it of course, if that is desired.

Good point, I have this done locally, at least for the Python files. I'll have a look and let you know if I would like you to do anything on this

The figure in State Propagation needs an update as well maybe.

Indeed, it should. I have instructions from Filippo on how to do this in a DM. I'll forward it to you, could you see if you can update them?

A slightly separate note, would it be beneficial to rename the files to correspond to the header within that specific file? I say this because the console_output.rst file has the header "Printing and processing the results", which is not unrelated but is inefficient when searching for the designated file in the source code. The disadvantage would be that you would have long file names.

The file tree doesn't properly mirror the toc on the site. For the mass_dynamics.rst file, it is in the dynamic_types directory, but not in a Dynamic Types directory on the site. This is slightly confusing (all be it only for the developer). Moreover, it could be useful to add this specific directory to the toc on the site? Then the list under Propagation Setup is not so large. Another example is that sensitivity_analysis doesn't really show up on the site, but it is a directory in the source code.

This should indeed be made more consistent, but can be done independently from this PR. Could you open an issue of this? We could briefly discuss this in the next meeting. Or, if you think this is something you could get done in a rather short time (say an hour or two) go ahead and make the changes.

I have noticed that all the code snippets include Python and C++ tabs, yet the C++ tab is never complete as far as I have seen (probing randomly). Is this a future wish, or is it somewhat useless?

We're still leaving open the option of providing more C++ support/docs in the future, hence this setup.

The Propagation architecture page is quite a heavy pill if you read through the whole thing. It's very useful if you want to dive into what actually happens, I think most students (other academic users maybe more) won't thoroughly read through this unless pointed to it.

Indeed it is. Perhaps a note at the top on this, stating that this is something more for 'background' than to read through and through for a casual user?

All in all I think it's a huge improvement as far as work flow is concerned with numerical simulations. I thought that the flow of almost everything is good to follow as someone with my level of experience (whatever that means).

Awesome, thanks!

sbcowan commented 1 year ago

Indeed, it should. I have instructions from Filippo on how to do this in a DM. I'll forward it to you, could you see if you can update them?

I will have a look

This should indeed be made more consistent, but can be done independently from this PR. Could you open an issue of this? We could briefly discuss this in the next meeting. Or, if you think this is something you could get done in a rather short time (say an hour or two) go ahead and make the changes.

Yes, and yes I can have a look, I'm not sure how long it will take, it shouldn't take too long. I will wait for some discussion on how we want to make it more consistent.

Perhaps a note at the top on this, stating that this is something more for 'background' than to read through and through for a casual user?

Yes, maybe something along the lines of: "Note: This page dives deeper into the steps that Tudat takes behind the scenes to perform a simulation numerically. Generally users do not need to interact with or be aware of these steps. This page serves the purpose of informing the interested user and can help to improve the users understanding."

DominicDirkx commented 1 year ago

I'm merging this pull request, to get the user guide up to date with the latest version of thee code. @sbcowan. If there are small open points for the block diagram, you can merge these into main later at your convenience