Skip to content

Commit

Permalink
Merge pull request #4 from KevinCawley/documentation
Browse files Browse the repository at this point in the history
Fixed two random indentation irregularities found upon review
  • Loading branch information
KevinCawley authored Nov 25, 2020
2 parents ef40bb3 + a2a36e6 commit 56c5067
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 16 deletions.
30 changes: 15 additions & 15 deletions tardis/plasma/properties/atomic.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,13 @@ class Levels(BaseAtomicDataProperty):
Attributes
----------
levels : Pandas MultiIndex (atomic_number, ion_number, level_number)
Index of filtered atomic data. Index used for all other attribute dataframes for this class
Index of filtered atomic data. Index used for all other attribute dataframes for this class
excitation_energy : Pandas DataFrame (index=levels), dtype float
Excitation energies of atomic levels
Excitation energies of atomic levels
metastability : Pandas DataFrame (index=levels), dtype bool
Records whether atomic levels are metastable
Records whether atomic levels are metastable
g : Pandas DataFrame (index=levels), dtype float
Statistical weights of atomic levels
Statistical weights of atomic levels
"""

outputs = ("levels", "excitation_energy", "metastability", "g")
Expand Down Expand Up @@ -69,13 +69,13 @@ class Lines(BaseAtomicDataProperty):
----------
lines : Pandas DataFrame (wavelength, atomic_number, ion_number, f_ul, f_lu, level_number_lower,
level_number_upper, nu, B_lu, B_ul, A_ul, wavelength)
All atomic lines data. Index = line_id.
All atomic lines data. Index = line_id.
nu : Pandas DataFrame (index=line_id), dtype float
Line frequency data
Line frequency data
f_lu : Pandas DataFrame (index=line_id), dtype float
Transition probability data
Transition probability data
wavelength_cm : Pandas DataFrame (index=line_id), dtype float
Line wavelengths in cm
Line wavelengths in cm
"""

# Would like for lines to just be the line_id values
Expand All @@ -99,15 +99,15 @@ class PhotoIonizationData(ProcessingPlasmaProperty):
'ion_number',
'level_number']),
dtype float)
Table of photoionization cross sections as a
function of frequency.
Table of photoionization cross sections as a
function of frequency.
photo_ion_block_references : One-dimensional Numpy Array, dtype int
Indices where the photoionization data for
a given level starts. Needed for calculation
of recombination rates.
Indices where the photoionization data for
a given level starts. Needed for calculation
of recombination rates.
photo_ion_index : Pandas MultiIndex, dtype int
Atomic, ion and level numbers for which
photoionization data exists.
Atomic, ion and level numbers for which
photoionization data exists.
"""

outputs = (
Expand Down
2 changes: 1 addition & 1 deletion tardis/plasma/standard_plasmas.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ def assemble_plasma(config, model, atom_data=None):
Returns
-------
: plasma.BasePlasma
: plasma.BasePlasma
"""
# Convert the nlte species list to a proper format.
Expand Down

0 comments on commit 56c5067

Please sign in to comment.