search

BrownDwarf / gollum

A microservice for programmatic access to precomputed synthetic spectral model grids in astronomy
https://gollum-astro.readthedocs.io/
MIT License
20 stars 5 forks source link

Docs make presumption about download directory #111

Closed rhdtownsend closed 3 months ago

rhdtownsend commented 4 months ago

A number of places in the docs presume that the download directory will be ~/Downloads (see, e.g., the instructions here. While that may be true on MacOS, it certainly isn't part of the Linux FHS. Suggest making the docs more download-agnostic. For instance, in the case of the Phoenix download instructions, why not have the user directly download into their chosen spectral library directory, rather than to ~/Downloads?

Review link: https://github.com/openjournals/joss-reviews/issues/6601

Sujay-Shankar commented 4 months ago

I've pushed changes that make the documentation more download-agnostic. To your latter point, with PHOENIX, users are required to mess with the native directory structure to get it to how gollum likes it, so I think having users download to an intermediate location and then populate the final location with the correct structure is less prone to things overwriting themselves and breaking. If the current state is satisfactory, let me know and we can close this issue. Thanks for pointing this out!

Sujay-Shankar commented 3 months ago

On second thought, it's really straightforward to make gollum work with PHOENIX's default structure, so I went ahead and changed both the code and the documentation to reflect that. As long as config.env's PHOENIX key is pointing to the directory that houses all the metallicity directories as well as the wavelength file (HiResFits in the documentation's example), things should go smoothly. Closing.