Small refactor and some more docstrings

diffsims/generators/diffraction_generator.py

@@ -36,6 +36,7 @@
     get_vectorized_list_for_atomic_scattering_factors,
     is_lattice_hexagonal,
     get_intensities_params,
+    get_scattering_params_dict
 )
 from diffsims.utils.fourier_transform import from_recip
 
@@ -76,18 +77,9 @@ def __init__(
                 "This class changed in v0.3 and no longer takes a maximum_excitation_error"
             )
         self.wavelength = get_electron_wavelength(accelerating_voltage)
+        self.scatterng_params = get_scattering_params_dict(scattering_params)
         self.debye_waller_factors = debye_waller_factors
 
-        scattering_params_dict = {"lobato": "lobato", "xtables": "xtables"}
-        if scattering_params in scattering_params_dict:
-            self.scattering_params = scattering_params_dict[scattering_params]
-        else:
-            raise NotImplementedError(
-                "The scattering parameters `{}` is not implemented. "
-                "See documentation for available "
-                "implementations.".format(scattering_params)
-            )
-
     def calculate_ed_data(
         self,
         structure,

diffsims/utils/sim_utils.py

@@ -238,15 +238,15 @@ def get_kinematical_intensities(
     structure : Structure
         The structure for which to derive the structure factors.
     g_indices : array-like
-
+        Indicies of spots to be considered
     g_hkls_array : array-like
-
-    debye_waller_factors : bool
-
-    scattering_params :
-
-    prefactor :
-
+        coordinates of spots to be considered
+    debye_waller_factors : dict of str:value pairs
+        Maps element names to their temperature-dependent Debye-Waller factors.
+    scattering_params : str
+        "lobato" or "xtables"
+    prefactor : array-like
+        multiplciation factor for structure factor
     Returns
     -------
     peak_intensities : array-like