Standardize ruff to precommit (#245)

* update ruff in precommit

* remove isort

* remove seperate ruff check and use precommit in ci

* pre-commit linting

* Add contribution docs page with pre-commit install instructions

---------

Co-authored-by: paulf81 <paul.fleming@nrel.gov>
Co-authored-by: Genevieve Starke <genevieve.starke@nrel.gov>

Author: 3 people

.github/dependabot.yml

@@ -9,4 +9,4 @@ updates:
     - "package"
   ignore:
     - dependency-name: "*"
-      update-types: ["version-update:semver-minor", "version-update:semver-patch"]
+      update-types: ["version-update:semver-minor", "version-update:semver-patch"]

.github/workflows/continuous-integration-workflow.yaml

@@ -22,11 +22,8 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install -e ".[develop]"
-#    - uses: pre-commit/action@v3.0.0
-    - name: Run ruff
-      run: |
-        ruff check .
-        ruff format --check
+    - uses: pre-commit/action@v3.0.0
+      if: matrix.python-version == '3.13'
     - name: Run tests and collect coverage
       run: |
         # -rA displays the captured output for all tests after they're run

.pre-commit-config.yaml

@@ -15,7 +15,7 @@ repos:
 
 - repo: https://github.com/astral-sh/ruff-pre-commit
   # Ruff version.
-  rev: v0.1.7
+  rev: v0.15.8
   hooks:
     # Run the linter.
     - id: ruff

LICENSE.txt

@@ -23,4 +23,4 @@ CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-POSSIBILITY OF SUCH DAMAGE.
+POSSIBILITY OF SUCH DAMAGE.

docs/_config.yml

@@ -37,6 +37,3 @@ html:
   use_edit_page_button: true
   analytics:
     google_analytics_id: G-3V1BDK8KEJ
-
-
-

docs/_static/thermal_startup_ramp.svg

@@ -1,10 +1,10 @@
 # Battery
 
-There are two battery models currently implemented in Hercules: `BatterySimple` and `BatteryLithiumIon`. 
+There are two battery models currently implemented in Hercules: `BatterySimple` and `BatteryLithiumIon`.
 
 ## Sign Conventions
 
-It is important to note that within the battery modules, the convention that positive power is charging the  
+It is important to note that within the battery modules, the convention that positive power is charging the
 battery is followed for consistency with battery standards.  However, at the level of the `HybridPlant`
 this is inverted, such that positive power implies power delivery (and thus the battery is discharging)
 for consistency with other components.  This inversion applies to power_setpoint and also occurs within
@@ -53,14 +53,14 @@ h_dict = {
 
 ### Outputs
 Outputs are returned as a dict containing the following values:
-- `power`: Actual battery power in kW 
+- `power`: Actual battery power in kW
 - `reject`: Rejected power due to constraints in kW (positive when power cannot be absorbed, negative when required power unavailable)
 - `soc`: Battery state of charge (0-1)
 - `power_setpoint`: Requested power setpoint in kW
 
 #### Additional Outputs (BatterySimple only when track_usage=True)
 - `usage_in_time`: Time-based usage percentage
-- `usage_in_cycles`: Cycle-based usage percentage  
+- `usage_in_cycles`: Cycle-based usage percentage
 - `total_cycles`: Total equivalent cycles completed
 
 (battery-logging-configuration)=

docs/battery.md

@@ -0,0 +1,31 @@
+# Contributing to Hercules
+
+We welcome contributions in the form of bug reports, bug fixes, improvements to the documentation,
+ideas for enhancements (or the enhancements themselves!).
+
+You can find a [list of current issues](https://github.com/NatLabRockies/hercules/issues) in the project's
+GitHub repo. Feel free to tackle any existing bugs or enhancement ideas by submitting a
+[pull request](https://github.com/NatLabRockies/hercules/pulls).
+
+
+## Pull Requests
+If you'd like to contribute code through a pull request, please read the following guidance:
+* Please reference relevant GitHub issues in your commit message using `GH123` or `#123`.
+* Changes should be [PEP8](http://www.python.org/dev/peps/pep-0008/) compatible.
+* Keep style fixes to a separate commit to make your pull request more readable.
+* Docstrings are required and should follow the
+  [Google style](https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html).
+* When you start working on a pull request, start by creating a new branch pointing at the latest
+  commit on [develop](https://github.com/NatLabRockies/hercules/tree/develop).
+* Code formatting is enforced using pre-commit hooks and is required for any code pushed up to the repository. The pre-commit package is included in the developer install of the repository. The pre-commit hooks can be installed by running
+```bash
+pre-commit install
+```
+in the repository directory. This will automatically run the pre-commit formatting hooks when code changes are committed. If you are having difficulty committing code after it has been reformatted by these hooks, try using the commit command
+```bash
+git commit -am "<Your commit message here>"
+```
+which will re-add the reformatted files to the commit.
+If changes are required, follow the suggested fix or resolve the stated issue(s). Restaging and committing may take multiple attempts steps if errors are unaddressed or insufficiently addressed. Please see [pre-commit](https://pre-commit.com/),
+[ruff](https://docs.astral.sh/ruff/), or [isort](https://pycqa.github.io/isort/) for more information.
+* The Hercules copyright policy is detailed in the [`LICENSE`](https://github.com/NatLabRockies/hercules/blob/main/LICENSE.txt).

docs/contribute.md

@@ -46,21 +46,21 @@ The parameters listed below are required unless otherwise specified as *Optional
         - `eol_eff_percent_loss`: End of life efficiency percent loss [%].
         - `PEM_params` or `ALK_params`: Degradation parameters specific to PEM or Alkaline cells:
             - `rate_steady`: Rate of voltage degradation under steady operation alone
-            - `rate_fatigue`: Rate of voltage degradation under variable operation alone 
+            - `rate_fatigue`: Rate of voltage degradation under variable operation alone
             - `rate_onoff`: Rate of voltage degradation per on/off cycle
     - `controller`: Electrolyzer control parameters including:
         - `control_type`: Controller type for electrolyzer plant operation.
     - `costs`: *Optional* Cost parameters for the electrolyzer plant including:
         - `plant_params`:
             - `plant_life`: integer, Plant life in years
-            - `pem_location`: Location of the PEM electrolyzer. Options are 
+            - `pem_location`: Location of the PEM electrolyzer. Options are
                 [onshore, offshore, in-turbine]
             - `grid_connected`: boolean, Whether the plant is connected to the grid or not
         - `feedstock`: Parameters related to the feedstock including:
             - `water_feedstock_cost`: Cost of water per kg of water
             - `water_per_kgH2`: Amount of water required per kg of hydrogen produced
         - `opex`: Operational expenditure parameters including:
-            - `var_OM`: Variable operation and maintenance cost per kW 
+            - `var_OM`: Variable operation and maintenance cost per kW
             - `fixed_OM`: Fixed operation and maintenance cost per kW-year
         - `stack_replacement`: Parameters related to stack replacement costs including:
             - `d_eol`: End of life cell voltage value [V]

docs/electrolyzer.md

@@ -22,4 +22,4 @@ To plot the outputs, run the following command in the terminal:
 
 ```bash
 python plot_outputs.py
-```
+```