Update docs for v0.4

.github/workflows/documentation.yml

@@ -0,0 +1,21 @@
+name: Documenter
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+    tags: ['*']
+
+jobs:
+  Documenter:
+    permissions:
+      contents: write
+    name: Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: julia-actions/julia-buildpkg@latest
+      - uses: julia-actions/julia-docdeploy@latest
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}

.github/workflows/test_examples.yml

@@ -0,0 +1,46 @@
+name: Test-examples
+
+on:
+  push:
+  schedule:
+    - cron: 21 4 * * * # Run at 12:21am US Eastern time
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        branch: ["main", "develop"]
+        version: ["1.8", "1.9", '1']
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ matrix.branch }}
+      - uses: julia-actions/[email protected]
+      - uses: julia-actions/setup-julia@latest
+        with:
+          version: ${{ matrix.version }}
+      - uses: julia-actions/julia-buildpkg@v1
+      - name: Test examples
+        shell: julia --project=. --color=yes {0}
+        run: |
+          using GenX
+          using Test
+
+          base_path = Base.dirname(Base.dirname(pathof(GenX)))
+          examples_path = joinpath(base_path, "example_systems")
+
+          if !isdir(examples_path)
+              @warn "No example systems found in $examples_path"
+              exit(0)
+          end
+
+          @testset "Test examples" begin 
+            for example_dir in readdir(examples_path, join=true)
+              if isdir(example_dir) && isfile(joinpath(example_dir, "Run.jl"))
+                  @info "Running example in $example_dir"
+                  @test isnothing(run_genx_case!(example_dir))
+              end
+            end
+          end

.gitignore

@@ -27,26 +27,8 @@ test/Logs
 ~$*
 
 # Never include output folders
-**/Results*/
-**/TDR_Results/
-
-# Example systems which may be or have been under development
-Example_Systems/NYISO*
-Example_Systems/RealSystemExample/PG_Test_2030_p1/
-Example_Systems/RealSystemExample/Inputs/
-Example_Systems/SmallNewEngland/ThreeZones_full*
-Example_Systems/SmallNewEngland/Test_Up_Time/
-Example_Systems/SmallNewEngland/Test_Down_Time/
-2050/
-
-Example_Systems/SmallNewEngland/ThreeZones_full.zip
-Example_Systems/SmallNewEngland/ThreeZones_full/*
-
-Example_Systems/SmallNewEngland/ThreeZones_MultiStage/Inputs/*
-test_get_retirement_period.jl
+**/results*/
+**/TDR_results/
 
 # Test files
-test/TDR/TDR_Results_test
-test/MethodofMorris/morris.csv
-!test/VREStor/Results_true/
-!test/ThreeZones/Results_true/
+test/TDR/TDR_results_test

CHANGELOG.md

@@ -25,11 +25,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Maintenance formulation for thermal-commit plants (#556).
 - Add new tests for GenX: three-zone, multi-stage, electrolyzer, VRE+storage, 
   piecewise_fuel+CO2, and TDR (#563 and #578).
+- Added a DC OPF method (#543) to calculate power flows across all lines
 - Added write_operating_reserve_price_revenue.jl to compute annual operating reserve and regulation revenue.
   Added the operating reserve and regulation revenue to net revenue (PR # 611)
 - Add functions to compute conflicting constraints when model is infeasible if supported by the solver (#624).
 - New settings parameter, VirtualChargeDischargeCost to test script and VREStor example case. The PR 608 attempts to 
   introduce this parameter as cost of virtual charging and discharging to avoid unusual results (#608). 
+- New settings parameter, StorageVirtualDischarge, to turn storage virtual charging and discharging off if desired by the user (#638).
 
 
 ### Fixed
@@ -49,6 +51,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fix cost assignment to virtual storage charge/discharge - issue #604 (#608)
 - Fix modeling of hydro reservoir with long duration storage (#572).
 - Fix update of starting transmission capacity in multistage GenX
+- Fix write_status with UCommit = WriteShadowPrices = 1 (#645)
 
 ### Changed
 - Use add_to_expression! instead of the += and -= operators for memory performance improvements (#498).
@@ -71,6 +74,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   The new files are: `Thermal.csv`, `Hydro.csv`, `Vre.csv`, `Storage.csv`, `Flex_demand.csv`, `Must_run.csv`, 
   `Electrolyzer.csv`, and `Vre_stor.csv`. The examples have been updated, and new tests have been added to 
   check the new data format (#612).
+- The settings parameter `Reserves` has been renamed to `OperationalReserves`, `Reserves.csv` to 
+  `Operational_reserves.csv`, and the `.jl` files contain the word `reserves` have been renamed to
+  `operational_reserves` (#641).
+- New folder structure for a GenX case. The input files are now organized in the following folders: `settings`, 
+  `policies`, `resources` and `system`. The examples and tests have been updated to reflect this change. 
 
 ### Deprecated
 - The above `load` keys, which generally refer to electrical demand, are being deprecated.