kgullikson88 / Telluric-Fitter

Telluric fitting made easy
http://telfit.readthedocs.org/en/latest/
MIT License
20 stars 17 forks source link

Expand Installation documentation to include a "pitfalls" or "common problems" section. #36

Open gully opened 3 years ago

gully commented 3 years ago

Ten issues out of 25 total issues relate to installation: forty percent of all Issues are about merely getting telfit to install. I have added the installation label to all of these Issues. Those issue reports likely come from the users most motivated to get it to install, which means many other users probably attempt to install telfit, it doesn't work, and they simply move on to try some other solution, suggesting that the installation issues are even more common than we may think.

Friction with installation makes sense: the code depends intimately on compiling heritage fortran code, some of which is platform-specific and compiler-specific. While some of these Installation woes have been resolved and closed, Installation probably remains one of the thorniest issues with telfit.

Some of the installation issues are still open since they are the sole source of this collective installation wisdom in the community. Here we proposes to distill that wisdom into a few key common pitfalls in the telfit installation instructions. Can you help?

If so please read any/all of the GitHub Issues that possess the label "Installation". Read the Issue and find the key idea: what caused the problem, how common is it? What was the solution? Then take that insight and edit the installation.rst file in docs/. Get creative--- consider adding a "Mac-specific guide" or something that resonates with you.