chianti-atomic / ChiantiPy

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

Clarify emission measure units in the function documentations. #398

Closed MadFisa closed 2 years ago

MadFisa commented 2 years ago

Hi,

This is a suggestion to improve some of the documentation. It would be great to add the units of emission measure in some of the documentation of classes such as that of spectrum, mspectrum, ipymspectrum etc, as the other units are clearly mentioned ( such as temperature, eDensity, and wavelength). It is in cm^-5 as far as I understand and is not clearly mentioned in the documentation or the quickstart guides as far as I can see. Clearly stating it would help the new users.

Asif

kdere commented 2 years ago

I agree. There should be some sort of introduction in the documentations.

kdere commented 2 years ago

This will be in the quick start documentation for the upcoming 0.15.0 release