Small edits to old work

econ-ark · Aug 20, 2024 · 2a77297 · 2a77297
1 parent ae7e28e
commit 2a77297
Show file tree

Hide file tree

Showing 7 changed files with 33 additions and 45 deletions.
diff --git a/HARK/ConsumptionSaving/ConsGenIncProcessModel.py b/HARK/ConsumptionSaving/ConsGenIncProcessModel.py
@@ -661,7 +661,7 @@ class GenIncProcessConsumerType(IndShockConsumerType):
 
     Constructors
     ------------
-    IncShkDstn: Constructor
+    IncShkDstn: Constructor, (:math:`\psi`,:math:`\theta`)
         The agent's income shock distributions.
 
         It's default constructor is :func:`HARK.Calibration.Income.IncomeProcesses.construct_lognormal_income_process_unemployment`
@@ -1067,15 +1067,15 @@ class IndShockExplicitPermIncConsumerType(GenIncProcessConsumerType):
 
     Constructors
     ------------
-    IncShkDstn: Constructor
+    IncShkDstn: Constructor, (:math:`\psi`,:math:`\theta`)
         The agent's income shock distributions.
 
         It's default constructor is :func:`HARK.Calibration.Income.IncomeProcesses.construct_lognormal_income_process_unemployment`
     aXtraGrid: Constructor
         The agent's asset grid.
 
         It's default constructor is :func:`HARK.utilities.make_assets_grid`
-    pLvlNextFunc: Constructor
+    pLvlNextFunc: Constructor, (:math:`\Gamma`)
         An arbitrary function used to evolve the GenIncShockConsumerType's permanent income
 
         It's default constructor is :func:`HARK.Calibration.Income.IncomeProcesses.make_explicit_perminc_pLvlNextFunc`
@@ -1261,15 +1261,15 @@ class PersistentShockConsumerType(GenIncProcessConsumerType):
 
     Constructors
     ------------
-    IncShkDstn: Constructor
+    IncShkDstn: Constructor, (:math:`\psi`,:math:`\theta`)
         The agent's income shock distributions.
 
         It's default constructor is :func:`HARK.Calibration.Income.IncomeProcesses.construct_lognormal_income_process_unemployment`
     aXtraGrid: Constructor
         The agent's asset grid.
 
         It's default constructor is :func:`HARK.utilities.make_assets_grid`
-    pLvlNextFunc: Constructor
+    pLvlNextFunc: Constructor, (:math:`\Gamma`, :math:`\varphi`, :math:`\Gamma`)
         An arbitrary function used to evolve the GenIncShockConsumerType's permanent income
 
         It's default constructor is :func:`HARK.Calibration.Income.IncomeProcesses.make_AR1_style_pLvlNextFunc`

diff --git a/HARK/ConsumptionSaving/ConsIndShockModel.py b/HARK/ConsumptionSaving/ConsIndShockModel.py
@@ -1129,9 +1129,7 @@ class PerfForesightConsumerType(AgentType):
         Number of periods to simulate.
     track_vars: list[strings]
         List of variables that should be tracked when running the simulation.
-    	For this agent, the options are 'PlvlAgg', 'aLvl', 'aNrm', 'bNrm', 'cNrm', 'mNrm', 'pLvl', and 'who_dies'.
-
-        PlvlAgg is 1
+        For this agent, the options are 'aLvl', 'aNrm', 'bNrm', 'cNrm', 'mNrm', 'pLvl', and 'who_dies'.
 
         aLvl is the nominal asset level
 
@@ -2014,7 +2012,7 @@ class IndShockConsumerType(PerfForesightConsumerType):
 
     Constructors
     ------------
-    IncShkDstn: Constructor
+    IncShkDstn: Constructor, (:math:`\psi`,:math:`\theta`)
         The agent's income shock distributions.
 
         It's default constructor is :func:`HARK.Calibration.Income.IncomeProcesses.construct_lognormal_income_process_unemployment`
@@ -2056,12 +2054,10 @@ class IndShockConsumerType(PerfForesightConsumerType):
         Number of periods to simulate.
     track_vars: list[strings]
         List of variables that should be tracked when running the simulation.
-    	For this agent, the options are 'PermShk', 'PlvlAgg', 'TranShk', 'aLvl', 'aNrm', 'bNrm', 'cNrm', 'mNrm', 'pLvl', and 'who_dies'.
+        For this agent, the options are 'PermShk', 'TranShk', 'aLvl', 'aNrm', 'bNrm', 'cNrm', 'mNrm', 'pLvl', and 'who_dies'.
 
         PermShk is the agent's permanent income shock
 
-        PlvlAgg is 1
-
         TranShk is the agent's transitory income shock
 
         aLvl is the nominal asset level
@@ -2802,19 +2798,20 @@ class KinkedRconsumerType(IndShockConsumerType):
         \end{cases}\\
         \Rfree_{boro} &> \Rfree_{save}, \\
         (\psi_{t+1},\theta_{t+1}) &\sim F_{t+1}, \\
+        \mathbb{E}[\psi]=\mathbb{E}[\theta] &= 1.
         \end{align*}
 
 
     Constructors
     ------------
-    IncShkDstn: Constructor
+    IncShkDstn: Constructor, (:math:`\psi`,:math:`\theta`)
         The agent's income shock distributions.
 
-        It's default constructor is :class:`HARK.Calibration.Income.IncomeProcesses.construct_lognormal_income_process_unemployment`
+        It's default constructor is :func:`HARK.Calibration.Income.IncomeProcesses.construct_lognormal_income_process_unemployment`
     aXtraGrid: Constructor
         The agent's asset grid.
 
-        It's default constructor is :class:`HARK.utilities.make_assets_grid`
+        It's default constructor is :func:`HARK.utilities.make_assets_grid`
 
     Solving Parameters
     ------------------
@@ -2851,12 +2848,10 @@ class KinkedRconsumerType(IndShockConsumerType):
         Number of periods to simulate.
     track_vars: list[strings]
         List of variables that should be tracked when running the simulation.
-    	For this agent, the options are 'PermShk', 'PlvlAgg', 'TranShk', 'aLvl', 'aNrm', 'bNrm', 'cNrm', 'mNrm', 'pLvl', and 'who_dies'.
+        For this agent, the options are 'PermShk', 'TranShk', 'aLvl', 'aNrm', 'bNrm', 'cNrm', 'mNrm', 'pLvl', and 'who_dies'.
 
         PermShk is the agent's permanent income shock
 
-        PlvlAgg is 1
-
         TranShk is the agent's transitory income shock
 
         aLvl is the nominal asset level

diff --git a/HARK/ConsumptionSaving/ConsLaborModel.py b/HARK/ConsumptionSaving/ConsLaborModel.py
@@ -569,15 +569,15 @@ class LaborIntMargConsumerType(IndShockConsumerType):
 
     Constructors
     ------------
-    IncShkDstn: Constructor
+    IncShkDstn: Constructor, (:math:`\psi`,:math:`\theta`)
         The agent's income shock distributions.
 
         It's default constructor is :func:`HARK.Calibration.Income.IncomeProcesses.construct_lognormal_income_process_unemployment`
     aXtraGrid: Constructor
         The agent's asset grid.
 
         It's default constructor is :func:`HARK.utilities.make_assets_grid`
-    LbrCost: Constructor
+    LbrCost: Constructor, (:math:`\alpha`)
         The agent's labor cost function.
 
         It's default constructor is :func:`HARK.ConsumptionSaving.ConsLaborModel.make_log_polynomial_LbrCost`

diff --git a/HARK/ConsumptionSaving/ConsMedModel.py b/HARK/ConsumptionSaving/ConsMedModel.py
@@ -844,7 +844,7 @@ class MedShockConsumerType(PersistentShockConsumerType):
 
     Constructors
     ------------
-    IncShkDstn: Constructor
+    IncShkDstn: Constructor, (:math:`\psi`,:math:`\theta`)
         The agent's income shock distributions.
 
         It's default constructor is :func:`HARK.Calibration.Income.IncomeProcesses.construct_lognormal_income_process_unemployment`
@@ -863,7 +863,7 @@ class MedShockConsumerType(PersistentShockConsumerType):
         The agents income level percentile grid
 
         It's default constructor is :func:`HARK.Calibration.Income.IncomeProcesses.make_basic_pLvlPctiles`
-    MedShkDstn:
+    MedShkDstn: Constructor, (:math:`\text{medShk}`)
         The agent's Medical utility shock distribution.
 
         It's default constructor is :func:`HARK.ConsumptionSaving.ConsMedModel.make_lognormal_MedShkDstn`

diff --git a/HARK/ConsumptionSaving/ConsPortfolioModel.py b/HARK/ConsumptionSaving/ConsPortfolioModel.py
@@ -1123,7 +1123,7 @@ class PortfolioConsumerType(RiskyAssetConsumerType):
 
     Constructors
     ------------
-    IncShkDstn: Constructor
+    IncShkDstn: Constructor, (:math:`\psi`,:math:`\theta`)
         The agent's income shock distributions.
 
         It's default constructor is :func:`HARK.Calibration.Income.IncomeProcesses.construct_lognormal_income_process_unemployment`
