Revert wrong automatic Commit d25b046

Author: dav-sonn

.github/workflows/deploy-docs.yml

@@ -5,7 +5,7 @@ on:
     branches:
       - main
     paths:
-      - 'docs/**'
+      - 'documentation/wiki/**'
       - 'mkdocs.yml'
   workflow_dispatch:
 

.gitignore

@@ -246,5 +246,3 @@ input/EUROMODoutput/baseline/*
 
 # IntelliJ
 .idea/
-.DS_Store
-**/.DS_Store

.idea/.gitignore

@@ -1,12 +1,40 @@
 # SimPaths
 
+by Matteo Richiardi, Patryk Bronka, Justin van de Ven
+
 ## What is SimPaths and how to use it?
 
 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. For the web based version [click here](https://centreformicrosimulation.github.io/SimPaths/)
+The entire SimPaths documentation is available on its [website](https://centreformicrosimulation.github.io/SimPaths/), 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.
+
+## Quick start
+
+### Prerequisites
+
+- Java 19
+- Maven 3.8+
+- Optional IDE: IntelliJ IDEA (import as a Maven project)
+
+### Build and run
+
+```bash
+mvn clean package
+java -jar multirun.jar -DBSetup
+java -jar multirun.jar
+```
+
+The first command builds the JARs. The second creates the H2 donor database from the input data. The third runs the simulation using `default.yml`.
+
+To use a different config file:
+
+```bash
+java -jar multirun.jar -config my_run.yml
+```
+
+For configuration options, see the annotated `config/default.yml`. For the data pipeline and further reference, see [`documentation/`](documentation/README.md).
 
 <!-- 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. -->
 
@@ -115,4 +143,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.
--->
+-->

.idea/copilot.data.migration.agent.xml

@@ -6,6 +6,8 @@ site_url: https://centreformicrosimulation.github.io/SimPaths/
 repo_url: https://github.com/centreformicrosimulation/SimPaths
 repo_name: centreformicrosimulation/SimPaths
 
+docs_dir: documentation/wiki
+
 copyright: >-
   Copyright © Matteo Richiardi, Patryk Bronka, Justin van de Ven —
   Centre for Microsimulation and Policy Analysis