search

beam-tracing / Scotty

Beam tracing code for diagnostics
https://scotty.readthedocs.io/en/latest/
GNU General Public License v3.0
7 stars 4 forks source link

Inconsistent variable names for the magnitude of K #90

Open valerian-chen opened 1 year ago

valerian-chen commented 1 year ago

@ZedThree, I notice you've changed _cutoff to K_min; the old name was causing a lot of confusion and this is a welcome improvement. When looking through the code, I notice that the magnitude of K has different names. Similarly, we have B_total, which is again a different convention. Do you have any advice on a standardised name for magnitudes of vectors?

I used to think _mag, but I now realise that it could be confused for magnetic field.

ZedThree commented 1 year ago

total, magnitude, and mag all read ok to me. It's more important to be consistent, and having a glossary in the docs to explain the naming convention would go a long way to aiding understanding, whichever form you pick.

Maybe before the next release, we pick some conventions and have a "great renaming" to make sure everything is consistent?

valerian-chen commented 1 year ago

Sounds great.

  1. Standardised nomenclature for magnitudes of vectors
  2. Renaming of H to H_bar, since our H is really the Booker quartic H and we should be consistent
  3. Tidying up the _analysis, _array, and _output suffixes