Skip to content

Simulate the magnetic response of 2D superconductors

License

Notifications You must be signed in to change notification settings

loganbvh/superscreen

Repository files navigation

SuperScreen

SuperScreen Logo

SuperScreen is a Python package for simulating the magnetic response of thin film superconducting devices. SuperScreen solves the coupled Maxwell's and London equations on a triangular mesh using a matrix inversion method described in the following paper:

SuperScreen: An open-source package for simulating the magnetic response of two-dimensional superconducting devices, Computer Physics Communications, Volume 280, 2022, 108464 https://doi.org/10.1016/j.cpc.2022.108464.

The accepted version of the paper can also be found on arXiv: arXiv:2203.13388.

PyPI GitHub Workflow Status Documentation Status codecov GitHub Code style: black DOI

Learn SuperScreen

The documentation for SuperScreen can be found at superscreen.readthedocs.io.

Try SuperScreen

Click the badge below to try SuperScreen interactively online via Google Colab:

Open In Colab

Install SuperScreen

SuperScreen requires python >=3.8, <3.13. We recommend installing SuperScreen in a fresh conda environment. For more details, see the documentation.

Install via pip

From PyPI, the Python Package Index:

pip install superscreen

From this GitHub repository:

pip install git+https://github.com/loganbvh/superscreen.git

Developer installation

git clone https://github.com/loganbvh/superscreen.git
cd superscreen
pip install -e .

About SuperScreen

Authors

Contributing

Want to contribute to SuperScreen? Check out our contribution guidelines.

BibTeX citation

Please cite this paper if you use SuperScreen in your research.

@article{
    Bishop-Van_Horn2022-sy,
    title    = "{SuperScreen}: An open-source package for simulating the magnetic
                response of two-dimensional superconducting devices",
    author   = "Bishop-Van Horn, Logan and Moler, Kathryn A",
    journal  = "Comput. Phys. Commun.",
    volume   =  280,
    pages    = "108464",
    month    =  nov,
    year     =  2022,
    url      = "https://doi.org/10.1016/j.cpc.2022.108464"
}