search

tudat-team / tudat-space

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

Revise landing page #56

Closed FilippoOggionni closed 2 years ago

FilippoOggionni commented 2 years ago

[continuing from #21]

First, I will include some interactive panels in the landing page with all the difference resources and reorganize existing. About the other items (intro, overview, functionalities [including nice figures and use cases]), this is lower priority and I will use the team's input to add features.

FilippoOggionni commented 2 years ago

@DominicDirkx @jo11he @gaffarelj I have changed the landing page as we discussed, including links to external resources in the form of panels. Of course it could be improved and made more attractive than this, but first I wanted to check if you had specific ideas for the first three points below. Some content for those points can be taken from the "about" page, but it should be represented in a more exciting and visually appealing way.

From #21:

FilippoOggionni commented 2 years ago

My proposal: we organize most of the functionalities listed in the "about" page (all points but the last two) in a panel-like fashion, perhaps including some nice images. We could also do the same with 2/3 examples where tudat has been used in published research (or this could go in a dedicated page called "Success stories" or something like this, as proposed by @gaffarelj).

gaffarelj commented 2 years ago

I agree with your proposal. I think we could get a few illustrations from published research when we want to illustrate some important points on the main about page, and then put more examples with more fancy illustrations in the "Case studies".

FilippoOggionni commented 2 years ago

I agree with you @gaffarelj that figures should be included only for the case studies and not for the current "array" of capabilities.

For now I have something like this, see attachment. I am not sure if the description of tudat-space as a "community" already applies... We could also switch the order between paragraphs, if needed. What do you think?

In addition, for now the array of "capabilities" includes both a showcase of functionalities of tudatpy (e.g., customize body models) and things you can do with it (e.g., simulate the orbit estimation process). We may want to consider a clear division between the two. This is also done in Numpy's home page here: they first show a 3x2 array of panels illustrating the strong points of numpy; down in the page they show a few case studies. Is this something we want to imitate? Our case studies can be a mix of research actually published and other case studies not published but that we know they can be achieved with Tudatpy.

Screen Shot 2022-01-22 at 13 58 32 Screen Shot 2022-01-22 at 14 23 20
FilippoOggionni commented 2 years ago

Regarding the capabilities / scenarios that Tudat can simulate, I will make a draft of the list below, please feel free to add to this @DominicDirkx. It is a high-level list of categories, so it will not be exhaustive:

gaffarelj commented 2 years ago

The design is definitely more inviting than the current one. Great job!

Two small remarks:

I agree that dividing between what tudatpy can do and a showcase of functionalities would be good. But I would keep the showcase concise (a few things that impress instead of a long list that loses the reader's attention), and link to the future Case studies for more detailed examples.

About the list of capabilities: perhaps we should remove control, and only keep guidance? We want to help develop guidance but nothing else from GNC (👀 the latest point from the developer meeting of last week).

FilippoOggionni commented 2 years ago

Thanks for the quick feedback!

Could you change the italic text in the first image (Getting started, User guide...) to links.

Unfortunately I cannot do this, as those sections are not actual pages in the tudat-space, but only sections of the index/TOC.

I would use a sub-title for the useful links/resources instead of the blue note. That separates things more clearly in my opinion. But I would still keep the message of the note (as normal text) between the sub-title and the boxes.

Sure!

Regarding the rest, I agree, but I will wait to have Dominic's view on this before making further changes.

Last point: do you agree that having the section with API and developer docs before the current showcase of functionalities or should I switch it?

jo11he commented 2 years ago

Hell yeah this is great!

FilippoOggionni commented 2 years ago

I pushed the current changes in 4ba3d8fc4a756feef9cb5e0603ac7315832f23e5. I will wait for feedback before proceeding further.

We can also add some colors to make it a bit less homogeneous (see the sphinx-panels' guide). Since the landing page is very important, I am dedicating extra attention to aesthetics as well 😃

DominicDirkx commented 2 years ago

Hell yeah this is great!

What he said :) This is a huge improvement compared to what we have now! In my opinion, go ahead and push this the master branch. Any small updates we want to make can be made from there.

FilippoOggionni commented 2 years ago

Happy to hear! The changes are already online, if you want me to make further modifications please let me know.

@DominicDirkx when you have time, could you give us your opinion about the following points?

In addition, for now the array of "capabilities" includes both a showcase of functionalities of tudatpy (e.g., customize body models) and things you can do with it (e.g., simulate the orbit estimation process). We may want to consider a clear division between the two. This is also done in Numpy's home page here: they first show a 3x2 array of panels illustrating the strong points of numpy; down in the page they show a few case studies. Is this something we want to imitate? Our case studies can be a mix of research actually published and other case studies not published but that we know they can be achieved with Tudatpy.

Regarding the capabilities / scenarios that Tudat can simulate, I will make a draft of the list below, please feel free to add to this @DominicDirkx. It is a high-level list of categories, so it will not be exhaustive:

  • Artificial satellite orbits (translational and rotational motion)
  • Dynamics of celestial bodies in multi-body systems
  • Interplanetary trajectories with high and low thrust
  • Reentry trajectories of manned and unmanned vehicles
  • Rocket launch trajectories
  • Ascent and descent trajectories of planetary landers
  • Guidance and control for the above cases
DominicDirkx commented 2 years ago

In addition, for now the array of "capabilities" includes both a showcase of functionalities of tudatpy (e.g., customize body models) and things you can do with it (e.g., simulate the orbit estimation process). We may want to consider a clear division between the two. This is also done in Numpy's home page here: they first show a 3x2 array of panels illustrating the strong points of numpy; down in the page they show a few case studies. Is this something we want to imitate? Our case studies can be a mix of research actually published and other case studies not published but that we know they can be achieved with Tudatpy.

I think this is a good distinction to make. The Numpy landing page looks very slick, and 'borrowing' elements of their design sounds good. Making case studies a mix of past and future potential work is a good idea.

DominicDirkx commented 2 years ago
  • Artificial satellite orbits (translational and rotational motion)
  • Dynamics of celestial bodies in multi-body systems
  • Interplanetary trajectories with high and low thrust
  • Reentry trajectories of manned and unmanned vehicles
  • Ascent and descent trajectories of planetary landers
  • Guidance and control for the above cases

I'll move this discussion to Slack

FilippoOggionni commented 2 years ago

I added the manual to the landing page. @DominicDirkx I made minor changes to the preface (specifically, the links for github and the documentation). To do that, I created an overleaf version, which we might use to collaborate.

In addition, since the "buttons" on tudat-space do not allow for a direct file download, I had to upload it to the cloud. I have used my personal Google Drive for simplicity, but if you have better ideas I can simply re-upload it somewhere else.

gaffarelj commented 2 years ago

I think you can setup a link so that the browser downloads the target instead of loading it in a tab. I can take a look at it this afternoon if you think it would make sense (and I would include the guide directly on the website then).

FilippoOggionni commented 2 years ago

Great idea! I did not think about it, thanks for the suggestion.

As a quick fix (but I think we should not spend more time on it), I uploaded the manual in the tudat-space repository via 1de7bda294ed9193182625a936dea4f3bbc69cde (i.e., it is hosted on Github) and I have set up the button so that pressing it will trigger the download (via 169f9af2b730b72edc9e3d665bb13db4fdd3daa6).

geoffreygarrett commented 2 years ago

I believe this is an appropriate place to couple the tudat-team/.github/profile/README.md item for review.

@FilippoOggionni & @DominicDirkx

FilippoOggionni commented 2 years ago

@geoffreygarrett good point. I moved your comment to a new issue (tudat-team/project-management#27), so I will close this as it is done.