Merge pull request #2 from ait-energy/dev

Add initial version of `src` and `test`, simplified tests are passing, docs are building, PR docs preview is set up.

.github/workflows/CI.yml

@@ -24,7 +24,6 @@ jobs:
       matrix:
         version:
           - '1.10'
-          - '1.9'
         os:
           - ubuntu-latest
         arch:

.github/workflows/DocPreviewCleanup.yml

@@ -0,0 +1,35 @@
+# See: https://documenter.juliadocs.org/stable/man/hosting/#Cleaning-up-gh-pages
+# for more information on why and how to use this workflow.
+
+name: DocPreviewCleanup
+
+on:
+  pull_request:
+    types: [closed]
+
+concurrency:
+  group: doc-preview-cleanup
+  cancel-in-progress: false
+
+jobs:
+  doc-preview-cleanup:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout gh-pages branch
+        uses: actions/checkout@v4
+        with:
+          ref: gh-pages
+      - name: Delete preview and history + push changes
+        run: |
+          if [ -d "${preview_dir}" ]; then
+              git config user.name "Documenter.jl"
+              git config user.email "documenter@juliadocs.github.io"
+              git rm -rf "${preview_dir}"
+              git commit -m "delete preview"
+              git branch gh-pages-new $(echo "delete history" | git commit-tree HEAD^{tree})
+              git push --force origin gh-pages-new:gh-pages
+          fi
+        env:
+          preview_dir: previews/PR${{ github.event.number }}

ARCHITECTURE.md

@@ -0,0 +1,3 @@
+# Architecture
+
+To be added (see [matklad.github.io](https://matklad.github.io//2021/02/06/ARCHITECTURE.md.html)).

Project.toml

@@ -8,7 +8,6 @@ CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"
 DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
 HiGHS = "87dc4568-4c63-4d18-b0c0-bb2238e4078b"
-IESoptLib = "b98f706d-40ec-4ce6-a66c-1c6e71d3cef6"
 JLD2 = "033835bb-8acc-5ee8-8aae-3f567f8a3819"
 JSON = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
 JuMP = "4076af6c-e467-56ae-b986-b466b2749572"
@@ -28,13 +27,36 @@ Tectonic = "9ac5f52a-99c6-489f-af81-462ef484790f"
 YAML = "ddb6d928-2868-570f-bddf-ab3f9cf99eb6"
 ZipFile = "a5390f91-8eb1-5f08-bee0-b1d1ffed6cea"
 
+[weakdeps]
+CPLEX = "a076750e-1247-5638-91d2-ce28b192dca0"
+Cbc = "9961bab8-2fa3-5c5a-9d89-47fab24efd76"
+GLPK = "60bf3e95-4087-53dc-ae20-288a0d20c6a6"
+Gurobi = "2e9cd046-0924-5485-92f1-d5272153d98b"
+IESoptLib = "b98f706d-40ec-4ce6-a66c-1c6e71d3cef6"
+Ipopt = "b6b21f68-93f8-5de0-b562-5493be1d77c9"
+SCIP = "82193955-e24f-5292-bf16-6f2c5261a85f"
+
+[extensions]
+CPLEX = "CPLEX"
+Cbc = "Cbc"
+GLPK = "GLPK"
+Gurobi = "Gurobi"
+IESoptLib = "IESoptLib"
+Ipopt = "Ipopt"
+SCIP = "SCIP"
+
 [compat]
 ArgCheck = "2.3.0"
+CPLEX = "1.0.3"
 CSV = "0.10"
+Cbc = "1.2.0"
 DataFrames = "1.6"
 Dates = "<0.0.1,1"
+GLPK = "1.2.1"
+Gurobi = "1.3.0"
 HiGHS = "1.9"
 IESoptLib = "0.1"
+Ipopt = "1.6.2"
 JLD2 = "0.4"
 JSON = "0.21"
 JuMP = "1.22"
@@ -49,8 +71,9 @@ PrecompileTools = "1.2"
 Printf = "<0.0.1,1"
 ProgressMeter = "1.10"
 RuntimeGeneratedFunctions = "0.5.13"
+SCIP = "0.11.14"
 Suppressor = "0.2"
 Tectonic = "0.8"
 YAML = "0.4"
 ZipFile = "0.10"
-julia = "1.9"
+julia = "1.10"

docs/Project.toml

@@ -1,5 +1,4 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 IESopt = "ed3f0a38-8ad9-4cf8-877e-929e8d190fe9"
-IESoptLib = "b98f706d-40ec-4ce6-a66c-1c6e71d3cef6"
 LiveServer = "16fef848-5104-11e9-1b77-fb7a48bbb589"

docs/make.jl

@@ -44,6 +44,13 @@ makedocs(;
 if !is_local_draft
     deploydocs(;
         repo="github.com/ait-energy/IESopt.jl",
-        devbranch="dev",
+        push_preview=true,      # previews for PRs (not from forks)
+        versions = [
+            "stable" => "v^",   # "stable" => latest version
+            "v#.#",             # include all minor versions
+            "dev" => "dev",
+            # "v#.#.#",         # use this to include all released versions
+            # "v1.1.6",         # use this to include a specific version
+        ]
     )
 end