Merge branch 'develop' of https://github.com/stan-dev/cmdstanpy into develop

Author: mitzimorris

cmdstanpy/install_cmdstan.py

@@ -258,7 +258,7 @@ def get_toolchain_version(name: str, version: str) -> str:
     return toolchain_folder
 
 
-def main(args: Dict[str, Any]) -> None:
+def run_rtools_install(args: Dict[str, Any]) -> None:
     """Main."""
     if platform.system() not in {'Windows'}:
         raise NotImplementedError(
@@ -361,7 +361,7 @@ def parse_cmdline_args() -> Dict[str, Any]:
 
 
 def __main__() -> None:
-    main(parse_cmdline_args())
+    run_rtools_install(parse_cmdline_args())
 
 
 if __name__ == '__main__':

cmdstanpy/install_cxx_toolchain.py

@@ -482,7 +482,7 @@ def compile(
             src_time = os.path.getmtime(self._stan_file)
             exe_time = os.path.getmtime(exe_target)
             if exe_time > src_time and not force:
-                get_logger().info('found newer exe file, not recompiling')
+                get_logger().debug('found newer exe file, not recompiling')
                 if self._exe_file is None:  # called from constructor
                     self._exe_file = exe_target
                 return

cmdstanpy/model.py

@@ -153,7 +153,10 @@ def validate_cmdstan_path(path: str) -> None:
         raise ValueError(f'No CmdStan directory, path {path} does not exist.')
     if not os.path.exists(os.path.join(path, 'bin', 'stanc' + EXTENSION)):
         raise ValueError(
-            'CmdStan installataion missing binaries, run "install_cmdstan"'
+            'CmdStan installataion missing binaries. '
+            'Re-install cmdstan by running command "install_cmdstan '
+            '--overwrite", or Python code "import cmdstanpy; '
+            'cmdstanpy.install_cmdstan(overwrite=True)"'
         )
 
 
@@ -183,14 +186,14 @@ def cmdstan_path() -> str:
         cmdstan_dir = os.path.expanduser(os.path.join('~', _DOT_CMDSTAN))
         if not os.path.exists(cmdstan_dir):
             raise ValueError(
-                'No CmdStan installation found, run "install_cmdstan" or'
-                ' (re)activate your conda environment!'
+                'No CmdStan installation found, run command "install_cmdstan"'
+                'or (re)activate your conda environment!'
             )
         latest_cmdstan = get_latest_cmdstan(cmdstan_dir)
         if latest_cmdstan is None:
             raise ValueError(
-                'No CmdStan installation found, run "install_cmdstan" or'
-                ' (re)activate your conda environment!'
+                'No CmdStan installation found, run command "install_cmdstan"'
+                'or (re)activate your conda environment!'
             )
         cmdstan = os.path.join(cmdstan_dir, latest_cmdstan)
         os.environ['CMDSTAN'] = cmdstan
@@ -1273,14 +1276,16 @@ def install_cmdstan(
     progress: bool = False,
     verbose: bool = False,
     cores: int = 1,
+    *,
+    interactive: bool = False,
 ) -> bool:
     """
     Download and install a CmdStan release from GitHub. Downloads the release
     tar.gz file to temporary storage.  Retries GitHub requests in order
     to allow for transient network outages. Builds CmdStan executables
     and tests the compiler by building example model ``bernoulli.stan``.
 
-    :param version: CmdStan version string, e.g. "2.24.1".
+    :param version: CmdStan version string, e.g. "2.29.2".
         Defaults to latest CmdStan release.
 
     :param dir: Path to install directory.  Defaults to hidden directory
@@ -1304,36 +1309,60 @@ def install_cmdstan(
     :param cores: Integer, number of cores to use in the ``make`` command.
         Default is 1 core.
 
+    :param interactive: Boolean value; if true, ignore all other arguments
+        to this function and run in an interactive mode, prompting the user
+        to provide the other information manually through the standard input.
+
+        This flag should only be used in interactive environments,
+        e.g. on the command line.
+
     :return: Boolean value; ``True`` for success.
     """
     logger = get_logger()
-    args = {
-        "version": version,
-        "overwrite": overwrite,
-        "verbose": verbose,
-        "compiler": compiler,
-        "progress": progress,
-        "dir": dir,
-        "cores": cores,
-    }
-
     try:
-        from .install_cmdstan import main
+        from .install_cmdstan import (
+            InstallationSettings,
+            InteractiveSettings,
+            run_install,
+        )
+
+        args: Union[InstallationSettings, InteractiveSettings]
 
-        main(args)
+        if interactive:
+            if any(
+                [
+                    version,
+                    dir,
+                    overwrite,
+                    compiler,
+                    progress,
+                    verbose,
+                    cores != 1,
+                ]
+            ):
+                logger.warning(
+                    "Interactive installation requested but other arguments"
+                    " were used.\n\tThese values will be ignored!"
+                )
+            args = InteractiveSettings()
+        else:
+            args = InstallationSettings(
+                version=version,
+                overwrite=overwrite,
+                verbose=verbose,
+                compiler=compiler,
+                progress=progress,
+                dir=dir,
+                cores=cores,
+            )
+        run_install(args)
     # pylint: disable=broad-except
     except Exception as e:
-        logger.warning('CmdStan installation failed.')
-        logger.warning(str(e))
+        logger.warning('CmdStan installation failed.\n%s', str(e))
         return False
 
-    if dir is not None:
-        if version is not None:
-            set_cmdstan_path(os.path.join(dir, 'cmdstan-' + version))
-        else:
-            set_cmdstan_path(
-                os.path.join(dir, get_latest_cmdstan(dir))  # type: ignore
-            )
+    set_cmdstan_path(args.dir)
+
     return True
 
 

cmdstanpy/utils.py

@@ -445,3 +445,6 @@ def emit(self, record):
     r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: "
 )
 copybutton_prompt_is_regexp = True
+
+# speed up build if editing the docs
+# nbsphinx_execute = 'never'