Restructure and improve setup

Author: Saurav Agarwal

.git_archival.txt

@@ -0,0 +1,4 @@
+node: $Format:%H$
+node-date: $Format:%cI$
+describe-name: $Format:%(describe:tags=true,match=*[0-9]*)$
+ref-names: $Format:%D$

.gitattributes

@@ -1 +1,2 @@
+.git_archival.txt  export-subst
 *.ipynb -linguist-detectable

.github/CONTRIBUTING.md

@@ -0,0 +1,38 @@
+See [Installation From Source](https://KumarRobotics.github.io/CoverageControl/installation.html) for instructions on how to install from source.
+The core of the project is written in `C++` and the Python bindings are generated using `pybind11`. 
+The `Pytorch` neural network is purely written in `Python` and uses the core `C++` code for the coverage control simulation and testing.
+
+The repository is partially oraganized using the [Scientific Python Developer Guide][spc-dev-intro].
+[spc-dev-intro]: https://learn.scientific-python.org/development/
+
+## License
+
+Note that the repository is licensed under the GPL-3.0 License.
+This is primarily because the project uses [CGAL](https://www.cgal.org/) which is licensed under the GPL-3.0 License.
+Thus, any contributions to the project must also be licensed under the GPL-3.0 License.
+
+## Setting up a development environment manually
+
+You can set up a development environment by running:
+
+```bash
+python3 -m venv .venv
+source ./.venv/bin/activate
+pip install -v -e .
+```
+
+## Building docs
+
+The repository uses `doxygen` to build the documentation.
+Run the following command to build the documentation from the base directory of the repository:
+
+```bash
+doxygen doc/Doxyfile
+```
+
+This creates a static website in the `doc/html` directory.
+
+```bash
+cd doc/html
+firefox index.html
+```

.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    groups:
+      actions:
+        patterns:
+          - "*"

.github/docker-base-action/action.yml

@@ -38,14 +38,20 @@ runs:
       uses: docker/metadata-action@v5
       with:
         images: ghcr.io/${{ github.repository }}
-        tags: type=semver,pattern={{version}},suffix=-${{ inputs.base_tag }}
+        tags: |
+          type=semver,pattern={{version}},suffix=-${{ inputs.base_tag }}
+          type=raw,value=${{ inputs.base_tag }}
+    - name: Checkout
+      uses: actions/checkout@v4
     - name: Build and push
       uses: docker/build-push-action@v5
       with:
         provenance: false
         platforms: linux/amd64
         file: setup_utils/docker/Dockerfile
-        build-args: BASE_TAG=${{ inputs.base_tag }}
+        build-args: |
+          BASE_TAG=${{ inputs.base_tag }}
+          BUILDKIT_CONTEXT_KEEP_GIT_DIR=1
         push: true
         tags: ${{ steps.meta.outputs.tags }}
         labels: ${{ steps.meta.outputs.labels }}

.github/matchers/pylint.json

@@ -0,0 +1,32 @@
+{
+  "problemMatcher": [
+    {
+      "severity": "warning",
+      "pattern": [
+        {
+          "regexp": "^([^:]+):(\\d+):(\\d+): ([A-DF-Z]\\d+): \\033\\[[\\d;]+m([^\\033]+).*$",
+          "file": 1,
+          "line": 2,
+          "column": 3,
+          "code": 4,
+          "message": 5
+        }
+      ],
+      "owner": "pylint-warning"
+    },
+    {
+      "severity": "error",
+      "pattern": [
+        {
+          "regexp": "^([^:]+):(\\d+):(\\d+): (E\\d+): \\033\\[[\\d;]+m([^\\033]+).*$",
+          "file": 1,
+          "line": 2,
+          "column": 3,
+          "code": 4,
+          "message": 5
+        }
+      ],
+      "owner": "pylint-error"
+    }
+  ]
+}

.github/workflows/cd.yml

@@ -0,0 +1,40 @@
+name: docker-deploy
+on:
+  release:
+    types: [published]
+
+jobs:
+  docker-deploy:
+    permissions: write-all
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Free Disk Space (Ubuntu)
+        uses: jlumbroso/[email protected]
+      # - name: 'CI docker base'
+      #   uses: ./.github/docker-base-action
+      #   with:
+      #     base_tag: pytorch2.2.1-cuda12.3.1-ros2humble
+      #     github_token: ${{ secrets.GITHUB_TOKEN }}
+      # - name: cleanup
+      #   run: docker system prune -a -f
+      # - name: 'CI docker base'
+      #   uses: ./.github/docker-base-action
+      #   with:
+      #     base_tag: pytorch2.2.1-ros2humble
+      #     github_token: ${{ secrets.GITHUB_TOKEN }}
+      # - name: cleanup
+      #   run: docker system prune -a -f
+      # - name: 'CI docker base'
+      #   uses: ./.github/docker-base-action
+      #   with:
+      #     base_tag: pytorch2.2.1-cuda12.3.1
+      #     github_token: ${{ secrets.GITHUB_TOKEN }}
+      # - name: cleanup
+      #   run: docker system prune -a -f
+      - name: 'CI docker base'
+        uses: ./.github/docker-base-action
+        with:
+          base_tag: pytorch2.2.1
+          github_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/ci_docker.yml

@@ -1,3 +1,4 @@
+name: doxygen-ghpages
 on:
   release:
     types: [published]

.github/workflows/ghaction-doxygen-ghpages.yml

@@ -3,40 +3,8 @@ osm_dataset_generator/cache/
 osm_dataset_generator/leaflet_geojson_viz/data/
 doc/html/
 doc/latex/
-
-# Prerequisites
-*.d
-
-# Compiled Object files
-*.slo
-*.lo
-*.o
-*.obj
-
-# Precompiled Headers
-*.gch
-*.pch
-
-# Compiled Dynamic libraries
-*.so
-*.dylib
-*.dll
-
-# Fortran module files
-*.mod
-*.smod
-
-# Compiled Static libraries
-*.lai
-*.la
-*.a
-*.lib
-
-# Executables
-*.exe
-*.out
-*.app
-
+/pybind11
+third_party/
 
 # Byte-compiled / optimized / DLL files
 __pycache__/
@@ -51,6 +19,7 @@ __pycache__/
 build/
 develop-eggs/
 dist/
+wheelhouse/
 downloads/
 eggs/
 .eggs/
@@ -76,9 +45,124 @@ MANIFEST
 pip-log.txt
 pip-delete-this-directory.txt
 
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
 # Jupyter Notebook
 .ipynb_checkpoints
 
 # IPython
 profile_default/
 ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# setuptools_scm
+src/*/_version.py
+python/*/_version.py
+
+
+# ruff
+.ruff_cache/
+
+# OS specific stuff
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# Common editor files
+*~
+*.swp