From 322ae0b0199528a247ecb64627c1d412b137a48d Mon Sep 17 00:00:00 2001 From: Thomas Albers Raviola Date: Fri, 23 Aug 2024 12:28:25 +0200 Subject: Update sphinx documentation --- docs/schrodinger_plot.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'docs/schrodinger_plot.rst') diff --git a/docs/schrodinger_plot.rst b/docs/schrodinger_plot.rst index b47fbae..e70ac01 100644 --- a/docs/schrodinger_plot.rst +++ b/docs/schrodinger_plot.rst @@ -14,6 +14,10 @@ axis limits to better visualize the solution. If no custom scale or limits are g 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. +**Usage** +:: + + schrodinger_plot.py [-h] [-s SOLUTION_DIR] [-o OUTPUT_DIR] [--show SHOW] [-e EXPORT] [--scale SCALE] [-x XLIM] [-y1 ENERGY_LIM] [-y2 UNCERTAINTY_LIM] **Command line options** :: @@ -40,5 +44,3 @@ energies of the solution for a better initial result. Limit of the y-axis of the right plot. None or tuple[float, float] of shape (y_min, y_max)(default: None) - -:: -- cgit v1.2.3