diff --git a/docs/VPLanetFlowChart.png b/docs/VPLanetFlowChart.png new file mode 100644 index 000000000..ee423b130 Binary files /dev/null and b/docs/VPLanetFlowChart.png differ diff --git a/docs/architecture.rst b/docs/architecture.rst index cd6f29e2d..a1d202e15 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -33,7 +33,7 @@ unphysical, e.g. eccentricities less than 0. Each of these checks must only apply to an individual option. More complicated checks are handled in Verify. -:note:: +.. note:: Some arrays and matrices are allocated prior to the ReadOptions call. @@ -78,7 +78,7 @@ options can be input in a wide range of units, recording the state in system units allows users to determine if they have input something incorrectly, and also helps developers identify bugs. -:note:: +.. note:: If a user requests an output with a negative sign, which forces a specific unit, then the value in the log file will not be SI, but the custom units @@ -106,7 +106,7 @@ system of equations that are required based on the options. The integration is broken down into five steps: Auxiliary Properties (sometimes shortened to AuxProps), One Step, Output, Force Behavior, and Halt. -:note:: +.. note:: If the user does not select a forward or backward integration, but does elect to write a log file, then the code will calculate all the initial conditions diff --git a/docs/index.rst b/docs/index.rst index 78c9c23f3..8219fe752 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -18,6 +18,7 @@ are available in separate repositories. vplot parametersweep tutorials + Workshop Lectures developers authors repos diff --git a/docs/option.rst b/docs/option.rst index 1e97aa03f..3f0006979 100644 --- a/docs/option.rst +++ b/docs/option.rst @@ -66,6 +66,7 @@ should be set to 0 as shown. Otherwise, set the value to equal the sum of module bits, such as is done for the inclination: .. code-block:: bash + options[OPT_INC].iModuleBit = DISTORB + SPINBODY; In other words, each module is assigned a unique integer that is a power of 2 so @@ -80,13 +81,15 @@ parameter that is used with the -H command line option, e.g. the verbosity benefits from a bit more explanation: .. code-block:: bash -sprintf(options[OPT_VERBOSE].cLongDescr, + + sprintf(options[OPT_VERBOSE].cLongDescr, "Set how much text is written to the screen. 0 = no output, 1 = only\n" "errors, 2 = progress updates, 3 = statements about input choices, 4 =\n" "information about unit choices, 5 = all possible output. Note that levels\n" "0 and 5 can be set at execution with the -q and -v options, respectively." -:note:: +.. note:: + Any field that is omitted will be set to the default values that are defined in output.c:InitializeOutput. diff --git a/docs/output.rst b/docs/output.rst index c8166c052..2e991b6fd 100644 --- a/docs/output.rst +++ b/docs/output.rst @@ -85,7 +85,7 @@ angle" requires a bit more explanation for a typical user: "the vernal equinox. This angle is a \"dog-leg\" angle as shown in Fig. 30\n" "of Barnes et al. (2020)." -:note:: +.. note:: Any field that is omitted will be set to the default values that are defined in output.c:InitializeOutput. diff --git a/docs/tutorials.rst b/docs/tutorials.rst index 9903d72fd..6ba3176fc 100644 --- a/docs/tutorials.rst +++ b/docs/tutorials.rst @@ -1,5 +1,5 @@ -VPLanet Tutorials -================= +Tutorials +========= Please view the following pages for written descriptions of how to: diff --git a/src/options.h b/src/options.h index 450b21acf..3cc9c0983 100644 --- a/src/options.h +++ b/src/options.h @@ -9,8 +9,8 @@ 1) Add integer definition here 2) Add new option properties in InitializeOptions 3) Write new fnReadOptions function - 3) If necessary, modify the ReadOptions subroutine - 4) If necessary, modify the WriteLog subroutine + 4) If necessary, modify the ReadOptions subroutine + 5) If necessary, modify the Verify process */