Ndr/update docs

.github/workflows/deploy-docs.yaml

@@ -29,6 +29,10 @@ jobs:
           conda install -c conda-forge osmnx
           pip install ".[dev]"
 
+      - name: Convert examples to notebooks
+        run: |
+          python docs/examples/_convert_examples_to_notebooks.py
+
       - name: Build book
         run: |
           jupyter-book build docs/

.github/workflows/lint-test.yml

@@ -18,15 +18,23 @@ jobs:
         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 ruff linting
         run: ruff check .
+
       - name: Run ruff formatting
         run: ruff format --check
+
       - name: Run mypy
         run: mypy .
+
       - name: Run Tests
         run: pytest tests
+
+      - name: Run Examples 
+        run: python docs/examples/lcss_example.py 

.gitignore

@@ -2,6 +2,8 @@
 
 .DS_Store
 
+*.ipynb
+
 .idea/
 cache/
 .vscode/
@@ -18,6 +20,7 @@ __pycache__/
 # Distribution / packaging
 .Python
 build/
+_build/
 develop-eggs/
 dist/
 downloads/
@@ -79,6 +82,7 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/_autosummary/
 
 # PyBuilder
 .pybuilder/

CLAUDE.md

@@ -14,4 +14,9 @@ Mappymatch is a python package used to match a series of GPS waypoints (Trace) t
 ```
 pixi run -e dev check
 ```
+### building the docs
+
+```
+pixi run docs
+```
 

LICENSE

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2022, Alliance for Sustainable Energy, LLC 
+Copyright (c) 2022, Alliance for Energy Innovation, LLC 
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

README.md

@@ -1,6 +1,6 @@
 # mappymatch
 
-Mappymatch is a pure-python package developed and open sourced by the National Renewable Energy Laboratory. It contains a collection of "Matchers" that enable matching a GPS trace (series of GPS coordinates) to a map.
+Mappymatch is a pure-python package developed and open sourced by the National Laboratory of the Rockies. It contains a collection of "Matchers" that enable matching a GPS trace (series of GPS coordinates) to a map.
 
 ![Map Matching Animation](docs/images/map-matching.gif?raw=true)