Merge pull request #136 from natashabatalha/dev

Merge 3.1beta to prep links for Rooney et al. 2023 papers
natashabatalha · Mar 23, 2023 · 9d4cbd6 · 9d4cbd6
2 parents 3512c8b + 86dae6a
commit 9d4cbd6
Show file tree

Hide file tree

Showing 63 changed files with 78,103 additions and 22,070 deletions.
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -3,6 +3,12 @@
 History
 -------
 
+3.1 (2023-3-23)
+~~~~~~~~~~~~~~~
+* SH harmonics documentation for reflected light 
+* SH harmonics documentation for thermal emission 
+* Added output xarray resources for model preservation and reusibility
+
 3.0 (2022-10-25)
 ~~~~~~~~~~~~~~~~
 * First version of climate code (Mukherjee et al. 2022)
@@ -79,4 +85,4 @@ History
 * Reflected light component only 
 * added git-lfs opacity database from only 0.3-1 micron 
 * made opacity database sqlite to speed up queries 
-* tutorials added for initial setup, adding clouds, visualizations, analyzing approximations, and opacity queries
+* tutorials added for initial setup, adding clouds, visualizations, analyzing approximations, and opacity queries
diff --git a/docs/Makefile b/docs/Makefile
@@ -6,7 +6,7 @@
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = .
-BUILDDIR      = ../../picaso-docs
+BUILDDIR      = ../../picaso-docs/picaso-docs
 
 # Put it first so that "make" without argument is like "make help".
 help:

diff --git a/docs/conf.py b/docs/conf.py
@@ -17,7 +17,7 @@
 import os
 import sys
 import sphinx_rtd_theme
-
+import picaso.justdoit as jdi
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
@@ -41,8 +41,9 @@
     'sphinx.ext.napoleon',
     'nbsphinx']
 
-nbsphinx_allow_errors = True
-nbsphinx_execute = 'never'
+nbsphinx_allow_errors = False
+
+nbsphinx_execute = 'always'
 
 #bibtex_bibfiles = ['refs.bib']
 # Add any paths that contain templates here, relative to this directory.
@@ -66,9 +67,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '3.0'
+version = str(jdi.__version__)
 # The full version, including alpha/beta/rc tags.
-release = '3.0'
+release = str(jdi.__version__)
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -43,14 +43,14 @@ Create Environment Variable
 
 There are several ways to create environment variables. Below are the three most popular methods. You only need to choose one that works best for you. 
 
-Method 1: ``bash_profle`` or ``zshrc`` file
+Method 1: ``bash_profile`` or ``zshrc`` file
 ````````````````````````````````````````````
 
 As you might guess ``~/.bash_profile`` is used for the ``Bash`` command line shell. ``~/.zshrc`` is used for the ``Zsh`` command line shell. The steps below are identical.
 
 .. code-block:: bash
 
-	vi ~/.bash_profle
+	vi ~/.bash_profile
 
 Add add this line:
 
@@ -157,7 +157,7 @@ When you untar this you should get a directory structure that looks like this ``
 
 .. code-block:: bash
 
-	vi ~/.bash_profle
+	vi ~/.bash_profile
 
 Add add this line: