Updates for 2024 US Data

.github/workflows/CI.yml

@@ -25,7 +25,7 @@ jobs:
         version:
           - '1.10'
           - '1.11'
-          - 'nightly'
+          - '1.12'
         os:
           - ubuntu-latest
           - windows-latest

.gitignore

@@ -30,3 +30,8 @@ JuliaLocalPreferences.toml
 main.jl
 settings.json
 .vscode/settings.json
+
+*.aux
+*.log
+summary_local.yaml
+australia.yaml

Project.toml

@@ -17,14 +17,14 @@ ZipFile = "a5390f91-8eb1-5f08-bee0-b1d1ffed6cea"
 
 [compat]
 CSV = "0.10.15"
-DataFrames = "1.7.0"
-DataStructures = "0.18.22, 0.19"
+DataFrames = "1.8.1"
+DataStructures = "0.19"
 Downloads = "1.6.0"
-JuMP = "1.28.0"
-MPSGE = "0.6.1"
+JuMP = "1.29"
+MPSGE = "0.6.4"
 WiNDCContainer = "0.3.0"
 XLSX = "0.10.4"
-YAML = "0.4.14"
+YAML = "0.4"
 ZipFile = "0.10.1"
 julia = "1.10"
 

README.md

@@ -35,7 +35,7 @@ x -> sort(x, :diff)
 
 
 
-M = national_mpsge(Y; year = 2023)
+M = national_mpsge(Y) # add keyword year = 2023 to solve for a specific year
 MPSGE.solve!(M; cumulative_iteration_limit=0) # Solve at benchmark
 
 MPSGE.set_value!.(M[:Absorption_Tax], 0) # Set some taxes to 0

docs/assets/custom.css

@@ -0,0 +1,3 @@
+img {
+    width: 75%;
+}

docs/make.jl

@@ -1,23 +1,38 @@
 using Documenter, WiNDCNational, Literate
 
+# Copy YAML Files to docs
+cp(joinpath(@__DIR__, "..", "src", "united_states", "summary.yaml"), # Source
+   joinpath(@__DIR__, "src", "data", "united_states", "summary.yaml"); # `Dest 
+   force = true)
 
+cp(joinpath(@__DIR__, "..", "src", "united_states", "detailed.yaml"), # Source
+   joinpath(@__DIR__, "src", "data", "united_states", "detailed.yaml"); # `Dest 
+   force = true)
 
 const _PAGES = [
     "Introduction" => ["index.md"],
     "Data" => [
-        "data_sources.md",
-        "data_build.md",
-        "sets.md"
-        ],
-    "National Module" => ["overview.md"],
+        "United States" => [
+            "data/united_states/data_sources.md",
+            "data/united_states/data_build.md",
+            "data/united_states/sets.md",
+            "data/united_states/build_local.md"
+            ],
+        "Australia" => [
+            "data/australia/australia_data.md",
+            "data/australia/load_data.md"
+            ],
+    ],
+    "Calibration" => ["calibration.md"],
+    "The National Model" => ["model/overview.md"],
     "API" => ["api.md"]
 ]
 
 
 literate_files = Dict(
     "sets" => ( 
-        input = "src/sets.jl",
-        output = "src/"
+        input = "src/data/united_states/sets.jl",
+        output = "src/data/united_states/"
     ),
 )
 
@@ -35,9 +50,10 @@ end
 makedocs(
     sitename="WiNDCNational.jl",
     authors="Mitch Phillipson",
-    format = Documenter.HTML(),
+    format = Documenter.HTML(assets = ["assets/custom.css"]),
     modules = [WiNDCNational],
-    pages = _PAGES
+    pages = _PAGES,
+
 )
 
 

docs/src/calibration.md

@@ -0,0 +1,5 @@
+# Overview
+
+The calibration routine uses a standard least-squares approach to fit model parameters to observed data. The `calibrate` function is inherited from `WiNDCContainer`, but requires specification of exogenous (fixed) variables and constraints to guide the calibration process. Variables are fixed by [`WiNDCNational.calibrate_fix_variables`](@ref) and the constraints are defined using [`WiNDCNational.calibrate_constraints`](@ref). 
+
+The `calibrate` function returns a pair `(table, JuMP.Model)` where `table` is a WiNDCTable type and the `JuMP.Model` is the JuMP model used in the calibration. The JuMP model can be used to determine if the model calibrates and debug the constraints if it does not.

docs/src/data/australia/australia_data.md

@@ -0,0 +1,13 @@
+# [Data Sources](@id australia_data_sources)
+
+We use the Supply and Use tables provided by the Australian Bureau of Statistics (ABS).
+
+## Australian Bureau of Statistics - Supply and Use Tables
+
+Scroll down to the `Data Downloads` section of the 
+[ABS Website](https://www.abs.gov.au/statistics/economy/national-accounts/australian-national-accounts-supply-use-tables/latest-release) and download the three tables:
+- `Supply Table` - The supply table
+- `Use Table` - The use table
+- `Primary Inputs Table` - Value Added
+
+This data is only available in `XLSB` format, which Julia is unable to open. You must first manually convert the file to `XLSX` format using Excel.