Merge pull request #456 from stan-dev/rebuild-fn

Add a rebuild_cmdstan function

Author: mitzimorris

cmdstanpy/__init__.py

@@ -36,6 +36,7 @@ def _cleanup_tmpdir() -> None:
 
 
 from ._version import __version__  # noqa
+from .install_cmdstan import rebuild_cmdstan
 from .model import CmdStanModel  # noqa
 from .stanfit import (  # noqa
     CmdStanGQ,
@@ -68,4 +69,5 @@ def _cleanup_tmpdir() -> None:
     'from_csv',
     'write_stan_json',
     'show_versions',
+    'rebuild_cmdstan',
 ]

cmdstanpy/install_cmdstan.py

@@ -31,7 +31,13 @@
 from typing import Callable, Dict, Optional
 
 from cmdstanpy import _DOT_CMDSTAN, _DOT_CMDSTANPY
-from cmdstanpy.utils import get_logger, pushd, validate_dir, wrap_progress_hook
+from cmdstanpy.utils import (
+    cmdstan_path,
+    get_logger,
+    pushd,
+    validate_dir,
+    wrap_progress_hook,
+)
 
 MAKE = os.getenv(
     'MAKE', 'make' if platform.system() != 'Windows' else 'mingw32-make'
@@ -174,6 +180,27 @@ def compile_example() -> None:
         raise CmdStanInstallError('\n'.join(msgs))
 
 
+def rebuild_cmdstan(verbose: bool = True) -> None:
+    """
+    Rebuilds the existing CmdStan installation.
+    This assumes CmdStan has already been installed,
+    though it need not be installed via CmdStanPy for
+    this function to work.
+
+    :param verbose:  Boolean value; when ``True``, output from CmdStan build
+        processes will be streamed to the console.  Default is ``False``.
+    """
+    try:
+        with pushd(cmdstan_path()):
+            clean_all(verbose)
+            build(verbose)
+            compile_example()
+    except ValueError as e:
+        raise CmdStanInstallError(
+            "Failed to rebuild CmdStan. Are you sure it is installed?"
+        ) from e
+
+
 def install_version(
     cmdstan_version: str, overwrite: bool = False, verbose: bool = False
 ) -> None:

cmdstanpy/model.py

@@ -348,7 +348,7 @@ def compile(
                                 "CmdStan's precompiled header (PCH) files "
                                 "may need to be rebuilt."
                                 "If your model failed to compile please run "
-                                "install_cmdstan(overwrite=True).\nIf the "
+                                "cmdstanpy.rebuild_cmdstan().\nIf the "
                                 "issue persists please open a bug report",
                             )
 

test/test_install_cmdstan.py

@@ -1,11 +1,14 @@
 """install_cmdstan test"""
 
+import os
 import unittest
 
 from cmdstanpy.install_cmdstan import (
+    CmdStanInstallError,
     CmdStanRetrieveError,
     is_version_available,
     latest_version,
+    rebuild_cmdstan,
     retrieve_version,
 )
 
@@ -34,6 +37,13 @@ def test_retrieve_version(self):
         with self.assertRaises(ValueError):
             retrieve_version('')
 
+    @unittest.mock.patch.dict(os.environ, {"CMDSTAN": "~/some/fake/path"})
+    def test_rebuild_bad_path(self):
+        with self.assertRaisesRegex(
+            CmdStanInstallError, "you sure it is installed"
+        ):
+            rebuild_cmdstan()
+
 
 if __name__ == '__main__':
     unittest.main()