Skip to content
This repository has been archived by the owner on Oct 14, 2023. It is now read-only.

FEAT: modernize README #1543

Merged
merged 18 commits into from
Feb 18, 2023
Merged

Conversation

jorgepiloto
Copy link
Member

@jorgepiloto jorgepiloto commented Jul 16, 2022

The goal of this pull-request is to fix #610. However, I decided to go one step further and update as much as possible our README.md file by:

  • Using the svg logo as the banner image for the repository. It appears now as a centered image.
  • Transpose the metadata table and add a Maintainers header pointing to a new AUTHORS.md file.
  • Replace the molniya plot by a nice collage of examples.
  • Enhanced the installation guide with a table covering conda, pypi and source installation.
  • Add a table in the Examples, background and talks pointing to our talks in conferences.
  • Updated license copyright years.

Everything is pure markdown, which esures that PyPI will render properly. Please, take a look to:

https://github.com/jorgepiloto/poliastro/tree/fix/molniya-plot

Before I fix the link to the image for the collage of examples when merging.

@astrojuanlu
Copy link
Member

Do you think we could use interactive=True for this one? 😄

@jorgepiloto
Copy link
Member Author

You mean having an interactive plot directly in README.md?

@astrojuanlu
Copy link
Member

Don't think we can have an interactive plot in the README, but rather taking a screenshot of how the Plotly plot looks like, given that we're favoring OrbitPlotter2D/3D in the docs and the examples over StaticOrbitPlotter.

@jorgepiloto
Copy link
Member Author

Just updated the plot by imposing the interactive = True parameter 👍🏽

Copy link
Member

@astrojuanlu astrojuanlu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot @jorgepiloto! My only comment is that the screenshot is very wide, and it doesn't look very good in the docs:

image

Wondering if there's a way to shrink it a bit, or otherwise leave the legend out completely and crop the screenshot so that only the axis are shown.

Copy link
Member

@astrojuanlu astrojuanlu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(Request changes)

@jorgepiloto
Copy link
Member Author

We could render that plot and make it dynamic in the docs by using:

.. jupyter-execute::
   :hide-code:

   from poliastro.examples import molniya
   molniya.plot(interactive=True)

If not, I will fix the size 👍🏽

@astrojuanlu
Copy link
Member

That would be cool indeed! We'll need a static plot for the README anyway

@jorgepiloto jorgepiloto force-pushed the fix/molniya-plot branch 2 times, most recently from e3746d2 to ea67498 Compare February 11, 2023 12:15
@jorgepiloto jorgepiloto changed the title Update molniya plot in README.md FEAT: update molniya plots in README file and docs Feb 11, 2023
@jorgepiloto jorgepiloto force-pushed the fix/molniya-plot branch 7 times, most recently from a2351ae to e12f344 Compare February 11, 2023 12:28
@jorgepiloto jorgepiloto changed the title FEAT: update molniya plots in README file and docs FEAT: modernize README Feb 11, 2023
@jorgepiloto jorgepiloto force-pushed the fix/molniya-plot branch 9 times, most recently from 0a10929 to e78e413 Compare February 11, 2023 14:28
@jorgepiloto jorgepiloto force-pushed the fix/molniya-plot branch 2 times, most recently from 1482673 to 6729cc8 Compare February 13, 2023 20:12
Copy link
Member

@astrojuanlu astrojuanlu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fantastic job @jorgepiloto! Left a few comments

@jorgepiloto jorgepiloto force-pushed the fix/molniya-plot branch 4 times, most recently from a859868 to c844848 Compare February 16, 2023 21:04
@jorgepiloto
Copy link
Member Author

It looks like the latest version of matplotlib is causing the porkchop features to fail. Let me fix that in a separate pull-request.

@jorgepiloto jorgepiloto merged commit 6e52a7c into poliastro:main Feb 18, 2023
@jorgepiloto jorgepiloto deleted the fix/molniya-plot branch February 18, 2023 14:10
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Time to update this plot in README?
2 participants