Skip to content

Update some constraints vars#4299

Open
chris-ashe wants to merge 23 commits into
mainfrom
update_constraints_vars
Open

Update some constraints vars#4299
chris-ashe wants to merge 23 commits into
mainfrom
update_constraints_vars

Conversation

@chris-ashe

@chris-ashe chris-ashe commented Jun 8, 2026

Copy link
Copy Markdown
Collaborator

This pull request focuses on standardizing and updating variable names across the codebase and input files for improved clarity and consistency, especially for constraint and physics-related parameters. It also updates documentation to reflect these new names and ensures all example input files use the revised identifiers.

Variable Renaming and Consistency

  • Updated variable names in process/core/input.py and all example input files to use clearer, more descriptive identifiers for key constraints and physics parameters, such as:
    • fdenef_nd_plasma_electron_limit_max
    • fiooicf_j_tf_wp_critical_max
    • psepbqarmaxp_div_bt_q_aspect_rmajor_max_mw
    • nflutfmaxflu_tf_neutron_fast_max
    • f_alpha_energy_confinement_minf_t_alpha_energy_confinement_min
    • zeff_maxn_charge_plasma_effective_vol_avg_max
    • aplasmin -> rminor_min
    • avail_min -> f_t_plant_available_min
    • fradpwr -> f_p_plasma_seperatrix_rad_max
    • pseprmax -> p_plasma_separatrix_rmajor_max_mw

Documentation Updates

  • Updated all relevant documentation files to reference the new variable names and provide accurate descriptions of their usage and default values, ensuring alignment with code changes.

Example Input File Modernization

  • Refactored all example input files to use the new variable names, ensuring they are compatible with the updated code and documentation.

Minor Improvements

  • Clarified comments and docstrings for improved readability in the codebase.

These changes collectively improve the maintainability and clarity of the codebase by enforcing consistent naming conventions and ensuring that documentation and examples are up to date.

Checklist

I confirm that I have completed the following checks:

  • My changes follow the PROCESS style guide
  • I have justified any large differences in the regression tests caused by this pull request in the comments.
  • I have added new tests where appropriate for the changes I have made.
  • If I have had to change any existing unit or integration tests, I have justified this change in the pull request comments.
  • If I have made documentation changes, I have checked they render correctly.
  • I have added documentation for my change, if appropriate.

@codecov-commenter

codecov-commenter commented Jun 15, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 88.43537% with 17 lines in your changes missing coverage. Please review.
✅ Project coverage is 48.89%. Comparing base (d84e9dd) to head (611674f).
⚠️ Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
process/core/solver/constraints.py 42.85% 8 Missing ⚠️
process/models/physics/exhaust.py 33.33% 4 Missing ⚠️
process/core/scan.py 66.66% 1 Missing ⚠️
process/models/physics/physics.py 0.00% 1 Missing ⚠️
process/models/stellarator/coils/calculate.py 0.00% 1 Missing ⚠️
process/models/stellarator/coils/output.py 0.00% 1 Missing ⚠️
process/models/stellarator/stellarator.py 50.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4299      +/-   ##
==========================================
+ Coverage   48.86%   48.89%   +0.02%     
==========================================
  Files         151      151              
  Lines       29461    29448      -13     
==========================================
+ Hits        14397    14399       +2     
+ Misses      15064    15049      -15     

☔ View full report in Codecov by Harness.
📢 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.

@chris-ashe chris-ashe force-pushed the update_constraints_vars branch from b6ba8ee to 5a5463b Compare June 16, 2026 10:13
…ency in physics and constraint data structures
…and consistency; update related references in constraints and input files.
…stency; update related references in constraints, cost variables, and input files.
… for clarity and consistency; update related references across multiple files.
…ent_min` for clarity and consistency; update all related references across multiple files.
…ity and consistency; update all related references across multiple files.
… and consistency; update all related references across multiple files.
…rove docstring for p_div_bt_q_aspect_rmajor_mw
…cy; update all related references across multiple files.
- Updated docstrings for clarity, including detailed descriptions of parameters and return values.
- Refactored power calculations in the PlasmaExhaust class to use a new method for radiation fraction calculation.
@chris-ashe chris-ashe force-pushed the update_constraints_vars branch from f8b768b to 611674f Compare June 18, 2026 08:53
@chris-ashe chris-ashe changed the title Update constraints vars Update some constraints vars Jun 18, 2026
@chris-ashe chris-ashe marked this pull request as ready for review June 18, 2026 14:47
@chris-ashe chris-ashe requested a review from a team as a code owner June 18, 2026 14:47
@timothy-nunn timothy-nunn self-assigned this Jun 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants