Skip to content

Latest commit

 

History

History
64 lines (39 loc) · 3 KB

README.md

File metadata and controls

64 lines (39 loc) · 3 KB

SuperScreen

SuperScreen Logo

SuperScreen is a package for simulating the magnetic response of multi-planar 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 references:

  1. Phys. Rev. B 72, 024529 (2005) [arXiv:cond-mat/0506144]
  2. Rev. Sci. Instrum. 87, 093702 (2016) [arXiv:1605.09483]
  3. Supercond. Sci. Technol. 29 (2016) 124001 [arXiv:1607.03950]

See the documentation for more details.

PyPI GitHub Workflow Status (branch) 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 Binder:

Binder

(Note: Binder instances are limited to 2 GB of memory, so you can only solve relatively small models online.)

Install SuperScreen

SuperScreen requires python >=3.6, <3.10. 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.