From 4cbf45dffd0e19d778ca4e1e5eeb048e8f18320c Mon Sep 17 00:00:00 2001 From: Lucas Sawade Date: Tue, 25 Feb 2025 10:55:07 -0500 Subject: [PATCH] Edited the parameter label so that it aligns with standard sphinx parameter docuemtnation --- docs/parameter_documentation/databases.rst | 12 +- docs/parameter_documentation/header.rst | 18 +- docs/parameter_documentation/receivers.rst | 30 +- docs/parameter_documentation/run_setup.rst | 18 +- .../seismogram_setup.rst | 18 +- .../simulation_setup.rst | 276 +++++++++--------- docs/parameter_documentation/sources.rst | 6 +- 7 files changed, 189 insertions(+), 189 deletions(-) diff --git a/docs/parameter_documentation/databases.rst b/docs/parameter_documentation/databases.rst index e1b85ccf..bd5980f2 100644 --- a/docs/parameter_documentation/databases.rst +++ b/docs/parameter_documentation/databases.rst @@ -17,19 +17,19 @@ Parameter definitions ..dropdown:: ``databases`` :open: - **default value** : None + :default value: None - **possible values** : [YAML Node] + :possible values: [YAML Node] - **documentation** : Define databases section + :documentation: Define databases section .. _database-file-parameter: .. dropdown:: ``databases.mesh-database`` - **default value** : None + :default value: None - **possible values** : [string] + :possible values: [string] - **documentation** : Location of the fortran binary database file defining the mesh + :documentation: Location of the fortran binary database file defining the mesh diff --git a/docs/parameter_documentation/header.rst b/docs/parameter_documentation/header.rst index fca99dc4..eda28019 100644 --- a/docs/parameter_documentation/header.rst +++ b/docs/parameter_documentation/header.rst @@ -22,24 +22,24 @@ Parameter definitions .. dropdown:: ``header`` :open: - **default value** : None + :default value: None - **possible values** : [YAML Node] + :possible values: [YAML Node] - **documentation** : Define header section + :documentation: Define header section .. dropdown:: ``header.title`` - **default value** : None + :default value: None - **possible values** : [string] + :possible values: [string] - **documentation** : Brief name for this simulation + :documentation: Brief name for this simulation .. dropdown:: ``header.description`` - **default value** : None + :default value: None - **possible values** : [string] + :possible values: [string] - **documentation** : Detailed description for this run. + :documentation: Detailed description for this run. diff --git a/docs/parameter_documentation/receivers.rst b/docs/parameter_documentation/receivers.rst index 42a7e271..9f78105a 100644 --- a/docs/parameter_documentation/receivers.rst +++ b/docs/parameter_documentation/receivers.rst @@ -30,38 +30,38 @@ Parameter definitions .. dropdown:: ``receivers`` :open: - **default value** : None + :default value: None - **possible values** : [YAML Node] + :possible values: [YAML Node] - **documentation** : receiver information required to calculate seismograms. + :documentation: receiver information required to calculate seismograms. .. dropdown:: ``receivers.stations`` - **default value** : None + :default value: None - **possible values** : [string] + :possible values: [string] - **documentation** : Path to ``stations_file`` + :documentation: Path to ``stations_file`` .. dropdown:: ``receivers.angle`` - **default value** : None + :default value: None - **possible values** : [float] + :possible values: [float] - **documentation** : Angle to rotate components at receivers + :documentation: Angle to rotate components at receivers .. dropdown:: ``receivers.seismogram-type`` - **default value** : None + :default value: None - **possible values** : [YAML list] + :possible values: [YAML list] - **documentation** : Type of seismograms to be written. + :documentation: Type of seismograms to be written. @@ -93,9 +93,9 @@ Parameter definitions .. dropdown:: ``receivers.nstep_between_samples`` - **default value** : None + :default value: None - **possible values** : [int] + :possible values: [int] - **documentation** : Number of time steps between sampling the wavefield + :documentation: Number of time steps between sampling the wavefield at station locations for writing seismogram. diff --git a/docs/parameter_documentation/run_setup.rst b/docs/parameter_documentation/run_setup.rst index 6f6ee4a0..5eb5df4f 100644 --- a/docs/parameter_documentation/run_setup.rst +++ b/docs/parameter_documentation/run_setup.rst @@ -18,25 +18,25 @@ Parameter definitions .. dropdown:: ``run-setup`` :open: - **default value** : number-of-processors: 1, number-of-runs: 1 + :default value: number-of-processors: 1, number-of-runs: 1 - **possible values** : [YAML Node] + :possible values: [YAML Node] - **documentation** : Define run-time configuration for your simulation + :documentation: Define run-time configuration for your simulation .. dropdown:: ``run-setup.number-of-processors`` - **default value** : 1 + :default value: 1 - **possible values** : [int] + :possible values: [int] - **documentation** : Number of MPI processes used in the simulation. MPI version is not enabled in this version of the package. number-of-processors == 1 + :documentation: Number of MPI processes used in the simulation. MPI version is not enabled in this version of the package. number-of-processors == 1 .. dropdown:: ``run-setup.number-of-runs`` - **default value** : 1 + :default value: 1 - **possible values** : [int] + :possible values: [int] - **documentation** : Number of runs in this simulation. Only single run implemented in this version of the package. number-of-runs == 1 + :documentation: Number of runs in this simulation. Only single run implemented in this version of the package. number-of-runs == 1 diff --git a/docs/parameter_documentation/seismogram_setup.rst b/docs/parameter_documentation/seismogram_setup.rst index d17e0ffb..186abbe0 100644 --- a/docs/parameter_documentation/seismogram_setup.rst +++ b/docs/parameter_documentation/seismogram_setup.rst @@ -11,28 +11,28 @@ Parameter definitions .. dropdown:: ``seismogram`` :open: - **default value** : NULL + :default value: NULL - **possible values** : [YAML Node] + :possible values: [YAML Node] - **documentation** : Define seismogram output configuration + :documentation: Define seismogram output configuration .. dropdown:: ``seismogram.seismogram-format`` - **default value** : None + :default value: None - **possible values** : [ascii] + :possible values: [ascii] - **documentation** : Type of seismogram format to be written. + :documentation: Type of seismogram format to be written. 1. ascii - :ref:`ASCII` writes calculated seismogram values to seismogram files in string format. .. dropdown:: ``seismogram.output-folder`` - **default value** : Current working directory + :default value: Current working directory - **possible values** : [string] + :possible values: [string] - **documentation** : Path to output folder where the seismograms will be saved. + :documentation: Path to output folder where the seismograms will be saved. diff --git a/docs/parameter_documentation/simulation_setup.rst b/docs/parameter_documentation/simulation_setup.rst index bc6722f4..3b0a6583 100644 --- a/docs/parameter_documentation/simulation_setup.rst +++ b/docs/parameter_documentation/simulation_setup.rst @@ -40,68 +40,68 @@ Parameter definitions .. dropdown:: ``simulation-setup`` :open: - **default value** : None + :default value: None - **possible values** : [YAML Node] + :possible values: [YAML Node] - **documentation** : Simulation setup parameters + :documentation: Simulation setup parameters .. dropdown:: ``simulation-setup.quadrature`` [optional] - **default value** : 4th order GLL quadrature with 5 GLL points + :default value: 4th order GLL quadrature with 5 GLL points - **possible values**: [YAML Node] + :possible values: [YAML Node] - **documentation** : Type of quadrature used for the simulation. + :documentation: Type of quadrature used for the simulation. .. dropdown:: ``simulation-setup.quadrature.alpha`` - **default value** : None + :default value: None - **possible values** : [float, double] + :possible values: [float, double] - **documentation** : Alpha value of the Gauss-Jacobi quadrature. For GLL quadrature alpha = 0.0 + :documentation: Alpha value of the Gauss-Jacobi quadrature. For GLL quadrature alpha = 0.0 .. dropdown:: ``simulation-setup.quadrature.beta`` - **default value** : None + :default value: None - **possible values** : [float, double] + :possible values: [float, double] - **documentation** : Beta value of the Gauss-Jacobi quadrature. For GLL quadrature beta = 0.0, and for GLJ quadrature beta = 1.0 + :documentation: Beta value of the Gauss-Jacobi quadrature. For GLL quadrature beta = 0.0, and for GLJ quadrature beta = 1.0 .. dropdown:: ``simulation-setup.quadrature.ngllx`` - **default value** : None + :default value: None - **possible values** : [int] + :possible values: [int] - **documentation** : Number of GLL points in X-dimension + :documentation: Number of GLL points in X-dimension .. dropdown:: ``simulation-setup.quadrature.ngllz`` - **default value** : None + :default value: None - **possible values** : [int] + :possible values: [int] - **documentation** : Number of GLL points in Z-dimension + :documentation: Number of GLL points in Z-dimension .. dropdown:: ``simulation-setup.quadrature.quadrature-type`` [optional] :open: - **default value** : GLL4 + :default value: GLL4 - **possible values** : [GLL4, GLL7] + :possible values: [GLL4, GLL7] - **documentation** : Predefined quadrature types. + :documentation: Predefined quadrature types. 1. ``GLL4`` defines 4th order GLL quadrature with 5 GLL points. 2. ``GLL7`` defines 7th order GLL quadrature with 8 GLL points. @@ -130,11 +130,11 @@ Parameter definitions .. dropdown:: ``simulation-setup.solver`` - **default value** : None + :default value: None - **possible values** : [YAML Node] + :possible values: [YAML Node] - **documentation** : Type of solver to use for the simulation. + :documentation: Type of solver to use for the simulation. .. admonition:: Example for defining time-marching Newmark solver @@ -150,65 +150,65 @@ Parameter definitions .. dropdown:: ``simulation-setup.solver.time-marching`` - **default value** : None + :default value: None - **possible values** : [YAML Node] + :possible values: [YAML Node] - **documentation** : Select either a time-marching or an explicit solver. Only time-marching solver is implemented currently. + :documentation: Select either a time-marching or an explicit solver. Only time-marching solver is implemented currently. .. dropdown:: ``simulation-setup.solver.time-marching.time-scheme.type`` - **default value** : None + :default value: None - **possible values** : [Newmark] + :possible values: [Newmark] - **documentation** : Select time scheme for the solver + :documentation: Select time scheme for the solver .. dropdown:: ``simulation-setup.solver.time-marching.time-scheme.dt`` - **default value** : None + :default value: None - **possible values** : [float, double] + :possible values: [float, double] - **documentation** : Value of time step in seconds + :documentation: Value of time step in seconds .. dropdown:: ``simulation-setup.solver.time-marching.time-scheme.nstep`` - **default value** : None + :default value: None - **possible values** : [int] + :possible values: [int] - **documentation** : Total number of time steps in the simulation + :documentation: Total number of time steps in the simulation .. dropdown:: ``simulation-setup.solver.time-marching.time-scheme.t0`` [optional] - **default value** : 0.0 + :default value: 0.0 - **possible values** : [float, double] + :possible values: [float, double] - **documentation** : Start time of the simulation + :documentation: Start time of the simulation .. dropdown:: ``simulation-setup.simulation-mode`` - **default value** : None + :default value: None - **possible values** : [YAML Node] + :possible values: [YAML Node] - **documentation** : Defines the type of simulation to run (e.g. forward, adjoint, combined, etc.) + :documentation: Defines the type of simulation to run (e.g. forward, adjoint, combined, etc.) .. dropdown:: ``simulation-setup.simulation-mode.forward`` - **default value** : None + :default value: None - **possible values** : [YAML Node] + :possible values: [YAML Node] - **documentation** : Forward simulation parameters + :documentation: Forward simulation parameters .. admonition:: Example for defining a forward simulation node @@ -240,117 +240,117 @@ Parameter definitions .. dropdown:: ``simulation-setup.simulation-mode.forward.writer`` - **default value** : None + :default value: None - **possible values** : [YAML Node] + :possible values: [YAML Node] - **documentation** : Defines the outputs to be stored to disk during the forward simulation + :documentation: Defines the outputs to be stored to disk during the forward simulation .. dropdown:: ``simulation-setup.simulation-mode.forward.writer.seismogram`` - **default value** : None + :default value: None - **possible values** : [YAML Node] + :possible values: [YAML Node] - **documentation** : Seismogram writer parameters + :documentation: Seismogram writer parameters .. dropdown:: ``simulation-setup.simulation-mode.forward.writer.seismogram.format`` [optional] - **default value** : ASCII + :default value: ASCII - **possible values** : [ASCII] + :possible values: [ASCII] - **documentation** : Output format of the seismogram + :documentation: Output format of the seismogram .. dropdown:: ``simulation-setup.simulation-mode.forward.writer.seismogram.directory`` [optional] - **default value** : Current working directory + :default value: Current working directory - **possible values** : [string] + :possible values: [string] - **documentation** : Output folder for the seismogram + :documentation: Output folder for the seismogram .. dropdown:: ``simulation-setup.simulation-mode.forward.writer.wavefield`` - **default value** : None + :default value: None - **possible values** : [YAML Node] + :possible values: [YAML Node] - **documentation** : Forward wavefield writer parameters + :documentation: Forward wavefield writer parameters .. dropdown:: ``simulation-setup.simulation-mode.forward.writer.wavefield.format`` [optional] - **default value** : ASCII + :default value: ASCII - **possible values** : [ASCII, HDF5] + :possible values: [ASCII, HDF5] - **documentation** : Output format of the wavefield + :documentation: Output format of the wavefield .. dropdown:: ``simulation-setup.simulation-mode.forward.writer.wavefield.directory`` [optional] - **default value** : Current working directory + :default value: Current working directory - **possible values** : [string] + :possible values: [string] - **documentation** : Output folder for the wavefield + :documentation: Output folder for the wavefield .. dropdown:: ``simulation-setup.simulation-mode.forward.writer.display`` - **default value** : None + :default value: None - **possible values** : [YAML Node] + :possible values: [YAML Node] - **documentation** : Plot the wavefield during the forward simulation + :documentation: Plot the wavefield during the forward simulation .. dropdown:: ``simulation-setup.simulation-mode.forward.writer.display.format`` [optional] - **default value** : PNG + :default value: PNG - **possible values** : [PNG, JPG, on_screen] + :possible values: [PNG, JPG, on_screen] - **documentation** : Output format for resulting plots + :documentation: Output format for resulting plots .. dropdown:: ``simulation-setup.simulation-mode.forward.writer.display.directory`` [optional] - **default value** : Current working directory + :default value: Current working directory - **possible values** : [string] + :possible values: [string] - **documentation** : Output folder for the plots (not applicable for on_screen) + :documentation: Output folder for the plots (not applicable for on_screen) .. dropdown:: ``simulation-setup.simulation-mode.forward.writer.display.field`` - **default value** : None + :default value: None - **possible values** : [displacement, velocity, acceleration, pressure] + :possible values: [displacement, velocity, acceleration, pressure] - **documentation** : Component of the wavefield to be plotted + :documentation: Component of the wavefield to be plotted .. dropdown:: ``simulation-setup.simulation-mode.forward.writer.display.simulation-field`` - **default value** : None + :default value: None - **possible values** : [forward] + :possible values: [forward] - **documentation** : Type of wavefield to be plotted + :documentation: Type of wavefield to be plotted .. dropdown:: ``simulation-setup.simulation-mode.forward.writer.display.time-interval`` - **default value** : None + :default value: None - **possible values** : [int] + :possible values: [int] - **documentation** : Time step interval for plotting the wavefield + :documentation: Time step interval for plotting the wavefield .. dropdown:: ``simulation-setup.simulation-mode.combined`` [optional] - **default value** : None + :default value: None - **possible values** : [YAML Node] + :possible values: [YAML Node] - **documentation** : Combined (forward + adjoint) simulation parameters + :documentation: Combined (forward + adjoint) simulation parameters .. admonition:: Example for defining a combined simulation node @@ -383,140 +383,140 @@ Parameter definitions .. dropdown:: ``simulation-setup.simulation-mode.combined.reader`` [optional] - **default value** : None + :default value: None - **possible values** : [YAML Node] + :possible values: [YAML Node] - **documentation** : Defines the inputs to be read from disk during the combined simulation + :documentation: Defines the inputs to be read from disk during the combined simulation .. dropdown:: ``simulation-setup.simulation-mode.combined.reader.wavefield`` - **default value** : None + :default value: None - **possible values** : [YAML Node] + :possible values: [YAML Node] - **documentation** : Wavefield reader parameters + :documentation: Wavefield reader parameters .. dropdown:: ``simulation-setup.simulation-mode.combined.reader.wavefield.format`` [optional] - **default value** : ASCII + :default value: ASCII - **possible values** : [ASCII, HDF5] + :possible values: [ASCII, HDF5] - **documentation** : Format of the wavefield to be read + :documentation: Format of the wavefield to be read .. dropdown:: ``simulation-setup.simulation-mode.combined.reader.wavefield.directory`` [optional] - **default value** : Current working directory + :default value: Current working directory - **possible values** : [string] + :possible values: [string] - **documentation** : Folder containing the wavefield to be read + :documentation: Folder containing the wavefield to be read .. dropdown:: ``simulation-setup.simulation-mode.combined.writer`` [optional] - **default value** : None + :default value: None - **possible values** : [YAML Node] + :possible values: [YAML Node] - **documentation** : Defines the outputs to be stored to disk during the combined simulation + :documentation: Defines the outputs to be stored to disk during the combined simulation .. dropdown:: ``simulation-setup.simulation-mode.combined.writer.seismogram`` [optional] - **default value** : None + :default value: None - **possible values** : [YAML Node] + :possible values: [YAML Node] - **documentation** : Seismogram writer parameters + :documentation: Seismogram writer parameters .. dropdown:: ``simulation-setup.simulation-mode.combined.writer.seismogram.format`` [optional] - **default value** : ASCII + :default value: ASCII - **possible values** : [ASCII] + :possible values: [ASCII] - **documentation** : Output format of the seismogram + :documentation: Output format of the seismogram .. dropdown:: ``simulation-setup.simulation-mode.combined.writer.seismogram.directory`` [optional] - **default value** : Current working directory + :default value: Current working directory - **possible values** : [string] + :possible values: [string] - **documentation** : Output folder for the seismogram + :documentation: Output folder for the seismogram .. dropdown:: ``simulation-setup.simulation-mode.combined.writer.kernels`` - **default value** : None + :default value: None - **possible values** : [YAML Node] + :possible values: [YAML Node] - **documentation** : Kernel writer parameters + :documentation: Kernel writer parameters .. dropdown:: ``simulation-setup.simulation-mode.combined.writer.kernels.format`` [optional] - **default value** : ASCII + :default value: ASCII - **possible values** : [ASCII, HDF5] + :possible values: [ASCII, HDF5] - **documentation** : Output format of the kernels + :documentation: Output format of the kernels .. dropdown:: ``simulation-setup.simulation-mode.combined.writer.kernels.directory`` [optional] - **default value** : Current working directory + :default value: Current working directory - **possible values** : [string] + :possible values: [string] - **documentation** : Output folder for the kernels + :documentation: Output folder for the kernels .. dropdown:: ``simulation-setup.simulation-mode.combined.writer.display`` [optional] - **default value** : None + :default value: None - **possible values** : [YAML Node] + :possible values: [YAML Node] - **documentation** : Plot the wavefield during the combined simulation + :documentation: Plot the wavefield during the combined simulation .. dropdown:: ``simulation-setup.simulation-mode.combined.writer.display.format`` [optional] - **default value** : PNG + :default value: PNG - **possible values** : [PNG, JPG, on_screen] + :possible values: [PNG, JPG, on_screen] - **documentation** : Output format for resulting plots + :documentation: Output format for resulting plots .. dropdown:: ``simulation-setup.simulation-mode.combined.writer.display.directory`` [optional] - **default value** : Current working directory + :default value: Current working directory - **possible values** : [string] + :possible values: [string] - **documentation** : Output folder for the plots (not + :documentation: Output folder for the plots (not applicable for on_screen) .. dropdown:: ``simulation-setup.simulation-mode.combined.writer.display.field`` - **default value** : None + :default value: None - **possible values** : [displacement, velocity, acceleration, pressure] + :possible values: [displacement, velocity, acceleration, pressure] - **documentation** : Component of the wavefield to be plotted + :documentation: Component of the wavefield to be plotted .. dropdown:: ``simulation-setup.simulation-mode.combined.writer.display.simulation-field`` - **default value** : None + :default value: None - **possible values** : [adjoint, backward] + :possible values: [adjoint, backward] - **documentation** : Type of wavefield to be plotted + :documentation: Type of wavefield to be plotted .. dropdown:: ``simulation-setup.simulation-mode.combined.writer.display.time-interval`` - **default value** : None + :default value: None - **possible values** : [int] + :possible values: [int] - **documentation** : Time step interval for plotting the wavefield + :documentation: Time step interval for plotting the wavefield diff --git a/docs/parameter_documentation/sources.rst b/docs/parameter_documentation/sources.rst index b62d2c06..532122fb 100644 --- a/docs/parameter_documentation/sources.rst +++ b/docs/parameter_documentation/sources.rst @@ -15,8 +15,8 @@ Parameter definitions .. dropdown:: ``sources`` :open: - **default value** : None + :default value: None - **possible values** : [YAML Node] + :possible values: [YAML Node] - **documentation** : Define sources section + :documentation: Define sources section