stan-dev / cmdstanpy

CmdStanPy is a lightweight interface to Stan for Python users which provides the necessary objects and functions to compile a Stan program and fit the model to data using CmdStan.
BSD 3-Clause "New" or "Revised" License
153 stars 69 forks source link

troubleshooting CmdStan install page for docs #562

Open mitzimorris opened 2 years ago

mitzimorris commented 2 years ago

Summary:

We need a page for troubleshooting the installation and when the install and rebuild cmdstan scripts fail, they should provide a link to this page.

Description:

I wrote the original version of these scripts and I can't get install to work for me. Pity our users. Installation is critical. Anything we can do, we should.

WardBrian commented 2 years ago

I think documentation around troubleshooting is difficult and brittle. Every user will be bringing a different system config and set of knowledge, which intersect in a massive space of possible problems.

We can certainly document a few common cases (e.g., if you get an error like make - command not found we can guess the user needs to install more software first), but I think improving the scripts and (mainly) improving the cmdstan installation process itself would go much further