Merge pull request #639 from camsys/depend-sklearn

add scikit-learn to formal dependencies

Author: jpn--

conda-environments/activitysim-dev-base.yml

@@ -59,6 +59,7 @@ dependencies:
 - rich
 - ruby  # required for benchmarking pre-commit hooks
 - setuptools_scm
+- scikit-learn >= 1.1
 - simwrapper > 1.7
 - snakeviz  # for profiling
 - sphinx

conda-environments/activitysim-dev.yml

@@ -55,6 +55,7 @@ dependencies:
 - rich
 - ruby  # required for benchmarking pre-commit hooks
 - setuptools_scm
+- scikit-learn >= 1.1
 - sharrow >= 2.5.2
 - simwrapper > 1.7
 - snakeviz  # for profiling

conda-environments/docbuild.yml

@@ -41,6 +41,7 @@ dependencies:
 - pytest-regressions
 - pyyaml >= 5.1
 - requests >= 2.7
+- scikit-learn >= 1.1
 - sharrow >= 2.5.2
 - simwrapper > 1.7
 - sphinx-argparse

conda-environments/github-actions-tests.yml

@@ -26,6 +26,7 @@ dependencies:
 - pytest-regressions
 - pyyaml >= 5.1
 - requests >= 2.7
+- scikit-learn >= 1.1
 - sharrow >= 2.5.2
 - simwrapper > 1.7
 - scikit-learn >= 1.1.1

docs/gettingstarted.rst

@@ -11,6 +11,31 @@ This page describes how to get started with ActivitySim.
 .. index:: installation
 
 
+Pre-packaged Installer
+----------------------
+
+Begining with version 1.2, ActivitySim is now available for Windows via a
+pre-packaged installer.  This installer provides everything you need to run
+ActivitySim, including Python, all the necessary supporting packages, and
+ActivitySim itself.  You should only choose this installation process if you
+plan to use ActivitySim but you don't need or want to do other Python
+development.  Note this installer is provided as an "executable" which (of course)
+installs a variety of things on your system, and it is quite likely to be flagged by
+Windows, anti-virus, or institutional IT policies as "unusual" software, which
+may require special treatment to actually install and use.
+
+Download the installer from GitHub `here <https://github.com/ActivitySim/activitysim/releases/download/v1.2.0/Activitysim-1.2.0-Windows-x86_64.exe`__.
+It is strongly recommended to choose the option to install "for me only", as this
+should not require administrator privileges on your machine.  Pay attention
+to the *complete path* of the installation location. You will need to know
+that path to run ActivitySim in the future, as the installer does not modify
+your "PATH" and the location of the `ActivitySim.exe` command line tool will not
+be available without knowing the path to where the install has happened.
+
+Once the install is complete, ActivitySim can be run directly from any command
+prompt by running `<install_location>/Scripts/ActivitySim.exe`.
+
+
 Installation
 ------------
 

setup.cfg

@@ -35,6 +35,7 @@ install_requires =
     pypyr >= 5.3
     pyyaml >= 5.1
     requests >= 2.7
+    scikit-learn >= 1.1
     sharrow >= 2.5
     simwrapper > 1.7
     tables >= 3.5.1