Merge pull request #25 from JGCRI/rename

Rename to `gcamreader`
JGCRI · Aug 10, 2021 · eea1c82 · eea1c82
2 parents b187c25 + 008c137
commit eea1c82
Show file tree

Hide file tree

Showing 30 changed files with 31 additions and 23 deletions.
diff --git a/DISCLAIMER b/DISCLAIMER
@@ -1,3 +1,5 @@
+gcamreader
+
 Copyright (c) 2021, Battelle Memorial Institute
 
 Open source under license BSD 2-Clause

diff --git a/LICENSE b/LICENSE
@@ -1,4 +1,4 @@
-gcam_reader
+gcamreader
 
 Copyright (c) 2021, Battelle Memorial Institute
 

diff --git a/README.md b/README.md
@@ -1,21 +1,21 @@
-[![build](https://github.com/JGCRI/gcam_reader/actions/workflows/build.yml/badge.svg)](https://github.com/JGCRI/gcam_reader/actions/workflows/build.yml)
-[![codecov](https://codecov.io/gh/JGCRI/gcam_reader/branch/master/graph/badge.svg?token=Az2MWAQbwj)](https://codecov.io/gh/JGCRI/gcam_reader)
+[![build](https://github.com/JGCRI/gcamreader/actions/workflows/build.yml/badge.svg)](https://github.com/JGCRI/gcamreader/actions/workflows/build.yml)
+[![codecov](https://codecov.io/gh/JGCRI/gcamreader/branch/master/graph/badge.svg?token=Az2MWAQbwj)](https://codecov.io/gh/JGCRI/gcamreader)
 [![DOI](https://zenodo.org/badge/100425913.svg)](https://zenodo.org/badge/latestdoi/100425913)
 
-# gcam_reader: A python package for importing GCAM data
+# gcamreader: A python package for importing GCAM data
 
-#### `gcam_reader` provides functions for reading data from output databases produced by GCAM (https://github.com/JGCRI/gcam-core) 
+#### `gcamreader` provides functions for reading data from output databases produced by [GCAM](https://github.com/JGCRI/gcam-core) 
 
 ### Purpose
 
-`gcam_reader` was created to:
+`gcamreader` was created to:
 
-    - Use XML queries to extract data into a Pandas DataFrame from a GCAM XML database
+- Use XML queries to extract data into a Pandas DataFrame from a GCAM XML database
 
-    - Integrate GCAM with other Python packages
+- Integrate GCAM with other Python packages
 
-### Install `gcam_reader`
+### Install `gcamreader`
 
 ```bash
-pip install gcam_reader
+pip install gcamreader
 ```
diff --git a/gcam_reader/ModelInterface/modelinterface b/gcam_reader/ModelInterface/modelinterface
diff --git a/gcam_reader/ModelInterface/Main_queries.xml → gcamreader/ModelInterface/Main_queries.xml b/gcam_reader/ModelInterface/Main_queries.xml → gcamreader/ModelInterface/Main_queries.xml
diff --git a/..._reader/ModelInterface/ModelInterface.jar → gcamreader/ModelInterface/ModelInterface.jar b/..._reader/ModelInterface/ModelInterface.jar → gcamreader/ModelInterface/ModelInterface.jar
diff --git a/...reader/ModelInterface/batch-prototype.xml → ...reader/ModelInterface/batch-prototype.xml b/...reader/ModelInterface/batch-prototype.xml → ...reader/ModelInterface/batch-prototype.xml
diff --git a/gcam_reader/ModelInterface/batch-sample.xml → gcamreader/ModelInterface/batch-sample.xml b/gcam_reader/ModelInterface/batch-sample.xml → gcamreader/ModelInterface/batch-sample.xml
diff --git a/...eader/ModelInterface/jars/BaseX-9.5.0.jar → ...eader/ModelInterface/jars/BaseX-9.5.0.jar b/...eader/ModelInterface/jars/BaseX-9.5.0.jar → ...eader/ModelInterface/jars/BaseX-9.5.0.jar
diff --git a/...ModelInterface/model_interface.properties → ...ModelInterface/model_interface.properties b/...ModelInterface/model_interface.properties → ...ModelInterface/model_interface.properties
diff --git a/...lInterface/sample-queries-interactive.xml → ...lInterface/sample-queries-interactive.xml b/...lInterface/sample-queries-interactive.xml → ...lInterface/sample-queries-interactive.xml
diff --git a/..._reader/ModelInterface/sample-queries.xml → gcamreader/ModelInterface/sample-queries.xml b/..._reader/ModelInterface/sample-queries.xml → gcamreader/ModelInterface/sample-queries.xml
diff --git a/gcam_reader/ModelInterface/sample.csv → gcamreader/ModelInterface/sample.csv b/gcam_reader/ModelInterface/sample.csv → gcamreader/ModelInterface/sample.csv
diff --git a/...der/ModelInterface/sample_with_errors.csv → ...der/ModelInterface/sample_with_errors.csv b/...der/ModelInterface/sample_with_errors.csv → ...der/ModelInterface/sample_with_errors.csv
diff --git a/gcam_reader/__init__.py → gcamreader/__init__.py b/gcam_reader/__init__.py → gcamreader/__init__.py
@@ -2,7 +2,7 @@
 Tools for handling GCAM output databases
 """
 
-from gcam_reader.querymi import *
+from gcamreader.querymi import *
 
 __all__ = ['querymi']
 
diff --git a/gcam_reader/querymi.py → gcamreader/querymi.py b/gcam_reader/querymi.py → gcamreader/querymi.py
@@ -66,7 +66,7 @@ def parse_batch_query(filename):
 ### Default class path for the GCAM model interface
 ### On unix this should produce something like:
 ###    /foo/bar/baz/jars/*:/foo/bar/baz/ModelInterface.jar
-_mifiles_dir = pkg_resources.resource_filename('gcam_reader', 'ModelInterface')
+_mifiles_dir = pkg_resources.resource_filename('gcamreader', 'ModelInterface')
 
 
 _default_miclasspath = (

diff --git a/gcam_reader/test_components.ipynb → gcamreader/test_components.ipynb b/gcam_reader/test_components.ipynb → gcamreader/test_components.ipynb
diff --git a/gcam_reader/tests/__init__.py → gcamreader/tests/__init__.py b/gcam_reader/tests/__init__.py → gcamreader/tests/__init__.py
diff --git a/...er/tests/data/comp_outputs/land_query.csv → ...er/tests/data/comp_outputs/land_query.csv b/...er/tests/data/comp_outputs/land_query.csv → ...er/tests/data/comp_outputs/land_query.csv
diff --git a/...ies/query_land_reg32_basin235_gcam5p0.xml → ...ies/query_land_reg32_basin235_gcam5p0.xml b/...ies/query_land_reg32_basin235_gcam5p0.xml → ...ies/query_land_reg32_basin235_gcam5p0.xml
diff --git a/...eader/tests/data/sample_basexdb/atv.basex → ...eader/tests/data/sample_basexdb/atv.basex b/...eader/tests/data/sample_basexdb/atv.basex → ...eader/tests/data/sample_basexdb/atv.basex
diff --git a/...eader/tests/data/sample_basexdb/inf.basex → ...eader/tests/data/sample_basexdb/inf.basex b/...eader/tests/data/sample_basexdb/inf.basex → ...eader/tests/data/sample_basexdb/inf.basex
diff --git a/...eader/tests/data/sample_basexdb/tbl.basex → ...eader/tests/data/sample_basexdb/tbl.basex b/...eader/tests/data/sample_basexdb/tbl.basex → ...eader/tests/data/sample_basexdb/tbl.basex
diff --git a/...ader/tests/data/sample_basexdb/tbli.basex → ...ader/tests/data/sample_basexdb/tbli.basex b/...ader/tests/data/sample_basexdb/tbli.basex → ...ader/tests/data/sample_basexdb/tbli.basex
diff --git a/...eader/tests/data/sample_basexdb/txt.basex → ...eader/tests/data/sample_basexdb/txt.basex b/...eader/tests/data/sample_basexdb/txt.basex → ...eader/tests/data/sample_basexdb/txt.basex
diff --git a/...ader/tests/data/sample_basexdb/txtl.basex → ...ader/tests/data/sample_basexdb/txtl.basex b/...ader/tests/data/sample_basexdb/txtl.basex → ...ader/tests/data/sample_basexdb/txtl.basex
diff --git a/...ader/tests/data/sample_basexdb/txtr.basex → ...ader/tests/data/sample_basexdb/txtr.basex b/...ader/tests/data/sample_basexdb/txtr.basex → ...ader/tests/data/sample_basexdb/txtr.basex
diff --git a/gcam_reader/tests/test_querymi.py → gcamreader/tests/test_querymi.py b/gcam_reader/tests/test_querymi.py → gcamreader/tests/test_querymi.py
@@ -10,7 +10,7 @@
 import pkg_resources
 import unittest
 
-import gcam_reader
+import gcamreader
 
 import pandas as pd
 
@@ -19,11 +19,11 @@ class QueryTests(unittest.TestCase):
     """Test configuration integrity."""
 
     TEST_GCAM_DB = 'sample_basexdb'
-    TEST_GCAM_DB_PATH = pkg_resources.resource_filename('gcam_reader', 'tests/data')
-    TEST_LAND_QUERY = pkg_resources.resource_filename('gcam_reader', 'tests/data/queries/query_land_reg32_basin235_gcam5p0.xml')
+    TEST_GCAM_DB_PATH = pkg_resources.resource_filename('gcamreader', 'tests/data')
+    TEST_LAND_QUERY = pkg_resources.resource_filename('gcamreader', 'tests/data/queries/query_land_reg32_basin235_gcam5p0.xml')
 
     # CSV file from existing land allocation query output
-    COMP_LAND_OUTPUT = pd.read_csv(pkg_resources.resource_filename('gcam_reader', 'tests/data/comp_outputs/land_query.csv'))
+    COMP_LAND_OUTPUT = pd.read_csv(pkg_resources.resource_filename('gcamreader', 'tests/data/comp_outputs/land_query.csv'))
 
     def __init__(self, obj):
 
@@ -36,18 +36,18 @@ def __init__(self, obj):
     @classmethod
     def create_connection(cls):
         """Create database connection."""
-        return gcam_reader.LocalDBConn(cls.TEST_GCAM_DB_PATH, cls.TEST_GCAM_DB)
+        return gcamreader.LocalDBConn(cls.TEST_GCAM_DB_PATH, cls.TEST_GCAM_DB)
 
     def test_connection(self):
-        """Check the type output of the gcam_reader DB object."""
+        """Check the type output of the gcamreader DB object."""
 
-        self.assertEqual(str(type(self.conn)), "<class 'gcam_reader.querymi.LocalDBConn'>")
+        self.assertEqual(str(type(self.conn)), "<class 'gcamreader.querymi.LocalDBConn'>")
 
     def test_land_query(self):
         """Test for land output data frame equality from query."""
 
         # get land allocation query
-        query = gcam_reader.parse_batch_query(QueryTests.TEST_LAND_QUERY)[0]
+        query = gcamreader.parse_batch_query(QueryTests.TEST_LAND_QUERY)[0]
 
         # get run output for land
         df = self.conn.runQuery(query)

diff --git a/gcam_reader/using-gcam-reader.ipynb → gcamreader/using-gcam-reader.ipynb b/gcam_reader/using-gcam-reader.ipynb → gcamreader/using-gcam-reader.ipynb
diff --git a/setup.py b/setup.py
@@ -1,12 +1,19 @@
 from setuptools import setup, find_packages
 
 
+def readme():
+    """Return the contents of the project README file."""
+    with open('README.md') as f:
+        return f.read()
+
 setup(
-    name="gcam_reader",
-    version="1.2.1",
+    name="gcamreader",
+    version="1.2.4",
     python_requires=">=3.6",
     packages=find_packages(),
     description="Tools for importing GCAM output data",
+    long_description=readme(),
+    long_description_content_type="text/markdown",
     url="https://github.com/JGCRI/gcam_reader",
     license='BSD 2-Clause',
     author="Robert Link",