docs

main.jl

@@ -1,3 +1,8 @@
+"""
+Main program, non-gui version.
+"""
+
+
 # library
 using Random
 
@@ -7,6 +12,7 @@ include("mainHelpers.jl")
 # create parameters
 const simPars, pars = loadParameters(ARGS)
 
+# logging and analysis
 include(simPars.analysisFile)
 
 Random.seed!(simPars.seed)

mainHelpers.jl

@@ -1,5 +1,12 @@
+"""
+Some common infrastructure for setting up and running the model.
+"""
+
+
+
 include("lib/loadLibsPath.jl")
 
+# add various directories to Julia's model search path
 addToLoadPath!(String(@__DIR__) * "/.", 
                String(@__DIR__) * "/lib",
                String(@__DIR__) * "/src",
@@ -14,14 +21,14 @@ using Utilities
 
 using DemographyPars
 using DemographyModel
-#using DemographyModelEO
 
 
 include("src/demography/data.jl")
 
 include("src/handleParams.jl")
 
 
+"Generate and return a usable model object."
 function setupModel(pars)
     datp = pars.datapars
     dir = datp.datadir
@@ -44,6 +51,7 @@ function setupModel(pars)
 end
 
 
+"Prepare and return output file or nothing."
 function setupLogging(simPars; FS = "\t")
     if simPars.logfile == ""
         return nothing
@@ -57,6 +65,7 @@ function setupLogging(simPars; FS = "\t")
 end
 
 
+"Run fully initialised model non-interactively from start to finish."
 function runModel!(model, simPars, pars, logfile = nothing; FS = "\t")
     curTime = pars.poppars.startTime
 

src/simulate/Age.jl

@@ -9,12 +9,15 @@ export selectAgeTransition, ageTransition!
 export ChangeAge1Yr
 
 
+# transition filter
 selectAgeTransition(person, pars) = true
 
 
+# event tag
 struct ChangeAge1Yr end
 
 
+"Change a person's age. Emits the `ChangeAge1Yr` signal if the new age is an integer."
 function changeAge!(person, newAge, model, pars)
     person.age = newAge
 
@@ -42,6 +45,7 @@ function ageTransition!(person, time, model, pars)
 
     changeAge!(person, person.age + 1//12, model, pars)
 
+    # count relationship time
     if !isSingle(person)
         person.pTime += 1//12
     end

src/simulate/Benefits.jl

@@ -1,3 +1,7 @@
+"Implements the UK benefits system."
+
+
+
 module Benefits
 
 
@@ -9,7 +13,7 @@ using BasicInfoAM, KinshipAM, WorkAM, DependenciesAM, DemoPerson
 export computeBenefits!
 
 
-# Debugg benefit allocation process
+# Debug benefit allocation process
 function computeBenefits!(pop, pars)
 
     # Reset counters

src/simulate/kinship.jl

@@ -4,6 +4,7 @@ struct Link{T}
 end
 
 
+"Generate a kinship network for a household."
 function kinshipNetwork(filter, house, model, pars)
     LinkT = Link{typeof(house)}
     conns = Vector{LinkT}()