Metadata-Version: 2.1
Name: torusgrid
Version: 0.3.3
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
Requires-Dist: numpy (>=1.21.2)
Requires-Dist: scipy (>=1.7)
Requires-Dist: pyfftw (>=0.12.0)
Requires-Dist: matplotlib (>=3.5.1)
Requires-Dist: michael960-lib (>=0.1.4)
Requires-Dist: tqdm (>=4)


torusgrid
############
:code:`torusgrid` is a package based on numpy arrays and pyfftw that facilitates field simulations.


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

:code:`torusgrid.fields` - contains :code:`ComplexField2D` and its subclass :code:`RealField2D`, which are 2D arrays with definite sizes equipped with FFT operations

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


