Update main for the new release

.github/workflows/SimPathsBuild.yml

@@ -14,52 +14,107 @@ on:
 
 jobs:
   build:
-
     runs-on: [ ubuntu-latest ]
-
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up JDK 19
-      uses: actions/setup-java@v3
+      uses: actions/setup-java@v4
       with:
         java-version: '19'
         distribution: 'temurin'
         cache: maven
     - name: Build with Maven
       run: mvn -B package --file pom.xml
-
-    - uses: actions/upload-artifact@v3
+    - uses: actions/upload-artifact@v4
       with:
         name: simpaths_jars
         path: ./*.jar
 
-  run-simpaths:
-    needs: build
-
+  run-integration-tests:
     runs-on: [ ubuntu-latest ]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up JDK 19
+      uses: actions/setup-java@v4
+      with:
+        java-version: '19'
+        distribution: 'temurin'
+        cache: maven
+    - name: Run integration tests
+      run: mvn verify
+    - name: Upload Actual CSVs for Inspection
+      if: failure()  # This ensures it only runs when the tests fail
+      uses: actions/upload-artifact@v4
+      with:
+        name: actual-simulation-results
+        path: output/INTEGRATION_TESTS/csv/
 
+  run-simpaths-start:
+    needs: build
+    runs-on: [ ubuntu-latest ]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up JDK 19
+        uses: actions/setup-java@v4
+        with:
+          java-version: '19'
+          distribution: 'temurin'
+      - uses: actions/download-artifact@v4
+        with:
+          name: simpaths_jars
+          path: .
+      - name: Do one full Setup and Run with SimPathsStart (mimicking GUI run)
+        run: java -jar singlerun.jar -c UK -s 2019 -g false --rewrite-policy-schedule
+      - name: Check input db exists
+        id: check_file
+        uses: thebinaryfelix/check-file-existence-action@1.0.0
+        with:
+          files: 'input/input.mv.db, input/EUROMODpolicySchedule.xlsx, input/DatabaseCountryYear.xlsx'
 
+  run-simpaths-persist-root:
+    needs: build
+    runs-on: [ ubuntu-latest ]
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up JDK 19
-      uses: actions/setup-java@v3
+      uses: actions/setup-java@v4
       with:
         java-version: '19'
         distribution: 'temurin'
-
-    - uses: actions/download-artifact@v3
+    - uses: actions/download-artifact@v4
       with:
         name: simpaths_jars
         path: .
-
     - name: Setup run
-      run: java -jar singlerun.jar -c UK -s 2017 -Setup -g false --rewrite-policy-schedule
-
+      run: java -jar multirun.jar -DBSetup -config test_create_database.yml
     - name: Check input db exists
       id: check_file
       uses: thebinaryfelix/check-file-existence-action@1.0.0
       with:
         files: 'input/input.mv.db, input/EUROMODpolicySchedule.xlsx, input/DatabaseCountryYear.xlsx'
+    - name: Do two runs with persistence to root database
+      run: java -jar multirun.jar -config test_run.yml --persist=root
 
-    - name: Do one run
-      run: java -jar multirun.jar -p 20000 -s 2019 -e 2022 -r 100 -n 2 -g false
+  run-simpaths-no-persist:
+    needs: build
+    runs-on: [ ubuntu-latest ]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up JDK 19
+      uses: actions/setup-java@v4
+      with:
+        java-version: '19'
+        distribution: 'temurin'
+    - uses: actions/download-artifact@v4
+      with:
+        name: simpaths_jars
+        path: .
+    - name: Setup run
+      run: java -jar multirun.jar -DBSetup -config test_create_database.yml
+    - name: Check input db exists
+      id: check_file
+      uses: thebinaryfelix/check-file-existence-action@1.0.0
+      with:
+        files: 'input/input.mv.db, input/EUROMODpolicySchedule.xlsx, input/DatabaseCountryYear.xlsx'
+    - name: Do two runs with no persistence
+      run: java -jar multirun.jar -config test_run.yml --persist=none

.github/workflows/publish-javadoc.yml

@@ -0,0 +1,42 @@
+name: Publish Javadoc
+
+on:
+  push:
+    branches:
+      - develop  # Only publish when pushing to develop branch
+  pull_request:
+    branches: [ "main", "develop" ]
+
+jobs:
+  publish-javadoc:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write  # Needed to push to the javadoc branch
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up JDK 19
+        uses: actions/setup-java@v3
+        with:
+          java-version: '19'
+          distribution: 'temurin'
+          cache: maven
+
+      - name: Build (optional if Javadoc needs compiled sources)
+        run: mvn -B compile --file pom.xml
+
+      - name: Generate Javadoc
+        run: mvn javadoc:javadoc --file pom.xml
+
+      - name: Deploy Javadoc to branch
+        if: github.event.push
+        uses: MathieuSoysal/Javadoc-publisher.yml@v3.0.2
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          javadoc-branch: javadoc
+          java-version: 19
+          target-folder: javadoc
+          project: maven
+

.gitignore

@@ -227,112 +227,22 @@ analysis/test_base_noalign.dta
 analysis/test_naive_noalign.dta
 analysis/test1.dta
 analysis/test2.dta
-input/InitialPopulations/base/population_initial_UK_2010.csv
-input/InitialPopulations/base/population_initial_UK_2011.csv
-input/InitialPopulations/base/population_initial_UK_2012.csv
-input/InitialPopulations/base/population_initial_UK_2013.csv
-input/InitialPopulations/base/population_initial_UK_2014.csv
-input/InitialPopulations/base/population_initial_UK_2015.csv
-input/InitialPopulations/base/population_initial_UK_2016.csv
-input/InitialPopulations/base/population_initial_UK_2017.csv
-input/InitialPopulations/base/population_initial_UK_2018.csv
-input/InitialPopulations/base/population_initial_UK_2019.csv
-input/InitialPopulations/base/population_initial_UK_2020.csv
-input/InitialPopulations/base/population_initial_UK_2021.csv
 .idea/dataSources.xml
-input/EUROMODoutput/expanded/uk_2011_std.txt
-input/EUROMODoutput/expanded/uk_2012_std.txt
-input/EUROMODoutput/expanded/uk_2013_std.txt
-input/EUROMODoutput/expanded/uk_2014_std.txt
-input/EUROMODoutput/expanded/uk_2015_std.txt
-input/EUROMODoutput/expanded/uk_2016_std.txt
-input/EUROMODoutput/expanded/uk_2017_std.txt
-input/EUROMODoutput/expanded/uk_2018_std.txt
-input/EUROMODoutput/expanded/uk_2019_std.txt
-input/EUROMODoutput/expanded/uk_2020_std.txt
-input/EUROMODoutput/expanded/uk_2021_std.txt
-input/EUROMODoutput/expanded/uk_2022_std.txt
-input/EUROMODoutput/expanded/uk_2023_std.txt
-input/EUROMODoutput/expanded/uk_2024_std.txt
-input/EUROMODoutput/expanded/uk_2025_std.txt
-input/EUROMODoutput/expanded/uk_2026_std.txt
-input/EUROMODoutput/expanded/uk_2027_std.txt
-input/EUROMODoutput/initial/uk_2011_std.txt
-input/EUROMODoutput/initial/uk_2012_std.txt
-input/EUROMODoutput/initial/uk_2013_std.txt
-input/EUROMODoutput/initial/uk_2014_std.txt
-input/EUROMODoutput/initial/uk_2015_std.txt
-input/EUROMODoutput/initial/uk_2016_std.txt
-input/EUROMODoutput/initial/uk_2017_std.txt
-input/EUROMODoutput/initial/uk_2018_std.txt
-input/EUROMODoutput/initial/uk_2019_std.txt
-input/EUROMODoutput/initial/uk_2020_std.txt
-input/EUROMODoutput/initial/uk_2021_std.txt
-input/EUROMODoutput/initial/uk_2022_std.txt
-input/EUROMODoutput/initial/uk_2023_std.txt
-input/EUROMODoutput/initial/uk_2024_std.txt
-input/EUROMODoutput/initial/uk_2025_std.txt
-input/EUROMODoutput/initial/uk_2026_std.txt
-input/EUROMODoutput/initial/uk_2027_std.txt
-input/EUROMODoutput/testing/uk_2015_std.txt
-input/EUROMODoutput/testing/uk_2019_std.txt
-input/InitialPopulations/current/population_initial_UK_2011.csv
-input/InitialPopulations/current/population_initial_UK_2012.csv
-input/InitialPopulations/current/population_initial_UK_2013.csv
-input/InitialPopulations/current/population_initial_UK_2014.csv
-input/InitialPopulations/current/population_initial_UK_2015.csv
-input/InitialPopulations/current/population_initial_UK_2016.csv
-input/InitialPopulations/current/population_initial_UK_2017.csv
-input/InitialPopulations/current/population_initial_UK_2018.csv
-input/InitialPopulations/current/population_initial_UK_2019.csv
-input/InitialPopulations/current/population_initial_UK_2020.csv
-input/InitialPopulations/current/population_initial_UK_2021.csv
-input/InitialPopulations/testing/population_initial_UK_2019.csv
-input/EUROMODoutput/testing/uk_2015_std.txt
-input/EUROMODoutput/testing/uk_2019_std.txt
-input/EUROMODoutput/extended/uk_2015_std.txt
-input/EUROMODoutput/extended/uk_2019_std.txt
-input/EUROMODoutput/extended/uk_2020_std.txt
-input/EUROMODoutput/extended/uk_2021_std.txt
-input/EUROMODoutput/extended/uk_2022_std.txt
-input/EUROMODoutput/extended/uk_2023_std.txt
-input/EUROMODoutput/extended/uk_2024_std.txt
-input/EUROMODoutput/extended/uk_2025_std.txt
-input/EUROMODoutput/testing/DatabaseCountryYear.xlsx
-input/EUROMODoutput/testing/EUROMODpolicySchedule.xlsx
-input/EUROMODoutput/sc expanded/uk_2011_std.txt
-input/EUROMODoutput/sc expanded/uk_2012_std.txt
-input/EUROMODoutput/sc expanded/uk_2013_std.txt
-input/EUROMODoutput/sc expanded/uk_2014_std.txt
-input/EUROMODoutput/sc expanded/uk_2015_std.txt
-input/EUROMODoutput/sc expanded/uk_2016_std.txt
-input/EUROMODoutput/sc expanded/uk_2017_std.txt
-input/EUROMODoutput/sc expanded/uk_2018_std.txt
-input/EUROMODoutput/sc expanded/uk_2019_std.txt
-input/EUROMODoutput/sc expanded/uk_2020_std.txt
-input/EUROMODoutput/sc expanded/uk_2021_std.txt
-input/EUROMODoutput/sc expanded/uk_2022_std.txt
-input/EUROMODoutput/sc expanded/uk_2023_std.txt
-input/EUROMODoutput/sc expanded/uk_2024_std.txt
-input/EUROMODoutput/sc expanded/uk_2025_std.txt
-input/EUROMODoutput/sc expanded/uk_2026_std.txt
-input/EUROMODoutput/sc expanded/uk_2027_std.txt
-input/EUROMODoutput/current/DatabaseCountryYear.xlsx
-input/EUROMODoutput/current/EUROMODpolicySchedule.xlsx
-input/EUROMODoutput/current/uk_2011_std.txt
-input/EUROMODoutput/current/uk_2012_std.txt
-input/EUROMODoutput/current/uk_2013_std.txt
-input/EUROMODoutput/current/uk_2014_std.txt
-input/EUROMODoutput/current/uk_2015_std.txt
-input/EUROMODoutput/current/uk_2016_std.txt
-input/EUROMODoutput/current/uk_2017_std.txt
-input/EUROMODoutput/current/uk_2018_std.txt
-input/EUROMODoutput/current/uk_2019_std.txt
-input/EUROMODoutput/current/uk_2020_std.txt
-input/EUROMODoutput/current/uk_2021_std.txt
-input/EUROMODoutput/current/uk_2022_std.txt
-input/EUROMODoutput/current/uk_2023_std.txt
-input/EUROMODoutput/current/uk_2024_std.txt
-input/EUROMODoutput/current/uk_2025_std.txt
-input/EUROMODoutput/current/uk_2026_std.txt
-input/EUROMODoutput/current/uk_2027_std.txt
+.idea/*
+*.dta
+src/main/java/simpaths/data/startingpop/DataParser.new
+src/main/java/simpaths/data/startingpop/DataParser.old
+input/EUROMODoutput/limit/*
+input/InitialPopulations/limit/*
+input/InitialPopulations/baseline/*
+input/EUROMODoutput/baseline/*
+.Rproj.user
+/input/EUROMODoutput/test
+/input/InitialPopulations/test
+
+# macOS
+.DS_Store
+**/.DS_Store
+
+# IntelliJ
+.idea/

