restore files

econ-ark · Nov 7, 2024 · f07fcc9 · f07fcc9
1 parent 0adb1b7
commit f07fcc9
Show file tree

Hide file tree

Showing 35 changed files with 276 additions and 1,379 deletions.
diff --git a/Documentation/reference b/Documentation/reference
diff --git a/Documentation/reference/ConsumptionSaving/ConsAggShockModel.rst b/Documentation/reference/ConsumptionSaving/ConsAggShockModel.rst
@@ -0,0 +1,7 @@
+ConsAggShockModel
+--------------------
+
+.. automodule:: HARK.ConsumptionSaving.ConsAggShockModel
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/Documentation/reference/ConsumptionSaving/ConsBequestModel.rst b/Documentation/reference/ConsumptionSaving/ConsBequestModel.rst
@@ -0,0 +1,7 @@
+ConsBequestModel
+--------------------
+
+.. automodule:: HARK.ConsumptionSaving.ConsBequestModel
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/Documentation/reference/ConsumptionSaving/ConsGenIncProcessModel.rst b/Documentation/reference/ConsumptionSaving/ConsGenIncProcessModel.rst
@@ -0,0 +1,7 @@
+ConsGenIncProcessModel
+------------------------------
+
+.. automodule:: HARK.ConsumptionSaving.ConsGenIncProcessModel
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/Documentation/reference/ConsumptionSaving/ConsIndShockModel.rst b/Documentation/reference/ConsumptionSaving/ConsIndShockModel.rst
@@ -0,0 +1,7 @@
+ConsIndShockModel
+----------------------------
+
+.. automodule:: HARK.ConsumptionSaving.ConsIndShockModel
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/Documentation/reference/ConsumptionSaving/ConsIndShockModelFast.rst b/Documentation/reference/ConsumptionSaving/ConsIndShockModelFast.rst
@@ -0,0 +1,7 @@
+ConsIndShockModelFast
+----------------------------
+
+.. automodule:: HARK.ConsumptionSaving.ConsIndShockModelFast
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/Documentation/reference/ConsumptionSaving/ConsLaborModel.rst b/Documentation/reference/ConsumptionSaving/ConsLaborModel.rst
@@ -0,0 +1,7 @@
+ConsLaborModel
+--------------------------
+
+.. automodule:: HARK.ConsumptionSaving.ConsLaborModel
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/Documentation/reference/ConsumptionSaving/ConsMarkovModel.rst b/Documentation/reference/ConsumptionSaving/ConsMarkovModel.rst
@@ -0,0 +1,7 @@
+ConsMarkovModel
+--------------------
+
+.. automodule:: HARK.ConsumptionSaving.ConsMarkovModel
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/Documentation/reference/ConsumptionSaving/ConsMedModel.rst b/Documentation/reference/ConsumptionSaving/ConsMedModel.rst
@@ -0,0 +1,7 @@
+ConsMedModel
+-------------------
+
+.. automodule:: HARK.ConsumptionSaving.ConsMedModel
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/Documentation/reference/ConsumptionSaving/ConsPortfolioFrameModel.rst b/Documentation/reference/ConsumptionSaving/ConsPortfolioFrameModel.rst
@@ -0,0 +1,7 @@
+ConsPortfolioFrameModel
+-----------------------
+
+.. automodule:: HARK.ConsumptionSaving.ConsPortfolioFrameModel
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/Documentation/reference/ConsumptionSaving/ConsPortfolioModel.rst b/Documentation/reference/ConsumptionSaving/ConsPortfolioModel.rst
@@ -0,0 +1,7 @@
+ConsPortfolioModel
+-----------------------
+
+.. automodule:: HARK.ConsumptionSaving.ConsPortfolioModel
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/Documentation/reference/ConsumptionSaving/ConsPrefShochModel.rst b/Documentation/reference/ConsumptionSaving/ConsPrefShochModel.rst
@@ -0,0 +1,7 @@
+ConsPrefShockModel
+---------------------------
+
+.. automodule:: HARK.ConsumptionSaving.ConsPrefShockModel
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/Documentation/reference/ConsumptionSaving/ConsRepAgentModel.rst b/Documentation/reference/ConsumptionSaving/ConsRepAgentModel.rst
@@ -0,0 +1,7 @@
+ConsRepAgentModel
+--------------------------
+
+.. automodule:: HARK.ConsumptionSaving.ConsRepAgentModel
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/Documentation/reference/ConsumptionSaving/ConsRiskyAssetModel.rst b/Documentation/reference/ConsumptionSaving/ConsRiskyAssetModel.rst
@@ -0,0 +1,7 @@
+ConsRiskyAssetModel
+-----------------------
+
+.. automodule:: HARK.ConsumptionSaving.ConsRiskyAssetModel
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/Documentation/reference/ConsumptionSaving/ConsRiskyContribModel.rst b/Documentation/reference/ConsumptionSaving/ConsRiskyContribModel.rst
@@ -0,0 +1,7 @@
+ConsRiskyContribModel
+-----------------------
+
+.. automodule:: HARK.ConsumptionSaving.ConsRiskyContribModel
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/Documentation/reference/ConsumptionSaving/TractableBufferStockModel.rst b/Documentation/reference/ConsumptionSaving/TractableBufferStockModel.rst
@@ -0,0 +1,7 @@
+TractableBufferStockModel
+--------------------------
+
+.. automodule:: HARK.ConsumptionSaving.TractableBufferStockModel
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/Documentation/reference/ConsumptionSaving/index.rst b/Documentation/reference/ConsumptionSaving/index.rst
@@ -0,0 +1,6 @@
+:orphan:
+
+Consumption Saving
+==================
+
+See :doc:`../index`.
diff --git a/Documentation/reference/index.rst b/Documentation/reference/index.rst
@@ -0,0 +1,43 @@
+API Reference
+=============
+
+.. toctree::
+   :caption: Tools
+   :maxdepth: 1
+
+   tools/core
+   tools/dcegm
+   tools/distribution
+   tools/econforgeinterp
+   tools/estimation
+   tools/frame
+   tools/helpers
+   tools/interpolation
+   tools/incomeprocess
+   tools/model
+   tools/numba_tools
+   tools/parallel
+   tools/rewards
+   tools/simulation
+   tools/utilities
+   tools/validators
+
+.. toctree::
+   :caption: Models
+   :maxdepth: 1
+
+   ConsumptionSaving/ConsAggShockModel
+   ConsumptionSaving/ConsBequestModel
+   ConsumptionSaving/ConsGenIncProcessModel
+   ConsumptionSaving/ConsIndShockModel
+   ConsumptionSaving/ConsIndShockModelFast
+   ConsumptionSaving/ConsLaborModel
+   ConsumptionSaving/ConsMarkovModel
+   ConsumptionSaving/ConsMedModel
+   ConsumptionSaving/ConsPortfolioFrameModel
+   ConsumptionSaving/ConsPortfolioModel
+   ConsumptionSaving/ConsPrefShochModel
+   ConsumptionSaving/ConsRepAgentModel
+   ConsumptionSaving/ConsRiskyAssetModel
+   ConsumptionSaving/ConsRiskyContribModel
+   ConsumptionSaving/TractableBufferStockModel
diff --git a/Documentation/reference/tools/core.rst b/Documentation/reference/tools/core.rst
@@ -0,0 +1,7 @@
+Core
+--------
+
+.. automodule:: HARK.core
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/Documentation/reference/tools/dcegm.rst b/Documentation/reference/tools/dcegm.rst
@@ -0,0 +1,7 @@
+dcegm
+--------
+
+.. automodule:: HARK.dcegm
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/Documentation/reference/tools/distribution.rst b/Documentation/reference/tools/distribution.rst
@@ -0,0 +1,7 @@
+Distribution
+-------------
+
+.. automodule:: HARK.distribution
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/Documentation/reference/tools/econforgeinterp.rst b/Documentation/reference/tools/econforgeinterp.rst
@@ -0,0 +1,7 @@
+Econforgeinterp
+---------------
+
+.. automodule:: HARK.econforgeinterp
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/Documentation/reference/tools/estimation.rst b/Documentation/reference/tools/estimation.rst
@@ -0,0 +1,7 @@
+Estimation
+-------------
+
+.. automodule:: HARK.estimation
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/Documentation/reference/tools/frame.rst b/Documentation/reference/tools/frame.rst
@@ -0,0 +1,7 @@
+Frame
+-------------
+
+.. automodule:: HARK.frame
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/Documentation/reference/tools/helpers.rst b/Documentation/reference/tools/helpers.rst
@@ -0,0 +1,7 @@
+Helpers
+-------------
+
+.. automodule:: HARK.helpers
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/Documentation/reference/tools/incomeprocess.rst b/Documentation/reference/tools/incomeprocess.rst
@@ -0,0 +1,11 @@
+Calibration
+-------------
+
+.. automodule:: HARK.Calibration.Income.IncomeProcesses
+   :members:
+   :undoc-members:
+   :show-inheritance:
+.. automodule:: HARK.Calibration.Assets.AssetProcesses
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/Documentation/reference/tools/index.rst b/Documentation/reference/tools/index.rst
@@ -0,0 +1,6 @@
+:orphan:
+
+Tools
+=====
+
+See :doc:`../index`.
diff --git a/Documentation/reference/tools/interpolation.rst b/Documentation/reference/tools/interpolation.rst
@@ -0,0 +1,7 @@
+Interpolation
+-------------
+
+.. automodule:: HARK.interpolation
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/Documentation/reference/tools/model.rst b/Documentation/reference/tools/model.rst
@@ -0,0 +1,7 @@
+Model
+-------------
+
+.. automodule:: HARK.model
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/Documentation/reference/tools/numba_tools.rst b/Documentation/reference/tools/numba_tools.rst
@@ -0,0 +1,7 @@
+Numba Tools
+-------------
+
+.. automodule:: HARK.numba_tools
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/Documentation/reference/tools/parallel.rst b/Documentation/reference/tools/parallel.rst
@@ -0,0 +1,7 @@
+Parallel
+----------
+
+.. automodule:: HARK.parallel
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/Documentation/reference/tools/rewards.rst b/Documentation/reference/tools/rewards.rst
@@ -0,0 +1,7 @@
+Rewards
+----------
+
+.. automodule:: HARK.rewards
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/Documentation/reference/tools/simulation.rst b/Documentation/reference/tools/simulation.rst
@@ -0,0 +1,7 @@
+Simulation
+------------
+
+.. automodule:: HARK.simulation.monte_carlo
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/Documentation/reference/tools/utilities.rst b/Documentation/reference/tools/utilities.rst
@@ -0,0 +1,7 @@
+Utilities
+----------
+
+.. automodule:: HARK.utilities
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/Documentation/reference/tools/validators.rst b/Documentation/reference/tools/validators.rst
@@ -0,0 +1,7 @@
+Validators
+-------------
+
+.. automodule:: HARK.validators
+   :members:
+   :undoc-members:
+   :show-inheritance: