Prerequisites for installing the TDDA Python Module

Quick Summary

This is a summary of what you need to set up in order to use the tdda python library and tools.
More detailed step-by-step instructions follow below, if needed.

  1. PYTHON. Check you have an appropriate version of Python installed (ideally 3.7, but 3.6 or 2.7 are ok too).
  2. PANDAS. Install the pandas module if you don't already have it.
  3. TDDA. Install the tdda module.
  4. CHECK INSTALLATION. Make sure you can run the tdda command-line tool and can use the tdda library from within python.

The following instructions expect you to run commands in a
Command Prompt for Windows or Terminal for Mac or Linux
Commands which are the same on all platforms are displayed as All Platforms

1. Python

Python installation

Check Installation Path

Find the full path for your python installation by running the following:

Windows where python
Mac or Linux type python

This will report on where the python command is installed. You will need this path for the following steps.

2. Install pandas

First, check to see if you already have the pandas module installed, by running python, and then:

All Platforms >>> import pandas
>>> pandas.__version__

If that works ok without any errors or warnings, and reports a version of pandas that is 0.23.0 or later, then there's nothing more to do for pandas.

If you don't have pandas installed at all, run the following:

All Platforms python -m pip install pandas

If you do have pandas installed, but it's too old a version, you can upgrade it by running the following:

All Platforms python -m pip install --upgrade pandas

Run as Administrator if necessary

If these python -m pip commands fail with an error about permissions, then you need to run it with administrator privileges, as follows:

Check the module has been installed correctly

Confirm that you have installed pandas into the right instance of Python, by repeating the import pandas step, which should now succeed.

3. Install tdda

Install module

Run the following in a command prompt window:

All Platforms python -m pip install tdda

If it fails with an error about permissions, you need to run it with administrator privileges. Run the same steps for Adminstrator installation above (for pandas), but using 'tdda' instead of 'pandas'.

Check module has been installed correctly

Then confirm that you can use the tdda library from within python by running python, and then:

All Platforms >>> import tdda

It should import the library without generating any errors or warnings.

Set PATH Environment

When you installed the tdda module, it will have reported that it was also installing the tdda and rexpy command-line tools.

Check that your PATH environment variable includes the folder where the command-line tools have been installed, with:

Windows echo %PATH%
Mac or Linux echo $PATH

If your PATH doesn't include the folder where the command-line tools have been installed, set it with:

Windows set PATH=<tdda-tools-folder>;%PATH%
Mac or Linux export PATH=<tdda-tools-folder>:$PATH

4. Check Installation

  1. Confirm that the tdda command is correctly installed by running the following:

    All Platforms tdda

    It should show a summary of all of the subcommands available through tdda, like the following screenshot:

  2. Confirm that the version of the tdda library is 1.0.22 by running the following:

    All Platforms tdda version

    If some earlier version is reported, upgrade the library with:

    All Platforms python -m pip install --upgrade tdda
  3. Finally, confirm that the tdda library's own self-tests all pass by running the following, and checking that it reports that all tests pass OK.

    All Platforms tdda test