Metadata-Version: 2.1
Name: torusgrid
Version: 0.4.4
Summary: periodic fields with definite dimensions equipped with FFT operations
Home-page: https://github.com/michael-960/torusgrid
Author: Michael Wang
Author-email: mike.wang96029@gmail.com
Project-URL: Bug Tracker, https://github.com/michael-960/torusgrid/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/x-rst
License-File: LICENSE


torusgrid
############
`torusgrid` is a package based on pyfftw that facilitates (periodic) field simulations.

Modules
############

`torusgrid.fields` - contains `ComplexField` and `RealField`, which are arrays with definite sizes equipped with FFT operations

`torusgrid.grids` - contains `ComplexGrid` and `RealGrid`

`torusgrid.field_util` - utility functions to manipulate `ComplexField2D` or `RealField2D` objects


