search

chianti-atomic / ChiantiPy

ChiantiPy is a python package to calculate the radiative properties of astrophysical plasmas based on the CHIANTI atomic database
63 stars 32 forks source link

Fixing typo #428

Closed AlexandrosKoukras closed 1 year ago

AlexandrosKoukras commented 1 year ago

Suggested modifications concerning #427.

Modifications

  1. Changed the typo date to data
  2. Added more detailed description of the function, including sections about parameters,returns and examples. I tried to stay consistent with PEP 257 and I followed the structure of numpy docs
  3. Extended the utility of the verbose parameter in order for the user to be able to handle the printing of the interpolated values or not
  4. Added the ability for the function to receive N-D data as input. I added this because when I was using the function I was working mostly with 2D maps of intensities ratios, so it was more convenient to be able to pass them directly to the function. If you feel that this is outside the scope of this function, feel free to disregarded it.
kdere commented 1 year ago

I merged your version. It looks to be very complete. Thanks