Installation

Warning

fmdt-python requires a version of Python more recent than 3.10.

We can access the fmdt module using either pip or by directly cloning the source code repository. We recommend using pip as it ensures that fmdt will be located when we use import.

pipGitHub

fmdt-python can be installed using pip:

pip install fmdt-python

If you are using Windows or MacOS, you may have to replace pip by pip3.

Once you've installed fmdt-python, open up any python instance and try importing the package via the alias fmdt:

>>> import fmdt

If there are no error messages, then the python module fmdt was imported successfully. To confirm fmdt-python's installation, try executing:

>>> help(fmdt)

Congrats! You've successfully installed fmdt-python and you are ready to move on to the next steps!

The source code for fmdt-python can be obtained by cloning the github repository.

sshhttps

git clone git@github.com:ejovo13/fmdt_python_clean.git

git clone https://github.com/ejovo13/fmdt_python_clean.git

Cloning the github repository provieds you access to sample python scripts that demonstrate the basic usage of fmdt-python

Next Steps

Now that you have access to the fmdt module through python, make sure that you have the executables fmdt-detect and fmdt-visu compiled and in your system's path. For instructions on compiling this software, we defer to the main project's documentation.

Once all that is complete, try working through a few tutorials!