Skip to content

Commit 388e4da

Browse files
committed
docs update for installer
1 parent e6f232b commit 388e4da

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

docs/gettingstarted.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,31 @@ This page describes how to get started with ActivitySim.
1111
.. index:: installation
1212

1313

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

0 commit comments

Comments
 (0)