@@ -1135,7 +1135,7 @@ class PortfolioConsumerType(RiskyAssetConsumerType):
         The agent's risky asset share grid
 
         It's default constructor is :func:`HARK.ConsumptionSaving.ConsRiskyAssetModel.make_simple_ShareGrid`
-    RiskyDstn:
+    RiskyDstn: Constructor, (:math:`\phi`)
         The agent's asset shock distribution for risky assets.
 
         It's default constructor is :func:`HARK.Calibration.Assets.AssetProcesses.make_lognormal_RiskyDstn`
@@ -1227,7 +1227,6 @@ class PortfolioConsumerType(RiskyAssetConsumerType):
         Created by running the :func:`.simulate()` method.
         Contains the variables in track_vars. Each item in the dictionary is an array with the shape (T_sim,AgentCount).
         Visit :class:`HARK.core.AgentType.simulate` for more information.
-
     """
 
     IncShkDstn_default = PortfolioConsumerType_IncShkDstn_default

diff --git a/HARK/ConsumptionSaving/ConsPrefShockModel.py b/HARK/ConsumptionSaving/ConsPrefShockModel.py
@@ -241,15 +241,15 @@ class PrefShockConsumerType(IndShockConsumerType):
 
     Constructors
     ------------
-    IncShkDstn: Constructor
+    IncShkDstn: Constructor, (:math:`\psi`,:math:`\theta`)
         The agent's income shock distributions.
 
         It's default constructor is :func:`HARK.Calibration.Income.IncomeProcesses.construct_lognormal_income_process_unemployment`
     aXtraGrid: Constructor
         The agent's asset grid.
 
         It's default constructor is :func:`HARK.utilities.make_assets_grid`
-    PrefShkDstn: Constructor
+    PrefShkDstn: Constructor, (:math:`\eta`)
         The agent's preference shock distributions.
 
         It's default constuctor is :func:`HARK.ConsumptionSaving.ConsPrefShockModel.make_lognormal_PrefShkDstn`
@@ -287,12 +287,10 @@ class PrefShockConsumerType(IndShockConsumerType):
         Number of periods to simulate.
     track_vars: list[strings]
         List of variables that should be tracked when running the simulation.
-    	For this agent, the options are 'PermShk', 'PlvlAgg', 'PrefShk', 'TranShk', 'aLvl', 'aNrm', 'bNrm', 'cNrm', 'mNrm', 'pLvl', and 'who_dies'.
+        For this agent, the options are 'PermShk', 'PrefShk', 'TranShk', 'aLvl', 'aNrm', 'bNrm', 'cNrm', 'mNrm', 'pLvl', and 'who_dies'.
 
         PermShk is the agent's permanent income shock
 
-        PlvlAgg is 1
-
         PrefShk is the agent's preference shock
 
         TranShk is the agent's transitory income shock
@@ -545,15 +543,15 @@ class KinkyPrefConsumerType(PrefShockConsumerType, KinkedRconsumerType):
 
     Constructors
     ------------
-    IncShkDstn: Constructor
+    IncShkDstn: Constructor, (:math:`\psi`,:math:`\theta`)
         The agent's income shock distributions.
 
         It's default constructor is :func:`HARK.Calibration.Income.IncomeProcesses.construct_lognormal_income_process_unemployment`
     aXtraGrid: Constructor
         The agent's asset grid.
 
         It's default constructor is :func:`HARK.utilities.make_assets_grid`
-    PrefShkDstn: Constructor
+    PrefShkDstn: Constructor, (:math:`\eta`)
         The agent's preference shock distributions.
 
         It's default constuctor is :func:`HARK.ConsumptionSaving.ConsPrefShockModel.make_lognormal_PrefShkDstn`
@@ -566,6 +564,8 @@ class KinkyPrefConsumerType(PrefShockConsumerType, KinkedRconsumerType):
         Number of periods in the cycle for this agent type.
     CRRA: float, :math:`\rho`
         Coefficient of Relative Risk Aversion.
+    Rfree: float or list[float], time varying, :math:`\mathsf{R}`
+        Risk Free interest rate. Pass a list of floats to make Rfree time varying.
     Rboro: float, :math:`\mathsf{R}_{boro}`
         Risk Free interest rate when assets are negative.
     Rsave: float, :math:`\mathsf{R}_{save}`
@@ -593,12 +593,10 @@ class KinkyPrefConsumerType(PrefShockConsumerType, KinkedRconsumerType):
         Number of periods to simulate.
     track_vars: list[strings]
         List of variables that should be tracked when running the simulation.
-    	For this agent, the options are 'PermShk', 'PlvlAgg', 'PrefShk', 'TranShk', 'aLvl', 'aNrm', 'bNrm', 'cNrm', 'mNrm', 'pLvl', and 'who_dies'.
+        For this agent, the options are 'PermShk', 'PrefShk', 'TranShk', 'aLvl', 'aNrm', 'bNrm', 'cNrm', 'mNrm', 'pLvl', and 'who_dies'.
 
         PermShk is the agent's permanent income shock
 
-        PlvlAgg is 1
-
         PrefShk is the agent's preference shock
 
         TranShk is the agent's transitory income shock

diff --git a/HARK/ConsumptionSaving/ConsRiskyAssetModel.py b/HARK/ConsumptionSaving/ConsRiskyAssetModel.py
@@ -200,7 +200,7 @@ class IndShockRiskyAssetConsumerType(IndShockConsumerType):
 
     Constructors
     ------------
-    IncShkDstn: Constructor
+    IncShkDstn: Constructor, (:math:`\psi`,:math:`\theta`)
         The agent's income shock distributions.
 
         It's default constructor is :func:`HARK.Calibration.Income.IncomeProcesses.construct_lognormal_income_process_unemployment`
@@ -212,7 +212,7 @@ class IndShockRiskyAssetConsumerType(IndShockConsumerType):
         The agent's risky asset share grid
 
         It's default constructor is :func:`HARK.ConsumptionSaving.ConsRiskyAssetModel.make_simple_ShareGrid`
-    RiskyDstn:
+    RiskyDstn: Constructor, (:math:`\phi`)
         The agent's asset shock distribution for risky assets.
 
         It's default constructor is :func:`HARK.Calibration.Assets.AssetProcesses.make_lognormal_RiskyDstn`
@@ -254,14 +254,12 @@ class IndShockRiskyAssetConsumerType(IndShockConsumerType):
         Number of periods to simulate.
     track_vars: list[strings]
         List of variables that should be tracked when running the simulation.
-    	For this agent, the options are 'Adjust', 'PermShk', 'PlvlAgg', 'Risky', 'TranShk', 'aLvl', 'aNrm', 'bNrm', 'cNrm', 'mNrm', 'pLvl', and 'who_dies'.
+        For this agent, the options are 'Adjust', 'PermShk', 'Risky', 'TranShk', 'aLvl', 'aNrm', 'bNrm', 'cNrm', 'mNrm', 'pLvl', and 'who_dies'.
 
         Adjust is the array of which agents can adjust
 
         PermShk is the agent's permanent income shock
 
-        PlvlAgg is 1
-
         Risky is the agent's risky asset shock
 
         TranShk is the agent's transitory income shock
@@ -667,7 +665,7 @@ class FixedPortfolioShareRiskyAssetConsumerType(IndShockRiskyAssetConsumerType):
 
     Constructors
     ------------
-    IncShkDstn: Constructor
+    IncShkDstn: Constructor, (:math:`\psi`,:math:`\theta`)
         The agent's income shock distributions.
 
         It's default constructor is :func:`HARK.Calibration.Income.IncomeProcesses.construct_lognormal_income_process_unemployment`
@@ -679,7 +677,7 @@ class FixedPortfolioShareRiskyAssetConsumerType(IndShockRiskyAssetConsumerType):
         The agent's risky asset share grid
 
         It's default constructor is :func:`HARK.ConsumptionSaving.ConsRiskyAssetModel.make_simple_ShareGrid`
-    RiskyDstn:
+    RiskyDstn: Constructor, (:math:`\phi`)
         The agent's asset shock distribution for risky assets.
 
         It's default constructor is :func:`HARK.Calibration.Assets.AssetProcesses.make_lognormal_RiskyDstn`
@@ -723,14 +721,12 @@ class FixedPortfolioShareRiskyAssetConsumerType(IndShockRiskyAssetConsumerType):
         Number of periods to simulate.
     track_vars: list[strings]
         List of variables that should be tracked when running the simulation.
-    	For this agent, the options are 'Adjust', 'PermShk', 'PlvlAgg', 'Risky', 'TranShk', 'aLvl', 'aNrm', 'bNrm', 'cNrm', 'mNrm', 'pLvl', and 'who_dies'.
+        For this agent, the options are 'Adjust', 'PermShk', 'Risky', 'TranShk', 'aLvl', 'aNrm', 'bNrm', 'cNrm', 'mNrm', 'pLvl', and 'who_dies'.
 
         Adjust is the array of which agents can adjust
 
         PermShk is the agent's permanent income shock
 
-        PlvlAgg is 1
-
         Risky is the agent's risky asset shock
 
         TranShk is the agent's transitory income shock