Finished docs for v0.1.0

justinbois · Sep 2, 2020 · d5ff267 · d5ff267
1 parent d361ccc
commit d5ff267
Show file tree

Hide file tree

Showing 9 changed files with 4,146 additions and 5,367 deletions.
diff --git a/doc/credits_and_citation.rst b/doc/credits_and_citation.rst
@@ -7,7 +7,7 @@ This package is primarily written by `Justin Bois <http://bois.caltech.edu>`_ fo
 Citing bebi103
 ==================
 
-Because this package evolves according to the needs of the BE/Bi 103 ab courses, it has at best a stable-ish API. It is therefore very important to include a version number when citing the package. It is best to cite the package using its DOI. Here is a citation for version 0.0.54.
+Because this package evolves according to the needs of the BE/Bi 103 ab courses, it has at best a stable-ish API. It is therefore very important to include a version number when citing the package. It is best to cite the package using its DOI. Here is a citation for version 0.1.0.
 
 .. code-block:: bibtex
 
@@ -16,7 +16,7 @@ Because this package evolves according to the needs of the BE/Bi 103 ab courses,
       url = {URL},
       author = {Bois, Justin S.},
       keywords = {Github},
-      title = {justinbois/bebi103: Version 0.0.54},
+      title = {justinbois/bebi103: Version 0.1.0},
       publisher = {CaltechDATA},
       year = {2020}
     }
diff --git a/doc/getting_started/installation.rst b/doc/getting_started/installation.rst
@@ -19,15 +19,15 @@ bebi103 has the following dependencies.
 - Pandas_
 - Numba_
 - tqdm_
-- CmdStanPy_
+- CmdStanPy_ 0.9.0 or higher
 - xarray_
-- ArviZ_
+- ArviZ_ 0.9.0 or higher
 - Bokeh_
 - Matplotlib_
 - colorcet_
 - HoloViews_
 
-Additionally, bebi103 can make use of PyStan_ and Datashader_, though these are not strictly required.
+Additionally, bebi103 can make use of PyStan_, though it is not required.
 
 .. _NumPy: http://www.numpy.org/
 .. _SciPy: http://www.scipy.org/

diff --git a/doc/index.rst b/doc/index.rst
@@ -19,6 +19,8 @@ The bebi103 package provides convenience functions for use in the `BE/Bi 103 ab
    user_guide/using_user_guide.ipynb
    user_guide/hv.ipynb
    user_guide/bootstrap.ipynb
+   user_guide/stan.ipynb
+   user_guide/image.ipynb
    user_guide/api
 
 

diff --git a/doc/user_guide/api.rst b/doc/user_guide/api.rst
@@ -84,7 +84,7 @@ Image processing utilities
 .. currentmodule:: bebi103.image
 
 .. autosummary::
-   :toctree: generated/hv
+   :toctree: generated/image
    :nosignatures:
 
    imshow

diff --git a/doc/user_guide/bootstrap.ipynb b/doc/user_guide/bootstrap.ipynb
diff --git a/doc/user_guide/hv.ipynb b/doc/user_guide/hv.ipynb
diff --git a/doc/user_guide/image.ipynb b/doc/user_guide/image.ipynb
@@ -0,0 +1,34 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Image processing utilities\n",
+    "\n",
+    "Image processing utilities, though stable, are not currently actively developed. Documentation for these utilities is forthcoming when development continues. For now, please see the API reference for the `image` module."
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.8.2"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}
diff --git a/doc/user_guide/stan.ipynb b/doc/user_guide/stan.ipynb
diff --git a/doc/user_guide/using_user_guide.ipynb b/doc/user_guide/using_user_guide.ipynb