Merge branch 'main' into input_docs

Author: tsmbland

.github/workflows/cargo-test.yml

@@ -4,9 +4,7 @@ on:
   push:
     branches: [main]
   pull_request:
-
-env:
-  CARGO_TERM_COLOR: always
+  workflow_dispatch:
 
 jobs:
   build_and_test:

.github/workflows/check-docs.yml

@@ -3,6 +3,7 @@ on:
   push:
     branches: [main]
   pull_request:
+  workflow_dispatch:
   schedule:
     - cron: "0 0 * * 1" # midnight every Monday
 

.github/workflows/pre-commit.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches: [main]
   pull_request:
+  workflow_dispatch:
 
 jobs:
   pre-commit:

.github/workflows/release.yml

@@ -0,0 +1,66 @@
+name: Release
+on:
+  push:
+    branches: [main]
+  release:
+  workflow_dispatch:
+
+jobs:
+  build_and_upload:
+    name: Build release
+    timeout-minutes: 15
+    runs-on: ${{ matrix.os }}
+    container:
+      image: ${{ matrix.image }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        archive_ext: [tar.gz]
+        archive_cmd: ["tar cf"]
+        include:
+          - os: ubuntu-latest
+            osname: linux
+            # We build on an old Linux distro so that we get an older version of libstdc++.
+            # libstdc++ has good backwards compatibility (but not forwards) so by linking against an
+            # old version, we can target more Linuxes.
+            image: debian:oldstable
+          - os: windows-latest
+            osname: windows
+            archive_ext: zip
+            archive_cmd: 7z a
+            exe_suffix: .exe
+          - os: macos-latest
+            osname: macos_arm
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install extra dependencies on Linux
+        if: ${{ matrix.osname == 'linux' }}
+        run: |
+          apt update
+          apt install -y curl build-essential cmake libclang-16-dev
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          toolchain: stable
+      - run: cargo build --release
+      - name: Gather release files
+        run: |
+          mkdir muse2
+          cp target/release/muse2${{ matrix.exe_suffix }} muse2
+          cp LICENSE muse2/LICENCE.txt
+          cp assets/readme/readme_${{ matrix.osname }}.txt muse2/README.txt
+      - uses: actions/upload-artifact@v4
+        if: ${{ github.event_name != 'release' }}
+        with:
+          name: muse2_${{ matrix.osname }}
+          path: muse2
+      - name: Archive release
+        if: ${{ github.event_name == 'release' }}
+        run: |
+          cd muse2
+          ${{ matrix.archive_cmd }} ../muse2_${{ matrix.osname }}.${{ matrix.archive_ext }} *
+      - name: Upload release artifacts
+        if: ${{ github.event_name == 'release' }}
+        uses: softprops/action-gh-release@v2
+        with:
+          files: muse2_${{ matrix.osname }}.${{ matrix.archive_ext }}

assets/readme/README.md

@@ -0,0 +1,3 @@
+# Readme files for MUSE 2.0
+
+This folder contains readme files to be included with MUSE 2.0 releases.

assets/readme/readme_linux.txt

@@ -0,0 +1,16 @@
+This folder contains the MUSE 2.0 executable for Linux, called `muse2`.
+
+The only pre-requisite is libstdc++.so, which is likely installed on your system already. If not,
+you can install with your package manager, e.g. for Ubuntu:
+
+    sudo apt install libstdc++6
+
+For more information on how to use MUSE 2.0, you can consult the program help:
+
+    ./muse2 help
+
+Documentation is also available on the web:
+    https://energysystemsmodellinglab.github.io/MUSE_2.0/
+
+Please report bugs on our GitHub issue tracker:
+    https://github.com/EnergySystemsModellingLab/MUSE_2.0/issues

assets/readme/readme_macos_arm.txt

@@ -0,0 +1,17 @@
+This folder contains the MUSE 2.0 executable for macOS (Apple Silicon), called `muse2`.
+
+When trying to run the `muse2` program, you may see an error message saying "muse2 can't be opened
+because Apple cannot check it for malicious software." To fix this, you should open `muse2` by
+right-clicking on it in your file explorer and clicking "Open". You will be prompted to give
+permission for the program to run. Once you have completed this step, you should be able to run the
+program as normal.
+
+For more information on how to use MUSE 2.0, you can consult the program help:
+
+    ./muse2 help
+
+Documentation is also available on the web:
+    https://energysystemsmodellinglab.github.io/MUSE_2.0/
+
+Please report bugs on our GitHub issue tracker:
+    https://github.com/EnergySystemsModellingLab/MUSE_2.0/issues

assets/readme/readme_windows.txt

@@ -0,0 +1,11 @@
+This folder contains the MUSE 2.0 executable for Windows, called `muse2`.
+
+For more information on how to use MUSE 2.0, you can consult the program help:
+
+    ./muse2 help
+
+Documentation is also available on the web:
+    https://energysystemsmodellinglab.github.io/MUSE_2.0/
+
+Please report bugs on our GitHub issue tracker:
+    https://github.com/EnergySystemsModellingLab/MUSE_2.0/issues

src/asset.rs

@@ -187,6 +187,18 @@ impl Hash for AssetRef {
     }
 }
 
+impl PartialOrd for AssetRef {
+    fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
+        Some(self.cmp(other))
+    }
+}
+
+impl Ord for AssetRef {
+    fn cmp(&self, other: &Self) -> std::cmp::Ordering {
+        self.id.unwrap().cmp(&other.id.unwrap())
+    }
+}
+
 /// A pool of [`Asset`]s
 pub struct AssetPool {
     /// The pool of active assets
@@ -295,6 +307,9 @@ impl AssetPool {
 
         self.active.clear();
         self.active.extend(new_pool);
+
+        // New pool may not have been sorted, but active needs to be sorted by ID
+        self.active.sort();
     }
 }
 
@@ -526,4 +541,33 @@ mod tests {
         assert_eq!(asset_pool.active[0].id, Some(AssetID(2)));
         assert_eq!(asset_pool.active[0].agent_id, "some_other_agent".into());
     }
+
+    #[rstest]
+    fn test_asset_pool_replace_active_pool_out_of_order(
+        mut asset_pool: AssetPool,
+        process: Process,
+    ) {
+        let new_asset = Asset::new(
+            "some_other_agent".into(),
+            process.into(),
+            "GBR".into(),
+            2.0,
+            2010,
+        )
+        .unwrap();
+
+        asset_pool.commission_new(2020);
+        assert_eq!(asset_pool.active.len(), 2);
+        let mut new_pool: Vec<Rc<Asset>> = asset_pool
+            .iter()
+            .map(|asset| asset.clone().into())
+            .collect();
+        new_pool.push(new_asset.into());
+        new_pool.reverse();
+
+        asset_pool.replace_active_pool(new_pool);
+        assert_equal(asset_pool.iter().map(|asset| asset.id.unwrap().0), 0..3);
+        assert_eq!(asset_pool.active[2].id, Some(AssetID(2)));
+        assert_eq!(asset_pool.active[2].agent_id, "some_other_agent".into());
+    }
 }