pyflct: A Python wrapper for Fourier Local Correlation Tracking.

pyflct is a Python wrapper around the Fourier Local Correlation Tracking C library. Our built documentation is available here.

Installing

Linux and Mac OS

The simplest way to install this library is through pip:

$ pip install pyflct

This will install the pre-compiled binary wheels for these two platforms.

Windows

We only officially support Windows through Conda. But we do have rough instructions in our documentation if you want to install it manually.

Please find the instructions in our documentation.

Getting Help

Stop by our chat room #sunpy:matrix.org if you have any questions.

Contributing

If you would like to get involved, check out the Developer's Guide section of the SunPy docs. Help is always welcome so let us know what you like to work on, or check out the issues page for the list of known outstanding items. For more information on general contributing, please read our contributing guide.

If you want help develop pyflct you will need to install it from GitHub. The best way to do this is to create a new python virtual environment (of your choice) and then fork this repository.

Then:

$ git clone https://github.com/<username>/pyflct.git
$ cd pyflct
$ pip install -e .[dev]

You will need to install your operating system's FFTW3 development library. You might need to pip install extension_helpers if there is an error about it being missing.

You can run:

$ python setup.py build_ext --inplace

to build the C extension in place.

Code of Conduct

When you are interacting with the SunPy community you are required to follow our Code of Conduct.

License

This project is Copyright (c) The SunPy Developers and licensed under the terms of the LGPL-2.1 license. This package is based upon the Openastronomy packaging guide which is licensed under the BSD 3-clause licence.