aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTim Suhling <tim@suhling.com>2024-08-23 11:42:27 +0200
committerTim Suhling <tim@suhling.com>2024-08-23 11:42:27 +0200
commitfb9592fde2fabe9da65ccd00dfeda933d3d18b0f (patch)
tree6f0f748f9e2ea6f22a5cc15f74944fe0ab6a4475 /docs
parentf120ae00a6a2d85c4159805788823f2d1811053b (diff)
Added documentation to schrodinger_plot.rst
Diffstat (limited to 'docs')
-rw-r--r--docs/schrodinger_plot.rst41
1 files changed, 41 insertions, 0 deletions
diff --git a/docs/schrodinger_plot.rst b/docs/schrodinger_plot.rst
index 8c35087..b47fbae 100644
--- a/docs/schrodinger_plot.rst
+++ b/docs/schrodinger_plot.rst
@@ -1,3 +1,44 @@
*****************
Schrodinger Plot
*****************
+
+Plots the solutions of schrodinger_solve. Visualises the given potential together
+with the eigenstates and the probability density. Also plots the standard
+deviation of each energy level.
+
+Solutions of schrodinger_solve must be in a directory together for schrodinger_plot
+to visualise them. Solution files must keep names given by schrodinger_solve.
+
+The plot generated by schrodinger_plot can be altered with different scale and
+axis limits to better visualize the solution. If no custom scale or limits are given
+schrodinger_solve will limit the plot by the limits of the potential as well as the
+energies of the solution for a better initial result.
+
+
+**Command line options**
+::
+
+ -h, --help show a help message
+ -s SOLUTION_DIR --solution_dir
+ the path of the solution directory (default: None)
+ -o OUTPUT_DIR --output_dir
+ the path where the pdf should be saved (default: None)
+ --show SHOW Boolean, if True the plot is shown directly (default:
+ True)
+ -e EXPORT --export
+ Boolean, if True the plot is exported as a pdf
+ (default: True)
+ --scale SCALE Float, scales the wave functions (default: 1.0)
+ -x XLIM --xlim Limit of the x-axis of the left plot. None or
+ tuple[float, float] of shape (x_min, x_max)(default:
+ None)
+ -y1 ENERGY_LIM --energy_lim
+ Limit of the y-axis of the left plot. None or
+ tuple[float, float] of shape (y_min, y_max)(default:
+ None)
+ -y2 UNCERTAINTY_LIM --uncertainty_lim
+ Limit of the y-axis of the right plot. None or
+ tuple[float, float] of shape (y_min, y_max)(default:
+ None)
+
+::