pyTDGL: Time-dependent Ginzburg Landau in Python

pyTDGL logo. PyPI GitHub Workflow Status Documentation Status https://codecov.io/gh/loganbvh/py-tdgl/branch/main/graph/badge.svg?token=VXdxJKP6Ag GitHub https://img.shields.io/badge/code%20style-black-000000.svg

pyTDGL is a Python package that solves a generalized time-dependent Ginzburg-Landau (TDGL) model in two dimensions, enabling simulations of vortex and phase dynamics in thin film superconducting devices of arbitrary geometry. The package provides a convenient interface for defining complex device geometries and generating the corresponding finite-element data structures. pyTDGL also includes many methods for post-processing and visualizing spatially- and temporally-resolved simulation results.

To get started using pyTDGL see Installation and Quickstart. To learn more about the physics and numerics, see Theoretical Background. Click the badge below and navigate to docs/notebooks/ to try pyTDGL interactively online via Binder:

https://mybinder.org/badge_logo.svg

Acknowledgements

Parts of this package have been adapted from SuperDetectorPy, a GitHub repo authored by Mattias Jönsson. Both SuperDetectorPy and pyTDGL are released under the open-source MIT License. If you use either package in an academic publication or similar, please consider citing the following:

  • Mattias Jönsson, Theory for superconducting few-photon detectors (Doctoral dissertation), KTH Royal Institute of Technology (2022) (Link).

  • Mattias Jönsson, Robert Vedin, Samuel Gyger, James A. Sutton, Stephan Steinhauer, Val Zwiller, Mats Wallin, Jack Lidmar, Current crowding in nanoscale superconductors within the Ginzburg-Landau model, Phys. Rev. Applied 17, 064046 (2022) (Link).

The pyTDGL Python API is adapted from SuperScreen, (GitHub repo, journal article, arXiv preprint), which solves the London equation in two dimensions.