Added class docstrings

Lancaster-Physics-Phys389-2020 · Apr 19, 2020 · 42c452f · 42c452f
1 parent eadfcd3
commit 42c452f
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/potential_class.py b/potential_class.py
@@ -2,6 +2,10 @@
 from error import error
 
 class potential:
+    """
+    Describes the potential field that forms part of the quantum system for 
+    which a wavefunction is calculated
+    """
     def __init__(self,steps,form="SW"):
         """
         Initialises potential field and generates potential array

diff --git a/quantum_particle.py b/quantum_particle.py
@@ -4,6 +4,10 @@
 
 
 class q_particle:
+    """
+    Describes the particles that forms part of the quantum system for which 
+    a wavefunction is calculated, using the Numerov method
+    """
     def __init__(self,trial_energy,well_depth,length,steps,start_position=0,mass=const.m_e):
         """
         Initialises a particle