Switch to an implicit solver

[pavel-kirienko]

Rebased with:

git rebase --onto main bc6b2dcd71826cb8290a54bfa921d302983e450e bfa8c137a20cd1e5aebd9ccb5c2d897fd7c3bad0

Summary by CodeRabbit

• Documentation

  • Updated README with detailed instructions for running the Jiles-Atherton system identification tool
  • Added specific command-line examples for different specimens
  • Expanded guidance on comparing predicted values with COMSOL model

• Performance Improvements

  • Reduced computational effort in test runs
  • Enhanced numerical stability in solver algorithms

• Bug Fixes

  • Improved error handling in optimization and solving processes
  • Added retry mechanisms for numerical integration

• New Features

  • Introduced new thread pool executor with backlog management
  • Enhanced plotting capabilities with error visualization

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request introduces comprehensive improvements to the Jiles-Atherton system identification tool across multiple files. The changes focus on enhancing error handling, numerical stability, and optimization processes. Key modifications include refactoring the solving algorithm in ja.py, updating the fitting and plotting mechanisms, introducing more robust error management, and improving the documentation in the README. The changes aim to make the tool more reliable and flexible when identifying magnetic material properties.

Changes

File	Change Summary
README.md	Added detailed instructions for running the tool with specific coefficients for different specimens, including command-line examples and result comparisons
noxfile.py	Reduced effort parameter from 100 to 10 for coverage runs on specific data files
src/jafit/ja.py	- Enhanced SolverError with partial curve parameter - Modified coefficient validation logic - Refactored solving mechanism with improved error handling - Updated numerical integration approach
src/jafit/jafit.py	- Added LimitedBacklogThreadPoolExecutor - Renamed and updated callback mechanisms - Improved error handling in plotting and fitting
src/jafit/opt.py	- Added callback parameter to objective function - Simplified threading mechanism - Modified optimization strategy
src/jafit/vis.py	- Renamed plot_hb to plot - Added axes_labels parameter - Restructured plotting configuration

Sequence Diagram

sequenceDiagram
    participant User
    participant Optimizer
    participant Solver
    participant Plotter
    
    User->>Optimizer: Initiate Fitting
    Optimizer->>Solver: Solve with Coefficients
    alt Successful Solve
        Solver-->>Optimizer: Return Solution
        Optimizer->>Plotter: Plot Results
    else Solver Error
        Solver-->>Optimizer: Raise SolverError
        Optimizer->>Plotter: Plot Error Details
    end

Loading

Poem

🐰 A Rabbit's Ode to Code Refinement 🔬

With coefficients tight and error low,
Our Jiles-Atherton model starts to glow
Sweeping curves with numerical might
Debugging paths now clear and bright
Science hops forward, one function at a time! 🚀

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Free

📥 Commits

Reviewing files that changed from the base of the PR and between 9c04ad7 and a4d87ab.

⛔ Files ignored due to path filters (6)

• validation/H(t),M(t),B(t) c_r=0.1 M_s=1.6e6 a=560 k_p=1200 alpha=0.0007.png is excluded by !**/*.png
• validation/H(t),M(t),B(t) c_r=0.8 M_s=1.6e6 a=56000 k_p=50000 alpha=0.001.png is excluded by !**/*.png
• validation/hysteresis c_r=0.1 M_s=1.6e6 a=560 k_p=1200 alpha=0.0007.png is excluded by !**/*.png
• validation/hysteresis c_r=0.5 M_s=1.6e6 a=56000 k_p=50000 alpha=0.001.png is excluded by !**/*.png
• validation/hysteresis c_r=0.8 M_s=1.6e6 a=56000 k_p=50000 alpha=0.001 zoomout.png is excluded by !**/*.png
• validation/hysteresis c_r=0.8 M_s=1.6e6 a=56000 k_p=50000 alpha=0.001.png is excluded by !**/*.png

📒 Files selected for processing (6)

• README.md (1 hunks)
• noxfile.py (1 hunks)
• src/jafit/ja.py (8 hunks)
• src/jafit/jafit.py (8 hunks)
• src/jafit/opt.py (4 hunks)
• src/jafit/vis.py (3 hunks)

---

Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[pavel-kirienko]

Rebased with:

git rebase --onto main bc6b2dcd71826cb8290a54bfa921d302983e450e bfa8c137a20cd1e5aebd9ccb5c2d897fd7c3bad0