Installing the model involves doing some preliminaries, taking two installation steps, and then doing some clean-up:
- Preliminaries
- Step 1: Install the Tax-Analyzer-Framework
- Step 2: Install the ALI-Tax-Analyzer Model
- Clean-Up
Preliminaries
Before taking the three installation steps, create a new directory
called ali in your home directory. You can do this by opening an
operating system command prompt window (by starting the cmd app on
Windows, which should put you in your home directory). Make a note of
the name of your home directory. Then enter the following
command:
mkdir ali
and then moving into that new directory
using the
cd ali
command. (Note that when entering a
command, you need to press the Enter or Return key at the end in order
to execute the command.) Once you have done these two commands, close
the command prompt window.
The other preliminary step is required only if you are working on Windows. It is essential for Windows to show you the extension on each file name, but the default Windows settings are to not show file extensions. Follow these simple instructions to make Windows show you file extensions.
Step 1. Install the Tax-Analyzer-Framework
Do this by following these installation instructions.
Step 2. Install the ALI-Tax-Analyzer Model
Execute the following commands at the Anaconda Prompt (not in the Anaconda Navigator) if you are on Windows. On other operating systems, do the following steps at the operating system command prompt.
Activate the
tafeenvironment by executing this command:
conda activate tafeUnzip the downloaded code for the latest release in your
alidirectory. Then change to the top-level directory of the unzipped source code tree. Among other files, there should be asetup.pyfile in the top-level directory.Move into the
alitaxanalyzerdirectory (the directory that contains theanalyzer.pyfile) by entering the
cd alitaxanalyzer
command. Then download the data file. This data file, which is namedall-data.zip, is encrypted and password protected to maintain the confidentiality of the tax data. The password will be provided to you in a confidential manner. Unzip it in thealitaxanalyzerdirectory, so that there is a file namedall.csvin that directory. After confirming the existence of this file in thealitaxanalyzerdirectory, use thecd ..command to change back to the parent directory where thesetup.pyfile is located.Create and install the package by executing this command:
pip install .
which uses information in thesetup.pyfile.Confirm the existence of the ALI-Tax-Analyzer model package by changing out of that source code directory to your
alidirectory. The command
alirun --version
should show you the ALI-Tax-Analyzer version you downloaded. The command
alirun --test
should generate aPASSED TESTmessage on the screen.
Clean-Up
After taking the two installation steps, remove the ali directory.
The easiest way to do this is to use your operating system's graphical
file management system to drag the ali folder to the trash.
Remember that every time you use the model (by opening an Anaconda
Prompt on Windows or an operating system command prompt on a
non-Windows computer), you must activate the tafe environment by
executing the conda activate tafe
command.