search

Vital-Fernandez / lime

Line Measuring library in python
Other
14 stars 6 forks source link

Some minor documentation issues #40

Open Knusper opened 5 days ago

Knusper commented 5 days ago

Hi,

thanks for providing this awesome package, I think it will be very useful for the community.

I noticed that https://lime-stable.readthedocs.io/en/latest/introduction/api.html#lime.Spectrum states "This class creates an astronomical cube variable for an integral field spectrograph observation."

This seems like a copy & paste error, as this class creates the spectrum object.

Another small thing I noticed in the tutorial: https://lime-stable.readthedocs.io/en/latest/inputs/n_inputs1_spectra.html

Here it says

Please remember: The keys in a .fits header are not fully standarised.

That is actually not true, as the fits file format is completely standardised (note also typo) 1. The problem is rather, that many fits creators in the wild do not adhere to these standards.

If you appreciate, I might a file a PR to change these small things accordingly.

Best wishes, Christian

Vital-Fernandez commented 3 days ago

Hello @Knusper ! Thank you very much for your comments and interest in LiMe

You are right, what I should have written is that not all the longs-slit use the same style to store the data so there isn't a unique function to read every spectra file (However, I added a new .from_file attribute to create Spectrum and Cube directly from .fits files where the user provides the instrument (more instruments can be added upon request))

I want to make a new release this week that will mask inf and nan entries by default if the user does not provide a pixel mask and I will add your corrections.

Thank you very much!!

Knusper commented 3 days ago

Thanks for the quick answer. So far I really enjoy using LiMe with my data, great work I will be teaching in ~ 2 weeks at the Indo French Astronomy School in Lyon https://ifas9.sciencesconf.org/resource/page/id/1 - and the students will learn how to use LiME in my project ... I will also use it for some science project in the near future, so I keep you updated...

I have also some ideas for future developments, I will contact you in another thread...

Vital-Fernandez commented 2 days ago

Thank you very much for sharing the news. I am afraid I wont be able to upload the LiMe IFU video tutorial before the school... but I can update the https://specsy.streamlit.app/ to help with the fitting language exercices... I will keep you posted but please tell me if I can help.

Knusper commented 2 days ago

Ah -- don't worry -- the students will have me instead of a tutorial....