From 42c452fb3d963f06b41e6d2af039dcd9b3f563a3 Mon Sep 17 00:00:00 2001 From: JP-Carr Date: Sun, 19 Apr 2020 15:17:53 +0100 Subject: [PATCH] Added class docstrings --- potential_class.py | 4 ++++ quantum_particle.py | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/potential_class.py b/potential_class.py index 4b972dc..c0ca913 100644 --- 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 index ef62345..231a260 100644 --- 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