diff options
| author | Thomas Albers Raviola <thomas@thomaslabs.org> | 2024-08-23 12:28:25 +0200 |
|---|---|---|
| committer | Thomas Albers Raviola <thomas@thomaslabs.org> | 2024-08-23 12:28:25 +0200 |
| commit | 322ae0b0199528a247ecb64627c1d412b137a48d (patch) | |
| tree | e91fd7b88850bbeab973f2a81bab580cace7c431 /docs/schrodinger_plot.rst | |
| parent | c40da6a56a5c5a69100a02c3176d47fa18b046a3 (diff) | |
Update sphinx documentation
Diffstat (limited to 'docs/schrodinger_plot.rst')
| -rw-r--r-- | docs/schrodinger_plot.rst | 6 |
1 files changed, 4 insertions, 2 deletions
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) - -:: |