From 8b227f4b88deeb1b15d23b2c79542e7eaf8bc42a Mon Sep 17 00:00:00 2001 From: dav-sonn <62243276+dav-sonn@users.noreply.github.com> Date: Tue, 17 Mar 2026 14:08:29 +0000 Subject: [PATCH 1/2] Revert wrong automatic Commit d25b046 --- .github/workflows/deploy-docs.yml | 2 +- .gitignore | 2 -- .idea/.gitignore | 10 ------- .idea/copilot.data.migration.agent.xml | 6 ---- .idea/copilot.data.migration.ask2agent.xml | 6 ---- .idea/copilot.data.migration.edit.xml | 6 ---- README.md | 32 +++++++++++++++++++-- input/.DS_Store | Bin 8196 -> 0 bytes input/InitialPopulations/.DS_Store | Bin 8196 -> 0 bytes mkdocs.yml | 2 ++ requirements.txt | 3 -- src/.DS_Store | Bin 8196 -> 0 bytes src/main/.DS_Store | Bin 8196 -> 0 bytes src/main/java/.DS_Store | Bin 8196 -> 0 bytes 14 files changed, 33 insertions(+), 36 deletions(-) delete mode 100644 .idea/.gitignore delete mode 100644 .idea/copilot.data.migration.agent.xml delete mode 100644 .idea/copilot.data.migration.ask2agent.xml delete mode 100644 .idea/copilot.data.migration.edit.xml delete mode 100644 input/.DS_Store delete mode 100644 input/InitialPopulations/.DS_Store delete mode 100644 requirements.txt delete mode 100644 src/.DS_Store delete mode 100644 src/main/.DS_Store delete mode 100644 src/main/java/.DS_Store diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index af12673ff..66dce2744 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -5,7 +5,7 @@ on: branches: - main paths: - - 'docs/**' + - 'documentation/wiki/**' - 'mkdocs.yml' workflow_dispatch: diff --git a/.gitignore b/.gitignore index 0fc7540ea..a558e809f 100644 --- a/.gitignore +++ b/.gitignore @@ -246,5 +246,3 @@ input/EUROMODoutput/baseline/* # IntelliJ .idea/ -.DS_Store -**/.DS_Store diff --git a/.idea/.gitignore b/.idea/.gitignore deleted file mode 100644 index ab1f4164e..000000000 --- a/.idea/.gitignore +++ /dev/null @@ -1,10 +0,0 @@ -# Default ignored files -/shelf/ -/workspace.xml -# Ignored default folder with query files -/queries/ -# Datasource local storage ignored files -/dataSources/ -/dataSources.local.xml -# Editor-based HTTP Client requests -/httpRequests/ diff --git a/.idea/copilot.data.migration.agent.xml b/.idea/copilot.data.migration.agent.xml deleted file mode 100644 index 4ea72a911..000000000 --- a/.idea/copilot.data.migration.agent.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - - \ No newline at end of file diff --git a/.idea/copilot.data.migration.ask2agent.xml b/.idea/copilot.data.migration.ask2agent.xml deleted file mode 100644 index 1f2ea11e7..000000000 --- a/.idea/copilot.data.migration.ask2agent.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - - \ No newline at end of file diff --git a/.idea/copilot.data.migration.edit.xml b/.idea/copilot.data.migration.edit.xml deleted file mode 100644 index 8648f9401..000000000 --- a/.idea/copilot.data.migration.edit.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - - \ No newline at end of file diff --git a/README.md b/README.md index 853823b15..bf5c76ffe 100644 --- a/README.md +++ b/README.md @@ -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). @@ -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. ---> +--> \ No newline at end of file diff --git a/input/.DS_Store b/input/.DS_Store deleted file mode 100644 index b3a2ac00096e3dfec35823a6dca632962cfd239d..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 8196 zcmeHMYitx%6u#fI&>70eKzS69?dYO_R%|I0fdWe(N_myA+b2k!-5uzp)0w(6+bv*| z5)~6L#%MJD@J-?`gQC%x7`(iYzqXZSXq-y z_H*_~F6nRek?sdC* z`|Sb8Ju2KoctkLDg1g7A)mPgaY7)Mdq>H|OTl7_#Rz6+5Dc059vwM%)(`98`Cutot zd$k!Jx!g+KojG%eT^=v%Jib(lGiB%dOa zb8UO4>sfrDyURC+{o?H7hPrw@H|IA6EA(nw-ZOWZw172aHq$a*k1?DIq47kGh=X!s zMx}n+vgLL6tlxC+mL0p!X)|Y4sOsE#okNyqrERm@@G_>8wVeI!1uN_K_0UJ)_|`tl z%qhxDRHqzcz&uwmf5F0=7sX=2<_e}bOIJQ^J(#!r16o{`#Tv2rVnx>8*^{ML+wNxh zjM-o$7K<;H<=tH0lryOoYBg4U7XgfvN3jZDvv!4|XkMzH_KAS1^{Zt?%eLD_+O$K} zx&~5h?Hm&E43%>eveK1t2L{L)Pv~OJEwZeg-pd!>W_W(vpy`agQgf>;_jr9q&TK2t zE-fOq%X07;lb%CbvX<}Wf@rkGW3g^N)uwFL%#za!=P#&;rD7ej_7!0?%NeqW7xaM& zddRaUY)r(9ig@A<(Tso8FB(D66}la(*iyEZHL?!Y&qml0_8dFT-en)NGwdw8zJ^P9M!Y%(D|3NTMAb z=td8bz{EcE!9or`@+c4`4&z}wf+KhgPvR*e#4~snFX0uuisN`4Cx{j&@fMNd6h6R* zIE^zni_h@|(c=gFj9+m%{9?++HvEnW8=e#4nl}7UGUwQ?v!CpXUY*(t-1G@YIY=;4LijS3k+s0vO!l0iC7a_kR7 nYU^amF^N!)3P~C&|N0LBH`=%I=>CuH|L`yK2`TqKdjJ0cN&&eH diff --git a/input/InitialPopulations/.DS_Store b/input/InitialPopulations/.DS_Store deleted file mode 100644 index 499b98c7e2220774f6e51b0d1dcc1238821e099c..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 8196 zcmeHMZEO@p7@lWa=q_btp?nmO>*}F^R%|I0fg(pgl=4-=T|YtU-rdq}y4|g}d%XfS zDN!*2V~j@Q55GzLWl%I46N4X#8Uj%hLyVv?CjKyn_{WHU_~Sb}dqrCM4-LefWagcD zXWp54pL?H~n>)rB8uQs&#wr=f%_&|F2u%?_F(AyTU+2R~CPFzTq%da?<_zJ=2wx}&Rwp|> z7|xIoGAbhkA_OKQ!0971pXHblyxqs&?`hjjQ{RW_A=~o&nwsw*m6T4KUM82xU921F4$Ca`YIB=h$2Tm;%moHk)}$eOJ1r;c78>2Wll21I zr09?pS?Sd(4;@;)rlwl2TU$R`tsh#qit4ND>PJTvd0zb94ZC{>>_NvpDqKN$958i) zYsaqTm+cKV3BO9xMZbP1`lZY$pQ+vw>+0^=vsdluvNEodv<{lR+ANRUYo+F{oHUKj?V9+U$&BXY#h;o11N$4<_9lKBR5Pw_L~TFmoPBK1C+y+V(Ejvv@~$mv4^v z#o4dw>gw^_oZl3z(5q>A&)jX&0@kqEOv`vZ#z-nOjVEe^&&r8emHHhkR@U9Oaq|OP zckVu?&7M=Cs`D3g4qKj;w#{zC%a~5qa{Af}R@U$DA-Emi+HaXTMVXE2lw%B<=PDL1 zT72u0SWJw$VpE)@E1$L=$y@#bEiTJqjaYoCB5UvO&C=F(xLH19Ht31P;>%@u57#&4 zOe%$1jaA=621d#wtio;9u2K}uOASy=2vfCwt*mI-cH2mscBtCWK&ow>!vfDxIX@vQ zT^V<9keu;^F4o*4%i8IEeBtee=eG@+&iIy^TV=V&>o;;{TY)07Xt6_yWi?$wsrBVT(9GAE=;$JaXThAI<2OD6c>f;3VjH?(AdL)MjNkwc;!zyNQ5?flcpA^)CA^GR@EYF4+js{j@g6?H z=lB9&;v0OA^SFQ?aS?yw68@4P&5+8anNmzzCe=!-q&lfV+9++35>ir1Nv7mT1!+ur zLiiyS8Mv?LYp6d$a?;5{3>*>+luk{-Kz&Q=)@|F>tv3?`&(GqVn>%m*g38bZt7ZNHnYUmAWPoc}25UuT!-WqNWnq*6S-(4YFvgR~uBVlt?O?o75^* zV~S`r=`Fg(DJNh5;QxvJ%6?~;01EyJRALFLu?8E^LcyLyJ37#f9twC9`_T^zIrzw< zK;eHFkKu6~!IO9f&r- Copyright © Matteo Richiardi, Patryk Bronka, Justin van de Ven — Centre for Microsimulation and Policy Analysis diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index 859460728..000000000 --- a/requirements.txt +++ /dev/null @@ -1,3 +0,0 @@ -mkdocs>=1.6,<2.0 -mkdocs-material>=9.5,<10.0 -mkdocs-git-revision-date-localized>=1.2.0 diff --git a/src/.DS_Store b/src/.DS_Store deleted file mode 100644 index 55740b95b2afd6e56456607bd39ef580068ae3ac..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 8196 zcmeHMZEO@p7@lWa=q_btp?nmO>*}F^R%|I0fg(pgl=4-=_47dL-rYhs-R{=gy}JT7 zDN!*2V~j@Q55GzLWl%I46N4X#8Uj%hLyVv?CjKyn_{WHU_~Sb}dj*R9p)p2uCz*L? z-kEo1-}jzpW@nEvhUR>>p0R4im`s^Vt&)mANW7otYmyXd%1MIkS-R*Ar)@V)?RT#k z9Vwy+L=lK05Je!0Koo(0Lj>r|=1HF9+!wu38ATw9!2dD=e1Fg>bD0R`n2^ENK}B!{ zAjz))L87|GDBYa_tvQ_hB%!7S!nd4Eq2+m`3o)qMr2tbEGU3b{hAl^5rMi*sw#;I`HoL`je8Y0gTwq{jO&YSh$8xf6vDwW#Sue0niVj(k zm42=I;K7xv>T30d)s3UI`oT3TsJ^nHadcFX=fv+^x3hoH9&+3x!Ucre08=Npbo5Gp zY_HHFzDJa$Oa6RQ@<*9gIbFRW*4vlbwOdW~S{c_#S_jO2ZH7l~wNrCP&Mc5SJsH=| z4>?}HHZx<`nY?ZI=0@A*gGo1w59t{8E!Xk7&74P)Pm#&Fw!OpkEZ))A>zgBfY4)qS zdQ+a8^IL)y`ZX=@nLABdz$%!nw2YTBMmj^&c%n}DsvMtDt>3b2dBa`nH{P>(`_8l4 z%vn{cI(J@A!SbxMZT1;n#&oilv#+aYW&ME^h1v0~y_T6%l$ogQbc`YMY}Nb)3vXN$ zi-|FpZA!EB=F`>#dCT9g#bsHn5sNQYWbN(US$ec>ZkErO4SHg+_)=Nk#q}*YlS-jh zW3_jXfzjzvtis2vU!f?P*EvX75T7Na&AIadNc0O z5IN%sU97cDmbFuR_`+Ka&+iyEo$*I%ZI|VgH(=z*G^x%x29jIlXZHf~r_&tXtN;Bpc0g3Kn6Xeo#RHdG-YGAzo6%6Ss+K{KG*} z34*TBDObamvbC(4b+bV>$_}$<*)jGG`-q)pXV`i61G~U3vP+nX3dpF0hWV($GSp)& zny?;s<6dk+JGP(~2GYpD#R&G}03O649KlgMhR5*~p2PEa0WaZIypA_;0&n3xe2h=< zDZaqhIEVB278md+N-`*4*7Z zjz|IE5@xUDLID4(NE5(6K*U7o2BcJL^e*CuIdYkmf~6&HY89Nv@>xFmW_7WyO(6z} z<`Q+8u1zKOh-R(6T-PKbt!UQk4XRc~lvD!SMt!-eK^Bd*YLlv!6FEh5gIc3%Oc9M1 zy-n9R)#Se)^xv@`+0X1EK%lQeH5Q>3tFR7j1o9-h(2YK%2*}F^R%|I0fdWTAl=4-=^}9&jyIbhm?QXr@yDMOm z5)~6L#%MJD@SDV621TPWG5C?FArLh�VN=;tykpe~kEtKfbfGSD@G*8e>Fvl9_kr zoq1>WeeZc@cJ>%!Xv}458LMQB$&|U&%BlE+#QS-^CP|^DlqATWr3&6~%63!Ke)pQu zks^vf6oDuLQ3Rq0L=pHmM1an0p5#f+ebF10Q3Rq0{4XQG_XnLamx)l02^nl1R0LN5 zlKct~B&ut?LQ)T9B9vo7QV%5vQ@7r8yHv_lZNc>vYd=tXmoQ<#tUqdqC-|> zrC+N&cyQ&anrgjnb^U0yesIkSs;{i8A01WXIq^H!?dl)2haC5aZ~@^qz|;vY9lg>Y z+sikJ?-3=bqCejh{ZXcsPgiebCYfJ!K9nThqMj*mg{((X4WIgr$}dA+urGV7Vqfk_RSH$IQvyy z-MyZh^_zkf`ZX=*nY&C{z{;D=w2aqljI@WQ@kEXARXIMRQom){^18d$Z@PQSj$LQ9 znX@WXb?&^byyaOb+w3vCwCQ9lXJ1Fb%J>7l6lTY__F86EQD&mL-7$vDvla6fEWB}1 zEGEWWwkgiiol98{$3IENiFs@P)S-p5HcXI^&Pj+$zhx-hh!c+X{rlqQ!Pu4t`_ObCZ^g<-6G+ z8g21dtcOpvDU&fXvDPuwP|@ec<@ zB?!7gr(6|V%GR<**2xChC_BuaWyjb%>?3xXonhzM59|WF$Sz?j${?d08s?)4%TSB8 zXux`Gz&+TER%}H#45W~TixKR{0X&F9ID(^i43Fa}JcsA;0$#$acpY!x1m41X_!yty zQ+$E1aSrG4EiT|!T*Pk@q-j#QG+l~GOQc$9g;XasNb9AIQbI~f?UE@uQb8J%9ua;> zMds}(`WosFlN{ekhOIdYkmf~7@nYGs_q@>xFmW_7WyO(6z} z<`Q+8u1zKOh-S6ET-PKbt!UQjb*ffElvD!SdVRU7K^Bd*YJ;kk5;;Y4qgthEOc9MH zy+zkJ)#Se)^xv@`+0X1EK%lQcB^IF?tFR6&1o9+0(1{-O63|WT#Q-d1;Uk9v!Tt~) z!oxU>NAU!nB+x&NXYe9k#w$36*KnMme*$k3@K54>e1KCpjWhTRpA!YX$4~eLm%^7w zHV*0?6F|+uJ`U=9GV9o`vyXH|5?np}I%}1P=dI-T|CY(W|6gZbMUNXrAd0}Bi2zEQ zlg*7}G1;!hw@IDyeUy3P*}F^R%|I0fdWTAl=4-=T|YtU-rYhs-R{=gyw=A{eX;DphU zBJx1wfye`q2Oj5DY;S&P_PW?I`PBIb7Q6UAKLBJWpl@Y#B5Ufr( zJs8fA5Hczw4@4fA=mAb2nR(1&18nf>_j}rQ)71A-deF8!zozDUNF}9Hrk2TNa=H9) zvd=9feZ$XtjYe)aZ>3z?XH%9=D}Pp9Q%-9n?Acd}l9 zO^Oa#k(FMp^3b7`t7@wCy4Cd~)%u||E2zG*u6|@hk>|wkU$?8b-yU$>qrwz~#{pBv znRe`YcG=!gld!8KU9{`RqFu_g^6Bbrv99i(-FwuYE-T|YN$a55tIhDpyjE)N%$Y-E zR%gbw^8=38tIf<9b|!BdzPZV^`C!t`;zQa7eam&c4m0PG&G}8i3cZ?^_sm@;Enp3q&9scyV+^N4XgpCPY*tRpsMPOTw!H3v^_w2t zvSZgdZRV^BRh>JpbI9_nv~6}9UdD8?mb1UTU}gQj9&)$iTl*|CrzkT~opOu;^IXOJ z1q*Lq6pM*5S1`p{y7Fo3(Y)m!(BiTz)`-OyE3)>%o-A!`yPM@RW`mwsEWT8hcXNGH z&ZJVP)mZg?1Taz_`6}FI?FvQFyi`BMgn+8`t7S#Yw%bP9v_sXp22yS991{Kvm2(ra z(v@)s2FMss=wi(+vaFrn%NO2ecz)ZU>5OfuxmA{XygnmmwiPHMi-_&A9DK&4=a81H z<-57S8*TAetea1@DVsI3Wc0%M3o2r%Scj~AM;Og=hAiR$eV~F0^6YUzh}fI#@p&VMo|Y>^S?7ea_CXv+M% z8EUZ>4Oov2cnF)(imm8^fiyC3F^mH^h{tdkM{x{K;~6}Um+=Z-#p`$r@8DgW#QXRd zU*Jo8g>Uf#&f@}p!bSXrOZZ!YG)*d(rb{ttiBv1Ckm{rcX}z>jN=Qj5C7F^V6{Jz= zNnwXnWZ>SSt)c!1$q6S5F>p{YP&zdU1NF_VTefafx7&jc}25UuT!-WqNWmH>-FWT23a)Lstu}EN+cD{jcS#u zF-0_*^cG#?l#_3K@c+zyV}Gzq00n;qDzOOFScP?Hp9bdZ{STF$J;nT6gY|ZhybVX2|mSXoWWUqjc+o Date: Tue, 17 Mar 2026 14:42:45 +0000 Subject: [PATCH 2/2] Small corrections in some documentation files --- README.md | 139 +----------------- .../internals/multirun-implementation.md | 137 +++++++++++++++++ 2 files changed, 139 insertions(+), 137 deletions(-) diff --git a/README.md b/README.md index bf5c76ffe..7bf11d49e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # SimPaths -by Matteo Richiardi, Patryk Bronka, Justin van de Ven +by CeMPA (Centre for Microsimulation and Policy Analysis). ## What is SimPaths and how to use it? @@ -8,139 +8,4 @@ SimPaths is an open-source framework for modelling individual and household life 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 [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). - - - - - \ No newline at end of file +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. \ No newline at end of file diff --git a/documentation/wiki/developer-guide/internals/multirun-implementation.md b/documentation/wiki/developer-guide/internals/multirun-implementation.md index ab2f03dfd..ee798acbd 100644 --- a/documentation/wiki/developer-guide/internals/multirun-implementation.md +++ b/documentation/wiki/developer-guide/internals/multirun-implementation.md @@ -3,3 +3,140 @@ !!! warning "In progress" This page is under development. Contributions welcome — see the [Developer Guide](../index.md) for how to contribute. + +## Running the MultiRun in the command line + +### Prerequisites + +- Java 19 +- Maven 3.8+ +- Optional IDE: IntelliJ IDEA (import as a Maven project) + +### Build and run + +In the command line, navigate to the project directory and run the following commands: + +```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). + + + + + \ No newline at end of file