Skip to content

3410 more namespace standards for physics and engineering variables#3416

Merged
chris-ashe merged 10 commits intomainfrom
3410-more-namespace-standards-for-physics-and-engineering-variables
Dec 9, 2024
Merged

3410 more namespace standards for physics and engineering variables#3416
chris-ashe merged 10 commits intomainfrom
3410-more-namespace-standards-for-physics-and-engineering-variables

Conversation

@chris-ashe
Copy link
Copy Markdown
Collaborator

This pull request includes significant updates to the variable naming conventions in the documentation/proc-pages/development/standards.md file. The changes introduce a standardized scheme for naming variables based on their data type, system, description, and units. Additionally, specific prefixes for different types of variables are defined to improve readability and consistency.

Variable Naming Conventions:

  • Introduced a new variable naming scheme: var = <data type>_<system>_<description>_<units>. For physics variables not belonging to a system, the scheme is var = <physics variable>_<description>.
  • Defined prefixes for various types of variables, such as radii (r_), thicknesses (dr_), integer countable items (n_), number densities (nd_), areas (a_), volumes (vol_), lengths (len_), velocities (vel_), mass (m_), pressures (pres_), densities (den_), voltages (v_), resistances (res_), resistivity (rho_), currents (c_), inductances (h_), current densities (j_), powers (p_), energies (e_), temperatures (temp_), times (t_), magnetic field strengths (b_), frequencies (freq_), and angles (deg_ or rad_).

Updates to Existing Variables:

  • Updated existing variable names to follow the new naming conventions. For example, plasma_current is now c_plasma, and mass_steel is now m_steel.## Description

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.

@chris-ashe chris-ashe added the Documentation Improvements or additions to documentation label Dec 5, 2024
@chris-ashe chris-ashe requested a review from jonmaddock December 5, 2024 14:43
@chris-ashe chris-ashe linked an issue Dec 5, 2024 that may be closed by this pull request
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Dec 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 29.80%. Comparing base (73d1488) to head (a384030).
Report is 6 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3416      +/-   ##
==========================================
+ Coverage   28.27%   29.80%   +1.53%     
==========================================
  Files          77       77              
  Lines       18428    20836    +2408     
==========================================
+ Hits         5210     6211    +1001     
- Misses      13218    14625    +1407     

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

Copy link
Copy Markdown
Contributor

@jonmaddock jonmaddock left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great Chris, thanks for doing this.

@chris-ashe chris-ashe merged commit 498e75b into main Dec 9, 2024
@chris-ashe chris-ashe deleted the 3410-more-namespace-standards-for-physics-and-engineering-variables branch December 9, 2024 11:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements or additions to documentation Variable rename

Projects

None yet

Development

Successfully merging this pull request may close these issues.

More namespace standards for physics and engineering variables

4 participants