Metadata-Version: 2.4
Name: pygenstates
Version: 0.2.0
Summary: A Python solver for time-independent Schrodinger eigenvalue problems.
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: scikit-fem
Provides-Extra: examples
Requires-Dist: ipykernel; extra == "examples"
Requires-Dist: matplotlib; extra == "examples"
Requires-Dist: notebook; extra == "examples"
Provides-Extra: docs
Requires-Dist: sphinx>=7; extra == "docs"
Requires-Dist: sphinx-rtd-theme>=2; extra == "docs"
Dynamic: license-file

# pygenstates

[![license](https://img.shields.io/github/license/gflower480/pygenstates)](https://opensource.org/licenses/mit)

A Python solver for the time-independent Schrodinger equation, with support for an n-dimensional continuous basis as well as coupled discrete/continuous bases. The package supports a range of Hamiltonians, but was built with circuit QED applications in mind.

## Installation

Install from the project root with:

```bash
pip install pygenstates
```

Useful links:
[PyPI](https://pypi.org/project/pygenstates/)
[Github](https://github.com/gflower480/pygenstates)

## Documentation

Find documentation on [Read the Docs](https://pygenstates.readthedocs.io/en/latest/).

## Examples

Worked examples are included in the `examples` [folder](https://github.com/gflower480/pygenstates/examples).

