Merge pull request #33 from JGCRI/demeter_1.3.1

Updates for version 1.3

.github/workflows/build.yml

@@ -31,6 +31,7 @@ jobs:
             pip install pandas==1.2.4
             pip install scipy==1.6.3
             pip install requests==2.25.1
+            pip install xarray==0.20.2 
             pip install git+https://github.com/JGCRI/gcamreader.git
 
         - name: Test and generate coverage report

.gitignore

@@ -20,7 +20,6 @@ __pycache__/
 
 # Distribution / packaging
 .Python
-build/
 develop-eggs/
 dist/
 downloads/

Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

README.md

@@ -1,5 +1,6 @@
 [![build](https://github.com/JGCRI/demeter/actions/workflows/build.yml/badge.svg)](https://github.com/JGCRI/demeter/actions/workflows/build.yml)
 [![DOI](https://zenodo.org/badge/101879773.svg)](https://zenodo.org/badge/latestdoi/101879773)
+[![codecov](https://codecov.io/gh/JGCRI/demeter/branch/master/graph/badge.svg?token=7K2g3PsFUG)](https://codecov.io/gh/JGCRI/demeter)
 
 # Demeter
 
@@ -9,9 +10,11 @@ Demeter is an open source Python package that was built to disaggregate projecti
 # Getting Started with Demeter
 Set up Demeter using the following steps:
 1.  Install Demeter from GitHub:
-    ```bash
-    python -m pip install git+http://github.com/JGCRI/demeter.git#egg=demeter
-    ```
+    ```python
+
+    pip install git+http://github.com/JGCRI/demeter.git#egg=demeter
+
+    ```    
 2.  Download the example data using the following in a Python prompt:
     ```python
     import demeter

build/html/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 3771d149e3eee7741bb6dcde325e5548
+tags: 645f666f9bcd5a90fca523b33c5a78b7

build/html/_sources/demeter.change.rst.txt

@@ -0,0 +1,29 @@
+demeter.change package
+======================
+
+Submodules
+----------
+
+demeter.change.expansion module
+-------------------------------
+
+.. automodule:: demeter.change.expansion
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+demeter.change.intensification module
+-------------------------------------
+
+.. automodule:: demeter.change.intensification
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: demeter.change
+   :members:
+   :undoc-members:
+   :show-inheritance:

build/html/_sources/demeter.demeter_io.rst.txt

@@ -0,0 +1,29 @@
+demeter.demeter\_io package
+===========================
+
+Submodules
+----------
+
+demeter.demeter\_io.reader module
+---------------------------------
+
+.. automodule:: demeter.demeter_io.reader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+demeter.demeter\_io.writer module
+---------------------------------
+
+.. automodule:: demeter.demeter_io.writer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: demeter.demeter_io
+   :members:
+   :undoc-members:
+   :show-inheritance:

build/html/_sources/demeter.rst.txt

@@ -0,0 +1,112 @@
+demeter package
+===============
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   demeter.change
+   demeter.demeter_io
+   demeter.tests
+   demeter.weight
+
+Submodules
+----------
+
+demeter.config\_reader module
+-----------------------------
+
+.. automodule:: demeter.config_reader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+demeter.constraints module
+--------------------------
+
+.. automodule:: demeter.constraints
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+demeter.install\_supplement module
+----------------------------------
+
+.. automodule:: demeter.install_supplement
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+demeter.logger module
+---------------------
+
+.. automodule:: demeter.logger
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+demeter.model module
+--------------------
+
+.. automodule:: demeter.model
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+demeter.ncdf\_conversion module
+-------------------------------
+
+.. automodule:: demeter.ncdf_conversion
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+demeter.preprocess\_data module
+-------------------------------
+
+.. automodule:: demeter.preprocess_data
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+demeter.process module
+----------------------
+
+.. automodule:: demeter.process
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+demeter.reconcile module
+------------------------
+
+.. automodule:: demeter.reconcile
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+demeter.staging module
+----------------------
+
+.. automodule:: demeter.staging
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+demeter.test\_read module
+-------------------------
+
+.. automodule:: demeter.test_read
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: demeter
+   :members:
+   :undoc-members:
+   :show-inheritance:

build/html/_sources/demeter.tests.rst.txt

@@ -0,0 +1,21 @@
+demeter.tests package
+=====================
+
+Submodules
+----------
+
+demeter.tests.test\_model\_output module
+----------------------------------------
+
+.. automodule:: demeter.tests.test_model_output
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: demeter.tests
+   :members:
+   :undoc-members:
+   :show-inheritance:

build/html/_sources/demeter.weight.rst.txt

@@ -0,0 +1,21 @@
+demeter.weight package
+======================
+
+Submodules
+----------
+
+demeter.weight.kernel\_density module
+-------------------------------------
+
+.. automodule:: demeter.weight.kernel_density
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: demeter.weight
+   :members:
+   :undoc-members:
+   :show-inheritance:

build/html/_sources/index.rst.txt

@@ -0,0 +1,25 @@
+.. Demeter documentation master file, created by
+   sphinx-quickstart on Wed Jan  4 00:08:52 2023.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Demeter's documentation!
+===================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+.. mdinclude:: ../README.md
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+
+

build/html/_sources/modules.rst.txt

@@ -0,0 +1,7 @@
+demeter
+=======
+
+.. toctree::
+   :maxdepth: 4
+
+   demeter

build/html/_sources/readme.rst.txt

@@ -0,0 +1 @@
+.. mdinclude:: ../README.md