Update docs, check version in model constructor

Author: WardBrian

cmdstanpy/model.py

@@ -2,14 +2,12 @@
 
 import io
 import os
-import platform
 import re
 import shutil
 import subprocess
 import sys
 import tempfile
 import threading
-from collections import OrderedDict
 from concurrent.futures import ThreadPoolExecutor
 from io import StringIO
 from multiprocessing import cpu_count
@@ -41,12 +39,8 @@
     RunSet,
     from_csv,
 )
-from cmdstanpy.utils import (
-    cmdstan_path,
-    cmdstan_version_before,
-    do_command,
-    get_logger,
-)
+from cmdstanpy.utils import do_command, get_logger
+from cmdstanpy.utils.cmdstan import cmdstan_version_before, windows_tbb_path
 from cmdstanpy.utils.filesystem import (
     temp_inits,
     temp_metrics,
@@ -118,6 +112,8 @@ def __init__(
 
         self._fixed_param = False
 
+        windows_tbb_path()
+
         if exe_file is not None:
             self._exe_file = os.path.realpath(os.path.expanduser(exe_file))
             if not os.path.exists(self._exe_file):
@@ -169,26 +165,21 @@ def __init__(
                 if 'parameters' in model_info:
                     self._fixed_param |= len(model_info['parameters']) == 0
 
-        if platform.system() == 'Windows':
-            try:
-                do_command(['where.exe', 'tbb.dll'], fd_out=None)
-            except RuntimeError:
-                # Add tbb to the $PATH on Windows
-                libtbb = os.environ.get('STAN_TBB')
-                if libtbb is None:
-                    libtbb = os.path.join(
-                        cmdstan_path(), 'stan', 'lib', 'stan_math', 'lib', 'tbb'
-                    )
-                get_logger().debug("Adding TBB (%s) to PATH", libtbb)
-                os.environ['PATH'] = ';'.join(
-                    list(
-                        OrderedDict.fromkeys(
-                            [libtbb] + os.environ.get('PATH', '').split(';')
-                        )
-                    )
-                )
-            else:
-                get_logger().debug("TBB already found in load path")
+        # check CmdStan version compatibility
+        exe_info = None
+        try:
+            exe_info = self.exe_info()
+        # pylint: disable=broad-except
+        except Exception as e:
+            get_logger().warning(
+                'Could not get exe info for model %s, error: %s',
+                self._name,
+                str(e),
+            )
+        if cmdstan_version_before(2, 35, exe_info):
+            raise RuntimeError(
+                "This version of CmdStanPy requires CmdStan 2.35 or higher."
+            )
 
     def __repr__(self) -> str:
         return (

cmdstanpy/utils/cmdstan.py

@@ -12,6 +12,7 @@
 from tqdm.auto import tqdm
 
 from cmdstanpy import _DOT_CMDSTAN
+from cmdstanpy.utils.command import do_command
 
 from .. import progress as progbar
 from .logging import get_logger
@@ -431,6 +432,29 @@ def cxx_toolchain_path(
     return compiler_path, tool_path
 
 
+def windows_tbb_path() -> None:
+    if platform.system() == 'Windows':
+        try:
+            do_command(['where.exe', 'tbb.dll'], fd_out=None)
+        except RuntimeError:
+            # Add tbb to the $PATH on Windows
+            libtbb = os.environ.get('STAN_TBB')
+            if libtbb is None:
+                libtbb = os.path.join(
+                    cmdstan_path(), 'stan', 'lib', 'stan_math', 'lib', 'tbb'
+                )
+            get_logger().debug("Adding TBB (%s) to PATH", libtbb)
+            os.environ['PATH'] = ';'.join(
+                list(
+                    OrderedDict.fromkeys(
+                        [libtbb] + os.environ.get('PATH', '').split(';')
+                    )
+                )
+            )
+        else:
+            get_logger().debug("TBB already found in load path")
+
+
 def install_cmdstan(
     version: str | None = None,
     dir: str | None = None,

cmdstanpy_tutorial.ipynb

@@ -79,12 +79,6 @@
     "or whichever name you used for your environment (following `-n`\n",
     "above).\n",
     "\n",
-    "Note that CmdStan is only available on conda for versions\n",
-    "2.27.0 and newer. If you require an older version, you must use\n",
-    "one of the following methods to install it. If you require a\n",
-    "version of CmdStan *newer* than 2.27.0, but not the latest,\n",
-    "you can install it in the standard conda way by specifying\n",
-    "`cmdstan==VERSION` in the install command.\n",
     "\n",
     "#### Pip (non-Conda) users \n",
     "\n",

docsrc/installation.rst

@@ -1,11 +1,13 @@
 Installation
 ============
 
-CmdStanPy is a pure-Python3 package which wraps CmdStan,
+CmdStanPy is a pure-Python package which wraps CmdStan,
 the command-line interface to Stan which is written in C++.
-Therefore, in addition to Python3,
-CmdStanPy requires a modern C++ toolchain in order to build and run Stan models.
-There are several ways to install CmdStanPy and the underlying CmdStan components.
+
+Therefore, CmdStanPy requires a modern C++ toolchain in order to build and run
+Stan models, as well as a recent version of CmdStan (released within the year
+prior to the release of the CmdStanPy version being used). There are several
+ways to install CmdStanPy and the underlying CmdStan components.
 
 * You can download CmdStanPy, CmdStan, and the C++ toolchain from conda-forge.