Installation

Table of Contents

• Install the fdog package
• Setup fdog
• Update fdog
• Uninstall fdog

fDOG is distributed as a python package called fdog. It is compatible with Python ≥ v3.7.

Install the fdog package

You can install fdog using pip:

python3 -m pip install fdog

or, in case you do not have admin rights, and don't use package systems like Anaconda to manage environments you need to use the --user option:

python3 -m pip install --user fdog

and then add the following line to the end of your ~/.bashrc or ~/.bash_profile file, restart the current terminal to apply the change (or type source ~/.bashrc):

export PATH=$HOME/.local/bin:$PATH

Setup fdog

After installing fdog, you need to setup fdog to get its dependencies and pre-calculated data.

NOTE: in case you haven't installed greedyFAS before, it will be installed automatically within fDOG setup. However, you need to run setupFAS after fDOG setup finished before actually using fDOG!

You can setup fDOG by running this command

fdog.setup -o /output/path/for/fdog/data

or, in case you are using Anaconda

fdog.setup -o /output/path/for/fdog/data --conda

You should have the sudo password ready, otherwise some missing dependencies cannot be installed. See dependency list for more info. If you do not have root privileges, ask your admin to install those dependencies using fdog.setup --lib command.

Pre-calculated data set of fdog will be saved in /output/path/for/fdog/data. The path to this directory will be stored within installed fdog package and is required for many fdog functions.

After the setup run successfully, you can start using fdog. Please make sure to check if you need to run setupFAS first.

You will get a warning if any of the dependencies are not ready to use, please solve those issues and rerun fdog.setup.

For debugging the setup, please create a log file by running the setup as e.g. fdog.setup | tee log.txt for Linux/MacOS or fdog.setup --conda | tee log.txt for Anaconda and send us that log file, so that we can trouble shoot the issues. Most of the problems can be solved by just re-running the setup.

Update fdog

python3 -m pip install --upgrade fdog

Or

python3 -m pip install --user --upgrade fdog

if you have installed fdog with --user option.

In most of the cases, you don't need to run fdog.setup again. Your old data will still be available.

Uninstall fdog

fdog.remove [--data]

This command will uninstall fdog and all the data or files saved within the installed fdog directory (optional, only when --data option is used).

If you see this warning

WARNING: Skipping fdog as it is not installed.

probably you have multiple versions of Python running on your machine. In this case, you can manually uninstall fdog by using the command

pip uninstall fdog

and delete the installed folder fdog within your Python library directory.