Build status Overall test coverage Documentation Status

PyFields - 2D and 3D Fields Analysis in Python

PyFields is a Python3 package, intending to ease the manipulation and analysis of 2D and 3D fields, like velocity, concentration, temperature, … .

It can handle sets of fields, to analyze time evolution of the aforementioned fields. It includes easy-to-use helpers for importing, analyzing, displaying and exporting fields.

Documentation

PyFields is fully documented inline. Your preferred IDE should be able to give you access to the documentation.

Full documentation is also available on ReadTheDocs.

Installation

Just run:

python setup.py install

PyFields has some external dependencies (Matplotlib, Scipy, Unum and Numpy) that should be installed automatically.

You can run the tests with:

python setup.py pytest

Basic usage

Coming soon

Report/contribute

PyFields is hosted on Github, you can report an issue, ask your questions or contribute to this project there.

License

This project is free software: You can redistribute it and/or modify it under the terms of the GNU General Public License, either version 3 of the License, or (at your option) any later version.

Indices and tables