diff --git a/README.md b/README.md index cfb6114..aaf7c9e 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,23 @@ Prophet is on PyPI, so you can use pip to install it: $ pip install fbprophet ``` -The major dependency that Prophet has is `pystan`. PyStan has its own [installation instructions](http://pystan.readthedocs.io/en/latest/installation_beginner.html). Install pystan with pip before using pip to install fbprophet. You may also try the (more experimental) [cmdstanpy backend](https://github.com/stan-dev/cmdstanpy). +The default dependency that Prophet has is `pystan`. PyStan has its own [installation instructions](http://pystan.readthedocs.io/en/latest/installation_beginner.html). Install pystan with pip before using pip to install fbprophet. + +You can also choose a (more experimental) alternative stan backend called `cmdstanpy`. It requires the [CmdStan](https://mc-stan.org/users/interfaces/cmdstan) command line interface and you will have to specify the environment variable `STAN_BACKEND` pointing to it, for example: + +``` +# bash +$ CMDSTAN=/tmp/cmdstan-2.22.1 STAN_BACKEND=CMDSTANPY pip install fbprophet +``` + +Note that the `CMDSTAN` variable is directly related to `cmdstanpy` module and can be omitted if your CmdStan binaries are in your `$PATH`. + +It is also possible to install Prophet with two backends: + +``` +# bash +$ CMDSTAN=/tmp/cmdstan-2.22.1 STAN_BACKEND=PYSTAN,CMDSTANPY pip install fbprophet +``` After installation, you can [get started!](https://facebook.github.io/prophet/docs/quick_start.html#python-api)