Moves a couple of functions to the correct 0-based var names

tardis-sn · Sep 10, 2024 · c90ab06 · c90ab06
1 parent 09bd62c
commit c90ab06
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/carsus/io/util.py b/carsus/io/util.py
@@ -62,7 +62,7 @@ def convert_species_tuple2chianti_str(species):
 
     Parameters
     -----------
-    species: tuple (atomic_number, ion_number)
+    species: tuple (atomic_number, ion_charge)
 
     Returns
     --------
@@ -78,8 +78,8 @@ def convert_species_tuple2chianti_str(species):
     'si_2'
 
     """
-    atomic_number, ion_number = species
-    chianti_ion_name = convert_atomic_number2symbol(atomic_number).lower() + '_' + str(ion_number + 1)
+    atomic_number, ion_charge = species
+    chianti_ion_name = convert_atomic_number2symbol(atomic_number).lower() + '_' + str(ion_charge + 1)
     return chianti_ion_name
 
 

diff --git a/carsus/util/selected.py b/carsus/util/selected.py
@@ -112,7 +112,7 @@ def parse_selected_atoms(atoms):
 def parse_selected_species(species):
     """
     Parse the sting specifying selected species to the list of tuples in the
-    form (atomic_number, ion_number).
+    form (atomic_number, ion_charge).
 
     Parameters
     ----------
@@ -125,7 +125,7 @@ def parse_selected_species(species):
 
     Returns
     -------
-    list of tuples (atomic_number, ion_number)
+    list of tuples (atomic_number, ion_charge)
         List of selected ions
 
     Examples