From a86bcac604f4e9e93da340af2790be1f9e4de1cd Mon Sep 17 00:00:00 2001 From: Deepak Date: Mon, 4 Jan 2021 16:00:28 -0600 Subject: [PATCH] Adds docs --- pysuperconductor/__init__.py | 5 +++++ pysuperconductor/os_gap_calc.py | 2 ++ 2 files changed, 7 insertions(+) diff --git a/pysuperconductor/__init__.py b/pysuperconductor/__init__.py index 7fdaee1..757dc27 100644 --- a/pysuperconductor/__init__.py +++ b/pysuperconductor/__init__.py @@ -1,3 +1,8 @@ +"""pysuperconductor + +This package implements some superconductor calculations, to facilitate noise +calculations in proximity to superconductors. +""" import logging from pysuperconductor.meta import __version__ diff --git a/pysuperconductor/os_gap_calc.py b/pysuperconductor/os_gap_calc.py index 828d519..366a162 100644 --- a/pysuperconductor/os_gap_calc.py +++ b/pysuperconductor/os_gap_calc.py @@ -9,6 +9,8 @@ from typing import Tuple def energy(freq: float, delta: float) -> float: + """Takes in a "raw" quasiparticle energy and a gap, and returns the + quasiparticle's energy in the SC state.""" return numpy.sqrt(freq ** 2 + delta ** 2)