More documentations on the README file

mcyc / crispy

Computational Ridge Identification with SCMS for Python

GNU General Public License v3.0

9 stars 2 forks source link

More documentations on the README file #25

Open mcyc opened 9 months ago

mcyc commented 9 months ago

The README file can use more documentation to help familiarize new users with the practical aspects of running the software. For example, guides on suitable starting parameters or tips on how to improve running efficiencies.

mcyc commented 9 months ago

Tips on input parameters have been added in commit 949990e45b639948a68e87b4d8dbffa0e23bfe87.

mcyc commented 9 months ago

We can use an astronomy tip section. For example, commenting on the need for a deblended cube for non-Gaiussian lines or notes on what to do with a very long spectral/velocity axis.