Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ENH] Inspiration for additional examples #325

Open
oscr opened this issue Mar 6, 2023 · 9 comments
Open

[ENH] Inspiration for additional examples #325

oscr opened this issue Mar 6, 2023 · 9 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@oscr
Copy link
Contributor

oscr commented Mar 6, 2023

Proposed new feature or change:

I found this page with stats: https://public.tableau.com/app/profile/mateusz.karmalski/viz/F1ResultsTracker2022/Results

I think it would be interesting to implement a few of these as examples to build up the library of example components. I will likely start hacking on this in the future when I get some time, but anyone who is interested please feel free to get started on this work.

@theOehrly
Copy link
Owner

Those are some nicely done visualizations. Examples for similar analyses would be very nice, yes.

@theOehrly theOehrly added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 5, 2023
@harningle
Copy link
Contributor

harningle commented Apr 12, 2023

This issue seems to be open for some days. I really like the dashboard, so just did a quick visualisation of this results tracker using plotly. No idea how to properly display plotly output in github, so attached a screenshot below. Shall I do a PR or would you please provide some suggestions? Thx!

results_tracker

@theOehrly
Copy link
Owner

This issue seems to be open for some days. I really like the dashboard, so just did a quick visualisation of this results tracker using plotly. No idea how to properly display plotly output in github, so attached a screenshot below. Shall I do a PR or would you please provide some suggestions? Thx!

Looks really cool. I think this should go in the example gallery, but I see you have already figured that out.

We are using sphinx-gallery to create the example gallery. There's an example how to have it capture plotly output here: https://sphinx-gallery.github.io/stable/auto_plotly_examples/plot_0_plotly.html

You can open a PR for this, and then we'll see how to get it working properly. We need to modify docs/conf.py as described in the example. And we need to add plotly as a requirement in requirements-dev.txt. I think that it should work after that.

theOehrly pushed a commit that referenced this issue Apr 15, 2023
* Add an example script to visualise driver standings and points (#325)

* Configure sphinx-gallery to support scraping plotly output including gallery thumbnail using kaleido
@UmiVilbig
Copy link

Hey, I'm new here but last week I made a little visualization of Perez's pole lap in Miami where I made a plt which was animated with telemetry data. I'm happy to add this to an example if you guys like it
https://twitter.com/i/status/1655004274362048512

@oscr
Copy link
Contributor Author

oscr commented May 16, 2023

Beautiful work @UmiVilbig! I would love to see it.

@theOehrly
Copy link
Owner

Hey, I'm new here but last week I made a little visualization of Perez's pole lap in Miami where I made a plt which was animated with telemetry data. I'm happy to add this to an example if you guys like it https://twitter.com/i/status/1655004274362048512

That would pretty cool. Quite a few people have already asked about animating graphs. So this would be a cool example. I've never used GIFs in the gallery, but as far as I can tell, it should be supported.

@UmiVilbig
Copy link

@theOehrly
This is my first time trying to commit to an open-source project so I'm not really sure how to add my example

@oscr
Copy link
Contributor Author

oscr commented May 16, 2023

@UmiVilbig I think this is a good description: https://github.com/firstcontributions/first-contributions

You can't cause any damage to the project. So don't worry about breaking anything.

@theOehrly
Copy link
Owner

You can't cause any damage to the project. So don't worry about breaking anything.

This puts it very well 😁

@UmiVilbig Also see https://docs.fastf1.dev/contributing/contributing.html#contributing-code

Gallery examples go into the examples folder. You can have a look at the code of the existing examples to see how they are formatted. The examples are generated using sphinx-gallery (https://sphinx-gallery.github.io/stable/index.html).

And then just open a pull request. No worries if you miss something, I'll give feedback and tell you what might need to be changed still.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants