Merge branch 'main' of https://github.com/NREL/mappymatch

.github/workflows/lint_test.yml → .github/workflows/lint-test.yml

@@ -13,19 +13,19 @@ jobs:
       matrix:
         python-version: ["3.9", "3.10", "3.11", "3.12"]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           pip install .[tests]
-      - name: Run black
-        run: black . --check
-      - name: Run ruff
+      - name: Run ruff linting
         run: ruff check .
+      - name: Run ruff formatting
+        run: ruff format --check
       - name: Run mypy
         run: mypy .
       - name: Run Tests

.github/workflows/release.yaml

@@ -8,26 +8,26 @@ jobs:
   deploy:
     runs-on: ubuntu-latest
     environment:
-        name: pypi
-        url: https://pypi.org/project/mappymatch/
+      name: pypi
+      url: https://pypi.org/project/mappymatch/
     permissions:
-        id-token: write 
+      id-token: write
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python
-      uses: actions/setup-python@v4
-      with:
-        python-version: '3.9'
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install build
-    - name: Build package
-      run: |
-        python -m build
-    - name: Upload artifacts
-      uses: actions/upload-artifact@v3
-      with:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.9"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install hatch
+      - name: Build package
+        run: |
+          hatch build
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v3
+        with:
           path: ./dist/*
-    - name: Publish package
-      uses: pypa/gh-action-pypi-publish@release/v1
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@release/v1

.pre-commit-config.yaml

@@ -1,11 +1,13 @@
-repos: 
--   repo: https://github.com/psf/black
-    rev: 22.10.0
-    hooks:
-    -   id: black 
-        args: [--config, pyproject.toml]
--   repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.0.188
-    hooks:
-      - id: ruff
-
+repos:
+    - repo: https://github.com/charliermarsh/ruff-pre-commit
+      rev: v0.8.0
+      hooks:
+          - id: ruff
+          - id: ruff-format
+
+    - repo: https://github.com/pre-commit/mirrors-mypy
+      rev: "v1.13.0"
+      hooks:
+          - id: mypy
+            additional_dependencies:
+                [matplotlib, pandas-stubs, pytest, types-requests]

CONTRIBUTING.md

@@ -0,0 +1,71 @@
+# Contributing to mappymatch
+
+Thank you for considering contributing to mappymatch.
+This document provides a high-level overview of how you can get involved.
+
+## Asking Questions
+
+Have a question? Rather than opening an issue directly, please ask questions
+or post comments in [Q&A Discussions](https://github.com/NREL/mappymatch/discussions/categories/q-a).
+The NREL team or other members of the community will assist. Your well-worded
+question will serve as a resource to others searching for help.
+
+## Providing Feedback
+
+Your comments and feedback are very welcome. Please post to
+[General Discussions](https://github.com/NREL/mappymatch/discussions/categories/general)
+with lots of information and detail. It is beneficial to consider
+how someone else will understand your comments in order to make
+them most effective.
+
+## Reporting Issues
+
+Have you identified a reproducible problem in mappymatch?
+Have a feature request? We want to hear about it! Here's how you can make
+reporting your issue as effective as possible.
+
+### Look For an Existing Issue
+
+Before you create a new issue, please do a search in
+[open issues](https://github.com/NREL/mappymatch/issues) to see if
+the issue or feature request has already been filed.
+
+If you find your issue already exists, make relevant comments and add your
+[reaction](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments).
+Use a reaction in place of a "+1" comment:
+
+- 👍 - upvote
+- 👎 - downvote
+
+If you cannot find an existing issue that describes your bug or feature,
+create a new issue using the guidelines below.
+
+### Writing Good Bug Reports and Feature Requests
+
+File a single issue per problem and feature request. Do not enumerate
+multiple bugs or feature requests in the same issue.
+
+Do not add your issue as a comment to an existing issue unless it's for the
+identical input. Many issues look similar, but have different causes.
+
+The more information you can provide, the more likely someone will
+be successful at reproducing the issue and finding a fix.
+
+Please follow the issue template guidelines to include relevant information
+that will help in diagnosing the problem.
+
+### Final Checklist
+
+Please remember to do the following:
+
+- [ ] Search the issue repository to ensure your report is a new issue
+
+- [ ] Recreate the issue with a minimally descriptive example
+
+- [ ] Simplify your code around the issue to better isolate the problem
+
+## Contributing Fixes
+
+If you are interested in writing code to fix an issue or
+submit a new feature, let us know in
+[Ideas Discussions](https://github.com/NREL/mappymatch/discussions/categories/ideas)!

docs/_autosummary/mappymatch.constructs.coordinate.rst

@@ -0,0 +1,12 @@
+mappymatch.constructs.coordinate
+================================
+
+.. automodule:: mappymatch.constructs.coordinate
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Coordinate
+

docs/_autosummary/mappymatch.constructs.geofence.rst

@@ -0,0 +1,12 @@
+mappymatch.constructs.geofence
+==============================
+
+.. automodule:: mappymatch.constructs.geofence
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Geofence
+

docs/_autosummary/mappymatch.constructs.match.rst

@@ -0,0 +1,12 @@
+mappymatch.constructs.match
+===========================
+
+.. automodule:: mappymatch.constructs.match
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Match
+

docs/_autosummary/mappymatch.constructs.road.rst

@@ -0,0 +1,13 @@
+mappymatch.constructs.road
+==========================
+
+.. automodule:: mappymatch.constructs.road
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Road
+      RoadId
+

docs/_autosummary/mappymatch.constructs.rst

@@ -0,0 +1,17 @@
+mappymatch.constructs
+=====================
+
+.. automodule:: mappymatch.constructs
+
+
+.. rubric:: Modules
+
+.. autosummary::
+   :toctree:
+   :recursive:
+
+   coordinate
+   geofence
+   match
+   road
+   trace

docs/_autosummary/mappymatch.constructs.trace.rst

@@ -0,0 +1,12 @@
+mappymatch.constructs.trace
+===========================
+
+.. automodule:: mappymatch.constructs.trace
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Trace
+

docs/_autosummary/mappymatch.maps.igraph.igraph_map.rst

@@ -0,0 +1,12 @@
+mappymatch.maps.igraph.igraph\_map
+==================================
+
+.. automodule:: mappymatch.maps.igraph.igraph_map
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      IGraphMap
+

docs/_autosummary/mappymatch.maps.igraph.rst

@@ -0,0 +1,13 @@
+mappymatch.maps.igraph
+======================
+
+.. automodule:: mappymatch.maps.igraph
+
+
+.. rubric:: Modules
+
+.. autosummary::
+   :toctree:
+   :recursive:
+
+   igraph_map

docs/_autosummary/mappymatch.maps.map_interface.rst

@@ -0,0 +1,12 @@
+mappymatch.maps.map\_interface
+==============================
+
+.. automodule:: mappymatch.maps.map_interface
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      MapInterface
+

docs/_autosummary/mappymatch.maps.nx.nx_map.rst

@@ -0,0 +1,12 @@
+mappymatch.maps.nx.nx\_map
+==========================
+
+.. automodule:: mappymatch.maps.nx.nx_map
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      NxMap
+