Pseudo-Spectral-Discretization

This codebase contains the implementation of the DiracOperator class, which is used for applying the Dirac operator to spectral coefficients, computing eigenvalues and eigenfunctions, generating lattice structures, and transforming values between real and spectral spaces.

Directory Structure

• pseudospectral folder contains all the source code of the project which are mainly .py files broadly categorized into Dirac operator and Spectra python files.
• pseudospectral/spectra folder contains spectrum class implementations.
• example_scripts folder for example script usage of the DiracOperator, Spectrum classes, methods and a boiler-plate to begin with.
• tests folder contains all the pytests written for the project.

.
├── pseudospectral
    ├── __init__.py
    ├── dirac_operator.py
    └──  spectra
        ├── derivative1D.py
        └── fermion2D.py
├── pyproject.toml
├── README.md
├── tutorial.md
├── example_scripts
    └──  cosine_derivative.py
├── LICENSE
└── tests
    ├── conftest.py
    ├── test_real_basis.py
    ├── test_spectral_basis.py
    ├── test_transform.py
    └── test_spectra.py

Setup

• git clone the repository - git clone https://github.com/Mayank447/Pseudo-Spectral-Discretization.git
• cd into the repository - cd Pseudo-Spectral-Discretization
• run pip install .

Usage

• After setting up the package, you can import the classes and methods from pseudospectral module in your code as follows: from pseudospectral import DiracOperator, FreeFermions2D
• You may further refer to:
  • examples folder for example script usage of the DiracOperator, Spectrum classes, methods and a boilerplate to begin with.

Gotchas

• As opposed to standard best practices, spectra should not use self.eigenvalues internally but self._eigenvalues (or wherever the data is actually stored) because self.eigenvalues is public interface which is overridden when applying another spectrum on top.