Merge pull request #193 from NREL/ndr/add-geoframe-methods

add methods to convert results to geodataframe

.github/workflows/lint_test.yml

@@ -11,7 +11,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
     steps:
       - uses: actions/checkout@v3
       - name: Set up Python ${{ matrix.python-version }}

.github/workflows/release.yaml

@@ -17,7 +17,7 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@v4
       with:
-        python-version: '3.8'
+        python-version: '3.9'
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip

.readthedocs.yaml

@@ -1,9 +1,9 @@
 version: 2
 
 build: 
-  os: ubuntu-20.04
+  os: ubuntu-22.04
   tools: 
-    python: "3.8"
+    python: "3.12"
 
 python: 
   install: 

docs/source/conf.py

@@ -21,7 +21,7 @@
 author = "National Renewable Energy Laboratory"
 # Initial releases at 0.x.x
 # First stable release at 1.x.x
-full_version = "0.4.1"
+full_version = "0.4.5"
 version = full_version
 # Full version for display in various places.
 release = full_version
@@ -56,7 +56,6 @@
 #
 html_theme = "sphinx_rtd_theme"
 html_theme_options = {
-    "display_version": True,
     "style_external_links": True,
     "style_nav_header_background": "#9B59B6",
 }

docs/source/general/install.rst

@@ -1,8 +1,16 @@
 Install
 ================== 
 
-From Source (recommended) 
+From PyPI (recommended)
+---------
+
+.. code-block::
+
+  pip install mappymatch 
+
+From Source  
 -------------------------
+
 Clone the repo::
 
    git clone https://github.com/NREL/mappymatch.git && cd mappymatch
@@ -15,12 +23,6 @@ To activate the mappymatch environment::
 
    conda activate mappymatch
 
-From PyPI
----------
-
-.. code-block::
-
-  pip install mappymatch 
 
 .. warning::
 

docs/source/reference/maps.rst

@@ -16,11 +16,6 @@ NxMap
 .. autoclass:: mappymatch.maps.nx.nx_map.NxMap
     :members:
 
-Utility Functions 
-----------------------
-.. autofunction:: mappymatch.maps.nx.nx_map.parse_osmnx_graph 
-.. autofunction:: mappymatch.maps.nx.nx_map.compress
-
 Map interface 
 ------------------- 
 

environment.yml

@@ -4,7 +4,7 @@ channels:
   - conda-forge
   - defaults
 dependencies:
-  - python=3.10
+  - python=3.12
   - folium
   - geopandas
   - matplotlib

pyproject.toml

@@ -15,7 +15,7 @@ classifiers = [
   "License :: Other/Proprietary License",
   "Operating System :: OS Independent",
   "Programming Language :: Python",
-  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.12",
   "Topic :: Scientific/Engineering",
 ]
 keywords = ["GPS", "map", "match"]
@@ -34,13 +34,13 @@ dependencies = [
   "requests",
   "polyline",
 ]
-requires-python = ">=3.8"
+requires-python = ">=3.9"
 
 [project.optional-dependencies]
 # Used to run CI. 
 tests = ["black", "ruff", "mypy>=0.981", "types-requests", "pytest"]
 # Used to build the docs.
-docs = ["sphinx==4.5.0", "sphinx_rtd_theme==1.0.0", "sphinxemoji==0.2.0"]
+docs = ["sphinx>=8.1", "sphinx_rtd_theme>=3.0", "sphinxemoji>=0.3.1"]
 # Tests + docs + other.
 dev = [
   "mappymatch[tests]",
@@ -77,7 +77,7 @@ exclude = '''
 '''
 include = '\.pyi?$'
 line-length = 79
-target-version = ['py38']
+target-version = ['py39']
 
 [tool.ruff]
 line-length = 79