Toolbox Installation¶

This section provides instructions for the toolbox installation, virtual environment usage, and running the unit tests. Python package dependencies are also listed.

Installation¶

The toolbox can be installed via The Python Package Index PyPi

It is also possible to Clone the project from GitHub repository and try it without installation.

Pip install¶

Pip installation is the recommended way to install the toolbox.

Pip install:

pip install tscfat

Cloning the repository¶

The source code is currently hosted on GitHub at: <https://github.com/ArgonSilicon/tscfat/>. To clone the repository, open the terminal and change your current working directory to the location where you want to clone the repository directory. Then type in the following clone command:

git clone https://github.com/ArgonSilicon/tscfat

The cloned respository should have the following folder structure:

tscfat
├── Data
├── Docs
├── Results
├── Tests
├── _build
├── dist
└── tscfat

Here the most important subfolders are:

Data folder contains example data sets
Docs folder contains the toolbox documentation
Results is the default analysis output folder
Tests contains pytest tests
tscfat contains the Python modules and utility functions needed for the analysis

Dependencies¶

The toolbox requires Python version 3.7. or higher to work. In addition, it is dependent on the following packages:

Virtual environment¶

If the package is not installed via pip, it is possible to run the toolbox using the Pipenv virtual environment bundled with the toolbox.

Pipenv can be installed by using pip install:

pip install pipenv

MAke sure the current working directory is the tscfat root folder and activate the virtual environment:

pipenv install

Running the python scripts inside the environment:

pipenv run python <... /python_script.py>

Running unit tests¶

Inside the tscfat root folder, you may run pytest unittests using the activated virtual environment:

pipenv run pytest