Metadata-Version: 2.1
Name: eigentools
Version: 2.2112
Summary: A toolkit for solving eigenvalue problems with Dedalus
Home-page: https://github.com/dedalusproject/eigentools
Author: J. S. Oishi
Author-email: jsoishi@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Requires-Python: >=3.5
Description-Content-Type: text/markdown

# Eigentools

Eigentools is a set of tools for studying linear eigenvalue problems. The underlying eigenproblems are solved using [Dedalus](http://dedalus-project.org), which provides a domain-specific language for partial differential equations. Eigentools extends Dedalus's `EigenvalueProblem` object and provides

* automatic rejection of unresolved eigenvalues
* simple plotting of specified eigenmodes
* simple plotting of spectra
* computation of pseudospectra for any Differential-Algebraic Equations with **user-specifiable norms**
* tools to find critical parameters for linear stability analysis
* ability to project eigenmode onto 2- or 3-D domain for visualization
* ability to output projected eigenmodes as Dedalus-formatted HDF5 file to be used as initial conditions for Initial Value Problems
* simple plotting of drift ratios (both ordinal and nearest) to evaluate tolerance for eigenvalue rejection

## Installation

Eigentools can be `pip` installed, though it requires [Dedalus](http://dedalus-project.org/), which has non-`pip` installable dependencies. See the [installation instructions](https://eigentools.readthedocs.io/en/latest/pages/installation.html) for details.

## Documentation

Documentation (including detailed API documentation) can be found at [Read the Docs](https://eigentools.readthedocs.io/).

If you are upgrading from version 1 to version 2, you can find a guide to API changes [here](https://eigentools.readthedocs.io/en/latest/pages/upgrading.html)

## Contributing

Eigentools welcomes community contributions from issue reports to code contributions. For details, please see [our contribution policy](CONTRIBUTING.md).

## Developers
The core development team consists of 

* Jeff Oishi (<jsoishi@gmail.com>)
* Keaton Burns (<keaton.burns@gmail.com>)
* Susan Clark (<susanclark19@gmail.com>)
* Evan Anders (<evan.anders@northwestern.edu>)
* Ben Brown (<bpbrown@gmail.com>)
* Geoff Vasil (<geoffrey.m.vasil@gmail.com>)
* Daniel Lecoanet (<daniel.lecoanet@northwestern.edu>)

## Support 
Eigentools was developed with support from the Research Corporation under award Scialog Collaborative Award (TDA) ID# 24231.


<!--  LocalWords:  Eigentools eigenproblems Dedalus EigenvalueProblem
 -->
<!--  LocalWords:  eigenmodes pseudospectra eigenmode HDF conda Oishi
 -->
<!--  LocalWords:  eigentools Anders Geoff Vasil Lecoanet Scialog TDA
 -->


