Merge pull request #17 from WISDEM/develop

New features and updated documentation

.flake8

@@ -4,3 +4,4 @@ select=C,E,F,W,B,B950
 ignore=E203,E501,W503
 exclude=.git,__pycache__,docs/source/conf.py,build,dist,.ipynb_checkpoints
 per-file-ignores=__init__.py: F401
+docstring-convention=numpy

.github/workflows/gh_pages.yml

@@ -2,7 +2,7 @@ name: Documentation
 
 on:
   push:
-    branches: [main, master]
+    branches: [main]
 
 jobs:
   make-pages:

.isort.cfg

@@ -1,6 +1,6 @@
 [settings]
 
-not_skip=__init__.py
+skip_glob=wombat/windarm/system/__init__.py
 
 multi_line_output=3
 
@@ -13,6 +13,7 @@ combine_as_imports=True
 force_grid_wrap=0
 include_trailing_comma=True
 use_parentheses=True
+length_sort=True
 
 lines_after_imports=2
 line_length=88

.mypy.ini

@@ -1,5 +1,6 @@
 [mypy]
 
+exclude=/docs/,./build/
 ignore_missing_imports=True
 no_implicit_optional=True
 check_untyped_defs=True

.pre-commit-config.yaml

@@ -1,26 +1,28 @@
 repos:
--   repo: https://github.com/timothycrosley/isort
-    rev: 4.3.21
+-   repo: https://github.com/pycqa/isort
+    rev: 5.10.1
     hooks:
         - id: isort
           name: isort
           stages: [commit]
 
 -   repo: https://github.com/psf/black
-    rev: stable
+    rev: 21.12b0
     hooks:
         - id: black
           name: black
           stages: [commit]
           language_version: python3.7
 
 -   repo: https://github.com/pre-commit/mirrors-mypy
-    rev: ''  # Use the sha / tag you want to point at
+    rev: 'v0.910-1'  # Use the sha / tag you want to point at
     hooks:
     -   id: mypy
+        entry: mypy --install-types --non-interactive
+        exclude: ^docs/
 
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.3.0
+    rev: v4.0.1
     hooks:
     -   id: trailing-whitespace
     -   id: end-of-file-fixer
@@ -32,14 +34,17 @@ repos:
     -   id: mixed-line-ending
     -   id: pretty-format-json
         args: [--autofix]
+
+-   repo: https://github.com/pycqa/flake8
+    rev: '4.0.1'
+    hooks:
     -   id: flake8
-        exclude: ^tests/
 
 -   repo: https://github.com/pre-commit/mirrors-pylint
-    rev: v2.1.1
+    rev: v3.0.0a4
     hooks:
     -   id: pylint
-        exclude: ^tests/
+        exclude: ^(tests/|docs/)
 
 # -   repo: local
 #     hooks:

.pylintrc

@@ -284,7 +284,7 @@ ignore-docstrings=yes
 ignore-imports=no
 
 # Minimum lines number of a similarity.
-min-similarity-lines=4
+min-similarity-lines=7
 
 
 [SPELLING]

CHANGELOG.md

@@ -1,3 +1,30 @@
-# 0.3.1 (2021-March-2)
+## 0.3.5 (2021-December-9)
 
- - Updated the the `simulation/` folder to be a single-level `core/` directory.
+- Downtime-based and requests-based unscheduled maintenance models have been added to
+  servicing equipment.
+- `Windfarm.current_availability` is able to account for multiple substations and is now
+  an accurate calculation of the operating level across the windfarm.
+- `Simulation.from_inputs()` is replaced by `Simulation.from_config()` to be more
+  straightfoward for users.
+- `ServiceCrew` has been added for expansion to multiple crews.
+- Servicing equipment now have separate `travel` and `crew_transfer`, `weather_delay`,
+  and `repair` functions to more realistically simulate the separate processes involved.
+- The windfarm now has a distance matrix to calculate the distance between any two
+  systems oniste, for instance, substation to cable, cable to turbine, etc.
+- Bug fix in the task completion rate metric.
+- `WombatEnvironment.log_action()` enforces the use of keyword arguments with only 3
+  required inputs.
+- `WombatEnvironment.weather_forecast()` outputs now include the datetime index.
+- If no PySAM settings are provided, the `financial_model` will be set to `None` with a
+  `NotImplementedError` being raised for any attempted usage of the PySAM-powered
+  functionality.
+- Fix bugs in `Maintenance` and `Failure` initializations.
+- Fix bugs in operating level accounting from recent updates.
+- Update the unicode typing in all docstrings.
+- Update the documentation to account for all the recent changes, including adding a new
+  demonstration notebook for the 3 new strategies.
+
+## 0.3.1 (2021-March-2)
+
+- Updated the the `simulation/` folder to be a single-level `core/` directory.
+- Updates the order of the keyword arguments for WombatEnvironment.log_action(), and makes all arguments keyword-only arguments.