doc: add performance comparison table

[henry2004y]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @henry2004y, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the demo_hybrid.jl example documentation by integrating a performance comparison table. It measures the execution time and memory allocations for the Full Orbit, Guiding Center, and Hybrid solvers, providing users with clear insights into their relative efficiencies and resource usage.

Highlights

• Performance Measurement: Implemented timing for the Full Orbit, Guiding Center, and Hybrid solvers using the @timed macro to capture execution time and memory allocations.
• Documentation Enhancement: Added a new section to the demo_hybrid.jl documentation that presents a formatted table comparing the performance statistics of the three solvers.
• Module Imports: Included Printf and Markdown modules to facilitate the creation and display of the performance comparison table within the documentation.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• docs/examples/features/demo_hybrid.jl
  • Imported Printf and Markdown modules for output formatting.
  • Wrapped calls to solve for Full Orbit, Guiding Center, and Hybrid solvers with @timed to collect performance statistics.
  • Ensured save_everystep = true for the Full Orbit solver.
  • Appended a new section to the file that generates and displays a performance comparison table using the collected statistics.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request adds a performance comparison table to the hybrid solver example documentation. The changes correctly use @timed to capture execution time and memory allocations for the full orbit, guiding center, and hybrid solvers. The results are then formatted into a markdown table. My review includes a suggestion to improve the readability and maintainability of the table generation code.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.80%. Comparing base (92aba10) to head (205b983).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #458   +/-   ##
=======================================
  Coverage   81.80%   81.80%           
=======================================
  Files          21       21           
  Lines        2056     2056           
=======================================
  Hits         1682     1682           
  Misses        374      374           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.