Updating documentation

This commit is contained in:
Adiv Paradise committed 2021-08-18 20:16:15 -04:00
1 parent 488f564f1b
commit 2e27f0a587
3 files changed
+6 -30

No files matched your search

+3 -14
View File
@@ -1,5 +1,5 @@
EXOPLASIM
======
=========
![Two rows of planets, progressing from yellow to blue from top left to bottom right. The top row appears to represent tidally-locked planets, while the bottom row appears to represent Earth-like planets.](mixplanets.png "Two rows of planets, progressing from yellow to blue from top left to bottom right. The top row appears to represent tidally-locked planets, while the bottom row appears to represent Earth-like planets.")
*A range of planets modeled by ExoPlaSim, and postprocessed with SBDART. The top row consists of tidally-locked aquaplanets at T21 orbiting stars ranging from 2500 K to 4000 K, with orbital periods increasing with stellar mass. The bottom row consists of aquaplanets with 24-hour rotation at T42, orbiting stars ranging from 4000 K to 8000 K.*
@@ -45,8 +45,7 @@ OR:
The first time you import the module and try to create a model
after either installing or updating, ExoPlaSim will run a
configuration script, write the install directory into its
source code, and (if applicable) compile the burn7 NetCDF postprocessor.
configuration script.
Multiple output formats are supported by the built-in `pyburn`
postprocessor. If you wish to use HDF5 or NetCDF output formats, you
@@ -66,17 +65,7 @@ OR:
You may also configure and compile the model manually if you wish to not
use the Python API, by entering the exoplasim/ directory and running
first configure.sh, then compile.sh (compilation flags are shown by
running `./compile.sh -h`). The postprocessor and its libraries can be
compiled by entering `exoplasim/postprocessor/` and running
`./build_init.sh`.
burn7 compilation
-----------------
You must have NetCDF libraries available in the path to build burn7.
The burn7 compilation process will build and compile a patched
version of the NetCDF libraries necessary for burn7--burn7 makes
use of features anachronistic to a particular version of NetCDF
that no longer exists.
running `./compile.sh -h`).
PlaSim Documentation
--------------------
+2 -14
View File
@@ -38,8 +38,7 @@ OR::
The first time you import the module and try to create a model
after either installing or updating, ExoPlaSim will run a
configuration script, write the install directory into its
source code, and (if applicable) compile the burn7 NetCDF postprocessor.
configuration script.
Multiple output formats are supported by the built-in `pyburn`
postprocessor. If you wish to use HDF5 or NetCDF output formats, you
@@ -58,18 +57,7 @@ OR::
You may also configure and compile the model manually if you wish
to not use the Python API, by entering the exoplasim/ directory
and running first configure.sh, then compile.sh (compilation flags
are shown by running ``./compile.sh -h``). The postprocessor and its
libraries can be compiled by entering ``exoplasim/postprocessor/`` and
running ``./build_init.sh``.
burn7 compilation
-----------------
You must have NetCDF libraries available in the path to build burn7.
The burn7 compilation process will build and compile a patched
version of the NetCDF libraries necessary for burn7--burn7 makes
use of features anachronistic to a particular version of NetCDF
that no longer exists.
are shown by running ``./compile.sh -h``).
PlaSim Documentation
--------------------
+1 -2
View File
@@ -64,7 +64,6 @@ Optional Requirements
* netCDF4 (for netCDF support)
* h5py (for HDF5 support)
* NetCDF-C Library (for legacy ``burn7`` support)
Installation
------------
@@ -96,7 +95,7 @@ OR::
The first time you import the module and try to create a model
after either installing or updating, ExoPlaSim will run a
configuration script, write the install directory into its
source code, and compile the `pyfft` library.
source code, and compile the ``pyfft`` library.
.. burn7 NetCDF postprocessor. You must
.. have NetCDF libraries available in the path when this happens.