Adds docs

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__
 

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)