Data

Tools

Indexes

Applications

Experiments

Open Source Science

eigentools

eigentools: A Python package for studying differential eigenvalue problems with an emphasis on robustness - Published in JOSS (2021)

https://github.com/dedalusproject/eigentools

Science Score: 100.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 1 DOI reference(s) in JOSS metadata
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    3 of 6 committers (50.0%) from academic institutions
  • ○
    Institutional organization owner
  • ✓
    JOSS paper metadata
    Published in Journal of Open Source Software
Last synced: 6 months ago · JSON representation ·

Repository

The Eigentools package for Dedalus

Basic Info
  • Host: GitHub
  • Owner: DedalusProject
  • License: gpl-3.0
  • Language: Python
  • Default Branch: master
  • Size: 5.01 MB
Statistics
  • Stars: 13
  • Watchers: 4
  • Forks: 11
  • Open Issues: 9
  • Releases: 0
Created over 6 years ago · Last pushed about 1 year ago
Metadata Files
Readme Contributing License Citation

README.md

Eigentools

Eigentools is a set of tools for studying linear eigenvalue problems. The underlying eigenproblems are solved using Dedalus, 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, which has non-pip installable dependencies. See the installation instructions for details.

Documentation

Documentation (including detailed API documentation) can be found at Read the Docs.

If you are upgrading from version 1 to version 2, you can find a guide to API changes here

Contributing

Eigentools welcomes community contributions from issue reports to code contributions. For details, please see our contribution policy.

Developers

The core development team consists of

Support

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

Owner

  • Name: Dedalus Project
  • Login: DedalusProject
  • Kind: organization

JOSS Publication

eigentools: A Python package for studying differential eigenvalue problems with an emphasis on robustness
Published
June 23, 2021
DOI
Volume 6, Issue 62, Page 3079
Authors
Jeffrey S. Oishi ORCID
Department of Physics and Astronomy, Bates College
Keaton J. Burns ORCID
Department of Mathematics, MIT
S. E. Clark ORCID
School of Natural Sciences, Institute for Advanced Study
Evan H. Anders ORCID
CIERA, Northwestern University
Benjamin P. Brown ORCID
Department of Astrophysical and Planetary Sciences, University of Colorado, Boulder
Geoffrey M. Vasil ORCID
School of Mathematics and Statistics, University of Sydney
Daniel Lecoanet ORCID
CIERA, Northwestern University, Department of Engineering Sciences and Applied Mathematics, Northwestern University
Editor
David P. Sanders ORCID
Tags
eigenvalue problems partial differential equations fluid dynamics magnetohydrodynamics pseudospectra
View PDF Review Thread Software Archive

Citation (CITATION.cff) 

cff-version: 1.2.0
preferred-citation:
  type: article
  authors:
  - family-names: "Oishi"
    given-names: "Jeffrey S"
    orcid: "https://orcid.org/0000-0001-8531-6570"
  - family-names: "Burns"
    given-names: "Keaton J"
    orcid: "https://orcid.org/0000-0003-4761-4766"
  - family-names: "Clark"
    given-names: "S E"
    orcid: "https://orcid.org/0000-0002-7633-3376"
  - family-names: "Anders"
    given-names: "Evan H"
    orcid: "https://orcid.org/0000-0002-3433-4733"
  - family-names: "Brown"
    given-names: "Benjamin P"
    orcid: "https://orcid.org/0000-0001-8935-219X"
  - family-names: "Vasil"
    given-names: "Geoffrey M"
    orcid: "https://orcid.org/0000-0002-8902-5030"
  - family-names: "Lecoanet"
    given-names: "Daniel"
    orcid: "https://orcid.org/0000-0002-7635-9728"
  title: "eigentools: A Python package for studying differential eigenvalue problems with an emphasis on robustness"
  journal: "Journal of Open Source Software"
  doi: "10.21105/joss.03079"
  volume: 6
  issue: 62
  start: 3079
  month: 6
  year: 2021

GitHub Events

Total
  • Watch event: 2
  • Member event: 1
  • Push event: 4
  • Fork event: 1
Last Year
  • Watch event: 2
  • Member event: 1
  • Push event: 4
  • Fork event: 1

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 159
  • Total Committers: 6
  • Avg Commits per committer: 26.5
  • Development Distribution Score (DDS): 0.302
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
J. S. Oishi j****i@g****m 111
Evan Anders e****s@c****u 39
Keaton J. Burns k****s@g****m 3
Adrian (macbook) a****r@u****u 2
Benjamin Brown b****n@g****m 2
Susan Clark s****0@c****u 2
Committer Domains (Top 20 + Academic)
columbia.edu: 1 ucsc.edu: 1 colorado.edu: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 13
  • Total pull requests: 6
  • Average time to close issues: 29 days
  • Average time to close pull requests: 24 days
  • Total issue authors: 9
  • Total pull request authors: 5
  • Average comments per issue: 1.46
  • Average comments per pull request: 0.0
  • Merged pull requests: 4
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • afraser3 (5)
  • theolewy (1)
  • dpsanders (1)
  • caropen (1)
  • evanhanders (1)
  • jsoishi (1)
  • ketch (1)
  • hdrake (1)
  • BenWibking (1)
Pull Request Authors
  • jvwilliams23 (2)
  • jsoishi (2)
  • dpsanders (1)
  • navidcy (1)
  • afraser3 (1)
Top Labels
Issue Labels
enhancement (2)
Pull Request Labels
enhancement (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 21 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 6
  • Total maintainers: 1
pypi.org: eigentools

A toolkit for solving eigenvalue problems with Dedalus

  • Versions: 6
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 21 Last month
Rankings
Dependent packages count: 10.1%
Forks count: 11.4%
Average: 20.0%
Stargazers count: 20.3%
Dependent repos count: 21.6%
Downloads: 36.5%
Maintainers (1)
jsoishi
Last synced: 6 months ago

Dependencies

docs/requirements.rtd.txt pypi
  • nbsphinx *
  • pygments >=2.4.1
  • setuptools >=18.0
  • sphinx-autoapi *
.github/workflows/build.yml actions
  • actions/checkout v2 composite