First Release (#1)

* update gitignore

* utilize rst for readme

* update auto checking settings

* first pass of documentation without examples

* convert project entirely to pyproject.toml

* add waves package

* fix updates from wombat v0.9

* add example and update docs

* update gitignore

* update pre-commit

* udpate docs and pre-commit

* add the COE review library

* update docstrings

* fix typos

* fix bug in energy potential

* fix mixed docstring style to consistently numpy

* add ability to use no kwargs def in

* reconfigure api autogeneration

* update running settings

* fix broken links

* update example formatting

* add comments to top-level configurations

* update autosummary

* update example

* update layout elements and some content

* fix misconfiguration in _config

* fix formatting, content, and issue with default kwargs

* add report_config to options and enable CLI

* add a basic CLI

* update examples to run with CLI

* update docs

* update docstring

* reconfigure tests for analysis updates and non-associative naming

* update allowed ruff errors

* add zipped weather files and ignore CSV weather files

* update gitignore to properly ignore weather csv files

* drop bad references and update naming conventions

* add default settings for demonstration

* update cli documentation and add it to dependencies

* udpate documentation and example commentary

* add examples installation modifier

* update cli documentation and placement in docs

* update user guide and autosummary

.github/workflows/gh_pages.yml

@@ -0,0 +1,33 @@
+name: Documentation
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  make-pages:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install ".[docs]"
+
+      - name: Build documentation
+        run: |
+          jupyter-book build docs/
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3.6.1
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/_build/html
+          force_orphan: true
+          full_commit_message: ${{ github.event.head_commit.message }}

.github/workflows/python-publish-test.yml

@@ -16,7 +16,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Set up Python
         uses: actions/setup-python@v4

.github/workflows/python-publish.yml

@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Set up Python
         uses: actions/setup-python@v4

.gitignore

@@ -131,8 +131,9 @@ dmypy.json
 # MacOS Files
 *.DS_Store
 
+# VSCode Files
+.vscode/
+
 # Project specific
-examples/library/results
-library/results
-examples/library/weather
-library/weather
+*results/
+*/weather/*.csv

.pre-commit-config.yaml

@@ -1,63 +1,45 @@
 default_language_version:
     python: python3
 repos:
--   repo: https://github.com/pycqa/isort
-    rev: 5.12.0
-    hooks:
-        - id: isort
-          name: isort
-          stages: [commit]
+- repo: https://github.com/pycqa/isort
+  rev: 5.12.0
+  hooks:
+  - id: isort
+    name: isort
+    stages: [commit]
 
 - repo: https://github.com/psf/black
-  rev: 23.1.0
+  rev: 23.11.0
   hooks:
   - id: black
     name: black
     stages: [commit]
 
 - repo: https://github.com/pre-commit/mirrors-mypy
-  rev: 'v1.1.1'  # Use the sha / tag you want to point at
+  rev: 'v1.7.0'  # Use the sha / tag you want to point at
   hooks:
   - id: mypy
     entry: mypy --install-types --non-interactive --config-file .mypy.ini
     exclude: (^docs/|^tests/)
     additional_dependencies: ["types-python-dateutil", "types-attrs", "types-PyYAML"]
 
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.4.0
+  rev: v4.5.0
   hooks:
-  -   id: trailing-whitespace
-  -   id: end-of-file-fixer
-  -   id: check-executables-have-shebangs
-  -   id: check-json
-  -   id: check-yaml
-      exclude: (^library/code_comparison/iea26/results/)|(^library/code_comparison/dinwoodie/results/)
-  -   id: check-merge-conflict
-  -   id: check-symlinks
-  -   id: mixed-line-ending
-  -   id: pretty-format-json
-      args: [--autofix]
-
+  - id: trailing-whitespace
+  - id: end-of-file-fixer
+  - id: check-executables-have-shebangs
+  - id: check-json
+  - id: check-yaml
+    args: [--unsafe]  # allow Python constructors
+  - id: check-merge-conflict
+  - id: check-symlinks
+  - id: mixed-line-ending
+  - id: pretty-format-json
+    args: [--autofix]
 
 - repo: https://github.com/charliermarsh/ruff-pre-commit
-  rev: v0.0.255
+  rev: v0.1.5
   hooks:
   - id: ruff
     args: [--fix]
-
-# -   repo: local
-#     hooks:
-#     - id: pytest
-#       name: pytest
-#       stages: [commit]
-#       entry: pytest --tb=line --deselect=setup.py tests/
-#       language: system
-#       types: [python]
-
-#     - id: pytest-cov
-#       name: pytest-cov
-#       stages: [commit]
-#       language: system
-#       entry: pytest --cov=wombat --tb=no --ignore=*setup.py --cov-fail-under=80
-#       types: [python]
-#       pass_filenames: false