Installing Pre-Built Tracktable¶

Attention

For all installation issues and errors encountered in the steps below refer to the Common Issues & Errors Page.

Attention

We highly recommend using Anaconda to install and manage tracktable and it’s dependencies.

Pip¶

As of Version 1.2, Tracktable is available on the Python Package Index (PyPI, https://pypi.org) and can be installed with pip as long as you’re running Python 3.5 or newer. (Note: Each new release is generally limited to those versions of Python that are supported at release time. Tracktable 1.7, for example, supports Python 3.9 - 3.11.) Use the following command to install from Pip:

pip install tracktable

Anaconda Virtual Environment¶

If you have Anaconda installed then the Anaconda virtual environment commands below will create and configure a virtual environment that is ready to use Tracktable. Enter the following commands in a command/terminal/Anaconda prompt.

Create the Anaconda virtual environment

There are two ways to create an tracktable anaconda virtual environment:
- Creating a virtual environment from an conda environment.yml file
  
  We include a YML configuration file (tracktable_environment.yml) that can be used to create an Anaconda virtual environment named tracktable. This file will create the environment in one shot and doesn’t require any additional package installation after the environment is activated.
```
conda env create -f /path/to/tracktable_environment.yml
```
  Important
  
  Be sure to substitute the location where you saved tracktable_environment.yml in the command above.
- Creating a virtual environment from listed packages
```
conda create --name tracktable --channel conda-forge python tracktable
```
Verify that the tracktable virtual environment was created
```
conda env list
```
Activate the virtual environment
```
conda activate tracktable
```
Deactivate the virtual environment (optional)
```
conda deactivate
```
Delete the virtual environment when it is no longer needed

conda remove --name tracktable --all

Note for Windows Users¶

If you are using Tracktable under Windows, you might also need to install the C++ runtime library. This is a necessary component for any program compiled with Microsoft’s Visual C++ suite. You can get it from the following URL:

https://aka.ms/vs/16/release/vc_redist.x64.exe

The most common indication that you’re missing this library is an import error, Error importing Tracktable's core types library., when you try to import Tracktable in a Python interpreter.