Skip to content

Use only required OrdinaryDiffEq subpackage #2392

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

DanielDoehring
Copy link
Contributor

using only the required package should be sufficient and relieves the user from the need to add 2 packages if only 1 is needed.

Copy link
Contributor

github-actions bot commented May 9, 2025

Review checklist

This checklist is meant to assist creators of PRs (to let them know what reviewers will typically look for) and reviewers (to guide them in a structured review process). Items do not need to be checked explicitly for a PR to be eligible for merging.

Purpose and scope

  • The PR has a single goal that is clear from the PR title and/or description.
  • All code changes represent a single set of modifications that logically belong together.
  • No more than 500 lines of code are changed or there is no obvious way to split the PR into multiple PRs.

Code quality

  • The code can be understood easily.
  • Newly introduced names for variables etc. are self-descriptive and consistent with existing naming conventions.
  • There are no redundancies that can be removed by simple modularization/refactoring.
  • There are no leftover debug statements or commented code sections.
  • The code adheres to our conventions and style guide, and to the Julia guidelines.

Documentation

  • New functions and types are documented with a docstring or top-level comment.
  • Relevant publications are referenced in docstrings (see example for formatting).
  • Inline comments are used to document longer or unusual code sections.
  • Comments describe intent ("why?") and not just functionality ("what?").
  • If the PR introduces a significant change or new feature, it is documented in NEWS.md with its PR number.

Testing

  • The PR passes all tests.
  • New or modified lines of code are covered by tests.
  • New or modified tests run in less then 10 seconds.

Performance

  • There are no type instabilities or memory allocations in performance-critical parts.
  • If the PR intent is to improve performance, before/after time measurements are posted in the PR.

Verification

  • The correctness of the code was verified using appropriate tests.
  • If new equations/methods are added, a convergence test has been run and the results
    are posted in the PR.

Created with ❤️ by the Trixi.jl community.

@JoshuaLampert
Copy link
Member

I discussed this with Hendrik in #2266 (comment). Importing both packages allows to easily switch between integrators. But I would still be fine with this.

@DanielDoehring
Copy link
Contributor Author

I discussed this with Hendrik in #2266 (comment).

Ah thanks!

Yeah this PR is heavily personally biased, as I always get annoyed when I create a new branch from main and have to include and precompile two packages 😶‍🌫️

@JoshuaLampert
Copy link
Member

Yeah, I guess it makes sense to only leave the required subpackage, especially since you already did the (probably annoying (or did you (semi)automate this? 🤔)) work 😅

@DanielDoehring DanielDoehring added the refactoring Refactoring code without functional changes label May 9, 2025
Copy link

codecov bot commented May 9, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.95%. Comparing base (19fedd4) to head (c33aaa8).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2392      +/-   ##
==========================================
+ Coverage   94.92%   96.95%   +2.03%     
==========================================
  Files         504      504              
  Lines       41717    41721       +4     
==========================================
+ Hits        39599    40448     +849     
+ Misses       2118     1273     -845     
Flag Coverage Δ
unittests 96.95% <ø> (+2.03%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ 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.

@ranocha
Copy link
Member

ranocha commented May 9, 2025

Could you please add this to the agenda for the next meeting to see what the others think about it?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion low-priority refactoring Refactoring code without functional changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants