# pyTDGL
Time-dependent Ginzburg-Landau in Python
[](https://py-tdgl.readthedocs.io/en/latest/?badge=latest)
[](https://codecov.io/gh/loganbvh/py-tdgl)
[](https://github.com/psf/black)
[](https://zenodo.org/badge/latestdoi/535746543)
## Motivation
`pyTDGL` solves a 2D generalized time-dependent Ginzburg-Landau (TDGL) equation, enabling simulations of vortex and phase dynamics in thin film superconducting devices.
## Learn `pyTDGL`
The documentation for `pyTDGL` can be found at [py-tdgl.readthedocs.io](https://py-tdgl.readthedocs.io/en/latest/).
## Try `pyTDGL`
Click the badge below to try `pyTDGL` interactively online via [Google Colab](https://colab.research.google.com/):
[](https://colab.research.google.com/github/loganbvh/py-tdgl/blob/main/docs/notebooks/quickstart.ipynb)
## About `pyTDGL`
### Authors
- Primary author and maintainer: [@loganbvh](https://github.com/loganbvh/).
### Citing `pyTDGL`
`pyTDGL` is described in the following paper:
>*pyTDGL: Time-dependent Ginzburg-Landau in Python*, Computer Physics Communications **291**, 108799 (2023), DOI: [10.1016/j.cpc.2023.108799](https://doi.org/10.1016/j.cpc.2023.108799).
If you use `pyTDGL` in your research, please cite the paper linked above.
% BibTeX citation
@article{
Bishop-Van_Horn2023-wr,
title = "{pyTDGL}: Time-dependent {Ginzburg-Landau} in Python",
author = "Bishop-Van Horn, Logan",
journal = "Comput. Phys. Commun.",
volume = 291,
pages = "108799",
month = may,
year = 2023,
url = "http://dx.doi.org/10.1016/j.cpc.2023.108799",
issn = "0010-4655",
doi = "10.1016/j.cpc.2023.108799"
}
### Acknowledgments
Parts of this package have been adapted from [`SuperDetectorPy`](https://github.com/afsa/super-detector-py), a GitHub repo authored by [Mattias Jönsson](https://github.com/afsa). Both `SuperDetectorPy` and `py-tdgl` are released under the open-source MIT License. If you use either package in an academic publication or similar, please consider citing the following in addition to the `pyTDGL` paper:
- Mattias Jönsson, Theory for superconducting few-photon detectors (Doctoral dissertation), KTH Royal Institute of Technology (2022) ([Link](http://urn.kb.se/resolve?urn=urn:nbn:se:kth:diva-312132))
- 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](https://journals.aps.org/prapplied/abstract/10.1103/PhysRevApplied.17.064046))
The user interface is adapted from [`SuperScreen`](https://github.com/loganbvh/superscreen).
Raw data
{
"_id": null,
"home_page": "https://github.com/loganbvh/py-tdgl",
"name": "tdgl",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=3.8",
"maintainer_email": null,
"keywords": "superconductor vortex Ginzburg-Landau",
"author": "Logan Bishop-Van Horn",
"author_email": "logan.bvh@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/62/7e/c4cb518212b27f5aace12a9fed7ef401286f6eb026405eb5785cc7db5dfe/tdgl-0.8.1.tar.gz",
"platform": "Linux",
"description": "\n# pyTDGL\n\nTime-dependent Ginzburg-Landau in Python\n\n\n\n[](https://py-tdgl.readthedocs.io/en/latest/?badge=latest)\n[](https://codecov.io/gh/loganbvh/py-tdgl)\n\n[](https://github.com/psf/black)\n[](https://zenodo.org/badge/latestdoi/535746543)\n\n## Motivation\n`pyTDGL` solves a 2D generalized time-dependent Ginzburg-Landau (TDGL) equation, enabling simulations of vortex and phase dynamics in thin film superconducting devices.\n\n## Learn `pyTDGL`\n\nThe documentation for `pyTDGL` can be found at [py-tdgl.readthedocs.io](https://py-tdgl.readthedocs.io/en/latest/).\n\n## Try `pyTDGL`\n\nClick the badge below to try `pyTDGL` interactively online via [Google Colab](https://colab.research.google.com/):\n\n[](https://colab.research.google.com/github/loganbvh/py-tdgl/blob/main/docs/notebooks/quickstart.ipynb)\n\n## About `pyTDGL`\n\n### Authors\n\n- Primary author and maintainer: [@loganbvh](https://github.com/loganbvh/).\n\n### Citing `pyTDGL`\n\n`pyTDGL` is described in the following paper:\n\n>*pyTDGL: Time-dependent Ginzburg-Landau in Python*, Computer Physics Communications **291**, 108799 (2023), DOI: [10.1016/j.cpc.2023.108799](https://doi.org/10.1016/j.cpc.2023.108799).\n\nIf you use `pyTDGL` in your research, please cite the paper linked above.\n\n % BibTeX citation\n @article{\n Bishop-Van_Horn2023-wr,\n title = \"{pyTDGL}: Time-dependent {Ginzburg-Landau} in Python\",\n author = \"Bishop-Van Horn, Logan\",\n journal = \"Comput. Phys. Commun.\",\n volume = 291,\n pages = \"108799\",\n month = may,\n year = 2023,\n url = \"http://dx.doi.org/10.1016/j.cpc.2023.108799\",\n issn = \"0010-4655\",\n doi = \"10.1016/j.cpc.2023.108799\"\n }\n\n\n### Acknowledgments\n\nParts of this package have been adapted from [`SuperDetectorPy`](https://github.com/afsa/super-detector-py), a GitHub repo authored by [Mattias J\u00f6nsson](https://github.com/afsa). Both `SuperDetectorPy` and `py-tdgl` are released under the open-source MIT License. If you use either package in an academic publication or similar, please consider citing the following in addition to the `pyTDGL` paper:\n\n- Mattias J\u00f6nsson, Theory for superconducting few-photon detectors (Doctoral dissertation), KTH Royal Institute of Technology (2022) ([Link](http://urn.kb.se/resolve?urn=urn:nbn:se:kth:diva-312132))\n- Mattias J\u00f6nsson, 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](https://journals.aps.org/prapplied/abstract/10.1103/PhysRevApplied.17.064046))\n\nThe user interface is adapted from [`SuperScreen`](https://github.com/loganbvh/superscreen).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "pyTDGL: Time-dependent Ginzburg-Landau in Python.",
"version": "0.8.1",
"project_urls": {
"Homepage": "https://github.com/loganbvh/py-tdgl"
},
"split_keywords": [
"superconductor",
"vortex",
"ginzburg-landau"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "508d5b2769bb075818614bdfbc6e9f7ec4370052e6a0fa6fe4615165d4320e42",
"md5": "d71b87898e855859964cc67cfccbf06f",
"sha256": "a0e6e22ead920b6f39da4fdd35dec44b2d37d8b72828ed0df40095cd261f0138"
},
"downloads": -1,
"filename": "tdgl-0.8.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d71b87898e855859964cc67cfccbf06f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.8",
"size": 120552,
"upload_time": "2024-04-15T17:44:06",
"upload_time_iso_8601": "2024-04-15T17:44:06.318680Z",
"url": "https://files.pythonhosted.org/packages/50/8d/5b2769bb075818614bdfbc6e9f7ec4370052e6a0fa6fe4615165d4320e42/tdgl-0.8.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "627ec4cb518212b27f5aace12a9fed7ef401286f6eb026405eb5785cc7db5dfe",
"md5": "d46a9975975cf33f0934b4897d2e19b4",
"sha256": "8421e7d0b63c1f9a842c3e45aa949b24e3c5903a36abd57de03544ba6cb2e0e0"
},
"downloads": -1,
"filename": "tdgl-0.8.1.tar.gz",
"has_sig": false,
"md5_digest": "d46a9975975cf33f0934b4897d2e19b4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.8",
"size": 100941,
"upload_time": "2024-04-15T17:44:08",
"upload_time_iso_8601": "2024-04-15T17:44:08.122432Z",
"url": "https://files.pythonhosted.org/packages/62/7e/c4cb518212b27f5aace12a9fed7ef401286f6eb026405eb5785cc7db5dfe/tdgl-0.8.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-15 17:44:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "loganbvh",
"github_project": "py-tdgl",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [
{
"name": "cloudpickle",
"specs": []
},
{
"name": "h5py",
"specs": []
},
{
"name": "joblib",
"specs": []
},
{
"name": "jupyter",
"specs": []
},
{
"name": "matplotlib",
"specs": []
},
{
"name": "meshpy",
"specs": []
},
{
"name": "numba",
"specs": []
},
{
"name": "numpy",
"specs": []
},
{
"name": "pint",
"specs": []
},
{
"name": "pytest",
"specs": []
},
{
"name": "pytest-cov",
"specs": []
},
{
"name": "scipy",
"specs": [
[
"<",
"1.11"
]
]
},
{
"name": "shapely",
"specs": []
},
{
"name": "tqdm",
"specs": []
}
],
"lcname": "tdgl"
}
JSON
