start docs tutorial, reorganize docs to reflect ver 0.2

docs/source/api.rst

@@ -11,13 +11,13 @@ Python functions, classes, and modules
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 prep\_metadata
------------
+--------------
 
 .. autofunction:: gridwxcomp.prep_metadata
 
 
 ee\_download
---------------------------
+------------
 
 .. autofunction:: gridwxcomp.ee_download
 

docs/source/conf.py

@@ -52,17 +52,17 @@
 # ones.
 extensions = [
     'sphinx.ext.autodoc',
+    'sphinx.ext.autosectionlabel',
     'sphinx.ext.doctest',
     'sphinx.ext.intersphinx',
-    'sphinx.ext.todo',
     'sphinx.ext.coverage',
     'sphinx.ext.mathjax',
     'sphinx.ext.napoleon',
+    'sphinx.ext.todo',
     'sphinx.ext.ifconfig',
     'sphinx.ext.viewcode',
     'sphinx.ext.githubpages',
 ]
-
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
@@ -85,7 +85,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = []
+exclude_patterns = ['**.ipynb_checkpoints']
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = None

docs/source/getting_started.rst

@@ -1,43 +1,6 @@
 Getting Started
 ===============
 
-Installation
-------------
-
-Currently we recommend using the provided conda environment file to install ``gridwxcomp`` and its dependencies in a virtual environment. Download the `environment.yml <https://raw.githubusercontent.com/WSWUP/gridwxcomp/master/gridwxcomp/env/environment.yml>`_ file and then install and activate it. If you don't have conda `get it here <https://conda.io/projects/conda/en/latest/user-guide/install/index.html>`_. To install dependencies in a virtual environment run 
-
-.. code-block:: bash
-
-    $ conda env create -f environment.yml
-
-To activate the environment before using ``gridwxcomp`` run
-
-.. code-block:: bash
-
-    $ conda activate gridwxcomp
-
-Optionally, install using `pip <https://pip.pypa.io/en/stable/installing/>`_,
-
-.. code-block:: bash
-
-    $ pip install gridwxcomp
-
-Due to dependency conflicts you may have issues directly installing with pip before activating the conda environment.
-
-Alternatively, or if there are installation issues, you can manually install. First activate the ``gridwxcomp`` conda environment (above). Next, clone or download the package from `GitHub <https://github.com/WSWUP/gridwxcomp>`_ or `PyPI <https://pypi.org/project/gridwxcomp/>`_ and then install locally with pip in "editable" mode. For example with cloning,
-
-.. code-block:: bash
-
-    $ git clone https://github.com/WSWUP/gridwxcomp.git
-    $ cd gridwxcomp
-
-If you are experiencing errors on installing the ``gridwxcomp`` conda environment above with dependencies. For example, if the Shapely package is not installing from the enironment.yml file, remove it or modify it from the "setup.py" file in the install requirements section before you install gridwxcomp from source with:
-
-.. code-block:: bash
-
-    $ pip install -e .
-
-More help with installation issues related to dependency conflicts can be found in the ``gridwxcomp`` `issues <https://github.com/WSWUP/gridwxcomp/issues>`_ on GitHub, be sure to check the closed issues as well.
 
 Quick start from command line
 -----------------------------

docs/source/index.rst

@@ -19,10 +19,11 @@ A package for comparing weather station data to gridded weather data that are ho
 Bias ratios calculated by ``gridwxcomp`` can be used to correct bias of grid to station data based on the properties of the stations. For example, monthly humidity ratios between station and grid for stations within agricultural settings can be used to estimate grid bias relative to agricultural locations. 
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
    :caption: Contents:
 
-   getting_started
+   install
+   tutorial
    faq
    api
    changelog

docs/source/install.rst

@@ -0,0 +1,37 @@
+Installation
+============
+
+Currently we recommend using the provided conda environment file to install ``gridwxcomp`` and its dependencies in a virtual environment. Download the `environment.yml <https://raw.githubusercontent.com/WSWUP/gridwxcomp/master/gridwxcomp/env/environment.yml>`_ file and then install and activate it. If you don't have conda `get it here <https://conda.io/projects/conda/en/latest/user-guide/install/index.html>`_. To install dependencies in a virtual environment run 
+
+.. code-block:: bash
+
+    $ conda env create -f environment.yml
+
+To activate the environment before using ``gridwxcomp`` run
+
+.. code-block:: bash
+
+    $ conda activate gridwxcomp
+
+Optionally, install using `pip <https://pip.pypa.io/en/stable/installing/>`_,
+
+.. code-block:: bash
+
+    $ pip install gridwxcomp
+
+Due to dependency conflicts you may have issues directly installing with pip before activating the conda environment.
+
+Alternatively, or if there are installation issues, you can manually install. First activate the ``gridwxcomp`` conda environment (above). Next, clone or download the package from `GitHub <https://github.com/WSWUP/gridwxcomp>`_ or `PyPI <https://pypi.org/project/gridwxcomp/>`_ and then install locally with pip in "editable" mode. For example with cloning,
+
+.. code-block:: bash
+
+    $ git clone https://github.com/WSWUP/gridwxcomp.git
+    $ cd gridwxcomp
+
+If you are experiencing errors on installing the ``gridwxcomp`` conda environment above with dependencies. For example, if the Shapely package is not installing from the enironment.yml file, remove it or modify it from the "setup.py" file in the install requirements section before you install gridwxcomp from source with:
+
+.. code-block:: bash
+
+    $ pip install -e .
+
+More help with installation issues related to dependency conflicts can be found in the ``gridwxcomp`` `issues <https://github.com/WSWUP/gridwxcomp/issues>`_ on GitHub, be sure to check the closed issues as well.