README.md

@@ -2,10 +2,18 @@
 
 by Matteo Richiardi, Patryk Bronka, Justin van de Ven
 
-## Introduction
+## What is SimPaths and how to use it?
 
-SimPaths is a family of models for individual and household life course events, all sharing common components. The framework is designed to project life histories through time, building up a detailed picture of career paths, family (inter)relations, health, and financial circumstances. The framework builds upon standardised assumptions and data sources, which facilitates adaptation to alternative countries – versions currently exist for the UK and Italy. Careful attention is paid to model validation, and sensitivity of projections to key assumptions. The modular nature of the SimPaths framework is designed to facilitate analysis of alternative assumptions concerning the tax and benefit system, sensitivity to parameter estimates and alternative approaches for projecting labour/leisure and consumption/savings decisions. Projections for a workhorse model parameterised to the UK context are reported in [Bronka, P. et al. (2023). *SimPaths: an open-source microsimulation model for life course analysis* (No. CEMPA6/23), Centre for Microsimulation and Policy Analysis at the Institute for Social and Economic Research*](https://www.microsimulation.ac.uk/publications/publication-557738/), which closely reflect observed data throughout a 10-year validation window.
+SimPaths is an open-source framework for modelling individual and household life course events across multiple domains. The framework projects life histories over time, developing detailed representations of career paths, family and intergenerational relationships, health, and financial circumstances. As a family of models, SimPaths offers a dynamic simulation of how life events evolve and interact within populations.
 
+SimPaths models currently exist for the UK, Greece, Hungary, Italy, and Poland. This page refers to the UK model; the other European models are available at the corresponding [SimPathsEU](https://github.com/centreformicrosimulation/SimPathsEU) page. 
+
+The entire SimPaths documentation is available on its [WikiPage](https://github.com/centreformicrosimulation/SimPaths/wiki), which includes: a detailed description of its building blocks; instructions on how to set up and run the model; information about contributing to the model's development.
+
+<!-- Projections for a workhorse model parameterised to the UK context are reported in [Bronka, P. et al. (2023). *SimPaths: an open-source microsimulation model for life course analysis* (No. CEMPA6/23), Centre for Microsimulation and Policy Analysis at the Institute for Social and Economic Research*](https://www.microsimulation.ac.uk/publications/publication-557738/), which closely reflect observed data throughout a 10-year validation window. -->
+
+
+<!--
 ## Getting Started
 
 To contribute to this project, you need to fork the repository and set up your development environment.
@@ -56,7 +64,7 @@ To run the SimPathsStart setup phases and set up a population for subsequent mul
 - `-c` Country ['UK' or 'IT']
 - `-s` Start year
 - `-g` [true/false] show/hide gui
-- `-r` Re-write policy schedule from detected policy files
+- `--rewrite-policy-schedule` Re-write policy schedule from detected policy files
 - `-Setup` do setup phases (creating input populations database) only
 
 e.g.
@@ -109,3 +117,4 @@ In our open-source project, we follow a clear and consistent branch naming conve
     - `docs/documentation-topic`: Prefix documentation branches with `docs` for updating or creating documentation. For example, `docs/update-readme`.
 
 These branch naming conventions are designed to make it easy for our contributors to understand the purpose of each branch and maintain consistency within our repository. Please adhere to these conventions when creating branches for your contributions.
+-->