Skip to content

Commit 99bc67c

Browse files
committed
Document --interactive argument
1 parent c37063f commit 99bc67c

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

docsrc/installation.rst

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@ There are several ways to install CmdStanPy and the underlying CmdStan component
1111

1212
* You can download the CmdStanPy package from `PyPI <https://pypi.org>`_
1313
using `pip <https://pip.pypa.io/en/stable/>`_.
14-
14+
1515
* If you want the current development version, you can clone the
1616
GitHub `CmdStanPy <https://github.com/stan-dev/cmdstanpy>`_ repository.
1717

1818
If you install CmdStanPy from PyPI or GitHub you will need to
1919
install CmdStan as well, see section :ref:`CmdStan Installation <cmdstan-install>` below.
2020

21-
21+
2222
Conda: install CmdStanPy, CmdStan, C++ toolchain
2323
------------------------------------------------
2424

@@ -33,7 +33,7 @@ via the following command:
3333
conda create -n stan -c conda-forge cmdstanpy
3434
3535
36-
This command creates a new conda environment named ``stan`` and
36+
This command creates a new conda environment named ``stan`` and
3737
downloads and installs the ``cmdstanpy`` package
3838
as well as CmdStan and the required C++ toolchain.
3939

@@ -102,7 +102,7 @@ To install CmdStanPy with all the optional packages:
102102
GitHub: install from the CmdStanPy repository
103103
---------------------------------------------
104104

105-
105+
106106
To install the current develop branch from GitHub:
107107

108108
.. code-block:: bash
@@ -196,6 +196,11 @@ On Windows, the ``compiler`` option will install the C++ toolchain.
196196
install_cmdstan --compiler
197197
dir "%HOME%/.cmdstan"
198198
199+
The argument ``--interactive`` (or ``-i``) can be used to run
200+
the installation script in an interactive prompt. This will ask
201+
you about the various options to the installation script, with
202+
reasonable defaults set for all questions.
203+
199204
The named arguments: ``-d <directory>`` and ``-v <version>``
200205
can be used to override these defaults:
201206

@@ -220,7 +225,7 @@ CmdStanPy uses the environment variable ``CMDSTAN`` to register the CmdStan inst
220225
and the environment variable ``CMDSTAN`` is set accordingly.
221226

222227
+ If no environment variable ``CMDSTAN`` is set, CmdStanPy will try to locate
223-
a CmdStan installation in the default install location, which is a
228+
a CmdStan installation in the default install location, which is a
224229
directory named ``.cmdstan`` in your ``$HOME`` directory.
225230

226231
If you have installed CmdStan from a GitHub release or by cloning the CmdStan repository,

0 commit comments

Comments
 (0)