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.

Sign up for GitHub

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

Jump to bottom

Make improvements to documentation page on performance tips #1893

Open
3 tasks
namurphy opened this issue Jan 13, 2023 · 2 comments
Open
3 tasks

Make improvements to documentation page on performance tips #1893

namurphy opened this issue Jan 13, 2023 · 2 comments
Labels
docs PlasmaPy Docs at http://docs.plasmapy.org priority: medium Issues & PRs of moderate urgency and importance

Comments

@namurphy
Copy link
Member

In #1887, we added a page on performance tips for using PlasmaPy (see also #1760). This PR is to keep track of remaining improvements that we could do as time permits.

  • Expand the discussion on lite-functions
  • Use timeit.timeit to show actual timings and to make sure we're not making this all up
  • Say a bit more about when is a good time to optimize performance vs. when it isn't (maybe adding the quote about how premature optimization?)
@StanczakDominik
Copy link
Member

timeit is nice, but I always just do these in Ipython with %timeit.

@namurphy
Copy link
Member Author

Agreed about %timeit! I was having some trouble getting timeit to work in regular Python. Given your suggestion, I'm wondering if this page would be best converted into a Jupyter notebook.

@namurphy namurphy added the docs PlasmaPy Docs at http://docs.plasmapy.org label Jan 18, 2023
@github-actions github-actions bot added the Stale Dormant issues & PRs which will be automatically closed if the label is not removed. label Mar 20, 2023
@namurphy namurphy removed the Stale Dormant issues & PRs which will be automatically closed if the label is not removed. label May 12, 2023
@namurphy namurphy added the priority: medium Issues & PRs of moderate urgency and importance label May 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs PlasmaPy Docs at http://docs.plasmapy.org priority: medium Issues & PRs of moderate urgency and importance
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@namurphy @StanczakDominik