diff options
| -rw-r--r-- | README.md | 88 |
1 files changed, 49 insertions, 39 deletions
@@ -30,16 +30,20 @@ file describing the parameters to use and the potential (see below for file format). ## Usage - schrodinger_solve [-h] [-o OUTPUT_DIR] filename +```text +schrodinger_solve [-h] [-o OUTPUT_DIR] filename +``` ## Options - positional arguments: - filename File describing the system to solve +```text +positional arguments: + filename File describing the system to solve - options: - -h, --help show this help message and exit - -o OUTPUT_DIR, --output-dir OUTPUT_DIR - Output directory for the results +options: + -h, --help show this help message and exit + -o OUTPUT_DIR, --output-dir OUTPUT_DIR + Output directory for the results +``` ## Input file format The input file format consist of a five line header followed by a csv style, two @@ -49,15 +53,17 @@ must be given in a fixed order. Comments discard the rest of the line and may be added with a `#` character. An empty line is discarded and the next non-empty line specifies the next parameter. A concrete example is given below. - <mass> - <x-min> <x-max> <n-points> - <first-eigenvalue> <last-eigenvalue> - <interpolation-type> - <n> - <x1> <y1> - <x2> <y2> - ... - <xn> <yn> +```text +<mass> +<x-min> <x-max> <n-points> +<first-eigenvalue> <last-eigenvalue> +<interpolation-type> +<n> +<x1> <y1> +<x2> <y2> +... +<xn> <yn> +``` - mass: (real) Mass of the particle - x-min, x-max: (real) Solution interval @@ -84,27 +90,31 @@ 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. ## 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] +```text +schrodinger_plot.py [-h] [-s SOLUTION_DIR] [-o OUTPUT_DIR] [--show SHOW] [-e EXPORT] [--scale SCALE] [-x XLIM] [-y1 ENERGY_LIM] [-y2 UNCERTAINTY_LIM] +``` ## 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) +```text +-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) +``` |