-
Notifications
You must be signed in to change notification settings - Fork 1
docs: update core extraction demo with manual thermal velocity #178
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
Conversation
Manually provide `v_th=0.0001` in the `extract_core_population` demo within `docs/amrex_data.ipynb` to illustrate how to override automatic estimation.
Summary of ChangesHello @henry2004y, I'm Gemini Code Assist1! 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 refines the documentation by updating a demo in the Highlights
🧠 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. Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request updates the core extraction demo in the amrex_data.ipynb notebook to show how to manually provide a thermal velocity. The change is correct and achieves the stated goal. I've added one suggestion to improve the readability of the code example and to clarify the new parameter.
| "# Extract core population using 3D velocity\n", | ||
| "core_mask, supra_mask = pd.extract_core_population(\n", | ||
| " [\"velocity_x\", \"velocity_y\", \"velocity_z\"], v_dim=3, cutoff=3.0\n", | ||
| " [\"velocity_x\", \"velocity_y\", \"velocity_z\"], v_dim=3, v_th=0.0001, cutoff=3.0\n", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This line has become quite long with the new parameter. For better readability and to make the demonstration clearer, consider breaking the arguments onto separate lines. This also provides a good place to add a comment explaining the purpose of the manually provided v_th value, which is currently a "magic number".
| " [\"velocity_x\", \"velocity_y\", \"velocity_z\"], v_dim=3, v_th=0.0001, cutoff=3.0\n", | |
| " [\"velocity_x\", \"velocity_y\", \"velocity_z\"],\n", | |
| " v_dim=3,\n", | |
| " v_th=0.0001, # Manually specify thermal velocity\n", | |
| " cutoff=3.0\n", |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #178 +/- ##
=======================================
Coverage 78.34% 78.34%
=======================================
Files 31 31
Lines 4341 4341
=======================================
Hits 3401 3401
Misses 940 940 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Manually provide
v_th=0.0001in theextract_core_populationdemowithin
docs/amrex_data.ipynbto illustrate how to override automaticestimation.