Skip to content

maiani/pyusadel

Repository files navigation

pyUsadel

A toolkit for modeling superconductor heterostructure with Usadel equations written in python. This is code is still in a preliminary stage and work-in-progress. There is no documentation available and no stable API.

Table of Contents

Description

pyUsadel is a python library for modeling superconductor heterostructures using Usadel equations. It provides a flexible and user-friendly interface for simulating and analyzing the behavior of these systems.

Installation

To install pyUsadel, you will need to have the following dependencies installed:

Usage

To use pyUsadel, simply import the library in your Python script and you can access the functions and classes provided by pyUsadel to build and run your simulations. Some example simulations are included in under the folder doc/examples/.

Current limitations

  • Only magnetization in the x-y plane is supported.
  • No orbital effects. You are suggested to look at the TODO file to check for features that are still missing.

Contributing

We welcome contributions to pyUsadel! If you would like to contribute, please follow these steps:

  1. Fork the repository
  2. Create a new branch for your changes
  3. Make your changes and test them thoroughly
  4. Submit a pull request to the main repository If you find a bug, please report it using the issue tracker.

A TODO list of task is included.

License

pyUsadel is released under the MIT License. See LICENSE for more information.

Authors

pyUsadel was developed by