move examples and fix docs

econ-ark · Nov 20, 2024 · 61c597d · 61c597d
1 parent f801de7
commit 61c597d
Show file tree

Hide file tree

Showing 77 changed files with 4 additions and 34 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -49,12 +49,7 @@
 ]
 
 source_suffix = [".rst", ".md"]
-# Makes sure that only the file we want documented get documented
-include_patterns = ["**", "index.rst"]
-# Adds example notebooks
-with open(os.path.join(dir, "example_notebooks", "Include_list.txt"), "r") as file:
-    include_patterns += file.readlines()
-include_patterns = [i.replace("\n", "") for i in include_patterns]
+
 # Prevents sphinx from getting confused
 exclude_patterns = [
     "_build",

diff --git a/docs/example_notebooks/Include_list.txt b/docs/example_notebooks/Include_list.txt
diff --git a/examples/Blocks/Model Setup Demo.ipynb → docs/examples/Blocks/Model Setup Demo.ipynb b/examples/Blocks/Model Setup Demo.ipynb → docs/examples/Blocks/Model Setup Demo.ipynb
diff --git a/...les/Calibration/Income_calibrations.ipynb → ...les/Calibration/Income_calibrations.ipynb b/...les/Calibration/Income_calibrations.ipynb → ...les/Calibration/Income_calibrations.ipynb
diff --git a/...ples/Calibration/Life_Cycle_example.ipynb → ...ples/Calibration/Life_Cycle_example.ipynb b/...ples/Calibration/Life_Cycle_example.ipynb → ...ples/Calibration/Life_Cycle_example.ipynb
diff --git a/examples/Calibration/SCF_distributions.ipynb → ...mples/Calibration/SCF_distributions.ipynb b/examples/Calibration/SCF_distributions.ipynb → ...mples/Calibration/SCF_distributions.ipynb
diff --git a/...bration/Sabelhaus_Song_var_profiles.ipynb → ...bration/Sabelhaus_Song_var_profiles.ipynb b/...bration/Sabelhaus_Song_var_profiles.ipynb → ...bration/Sabelhaus_Song_var_profiles.ipynb
diff --git a/...ples/Calibration/US_SSA_life_tables.ipynb → ...ples/Calibration/US_SSA_life_tables.ipynb b/...ples/Calibration/US_SSA_life_tables.ipynb → ...ples/Calibration/US_SSA_life_tables.ipynb
diff --git a/...Model/example_AccidentalBequestComp.ipynb → ...Model/example_AccidentalBequestComp.ipynb b/...Model/example_AccidentalBequestComp.ipynb → ...Model/example_AccidentalBequestComp.ipynb
diff --git a/...l/example_AccidentalBequestPortComp.ipynb → ...l/example_AccidentalBequestPortComp.ipynb b/...l/example_AccidentalBequestPortComp.ipynb → ...l/example_AccidentalBequestPortComp.ipynb
diff --git a/...equestModel/example_TerminalBequest.ipynb → ...equestModel/example_TerminalBequest.ipynb b/...equestModel/example_TerminalBequest.ipynb → ...equestModel/example_TerminalBequest.ipynb
diff --git a/...stModel/example_TerminalBequestPort.ipynb → ...stModel/example_TerminalBequestPort.ipynb b/...stModel/example_TerminalBequestPort.ipynb → ...stModel/example_TerminalBequestPort.ipynb
diff --git a/...equestModel/example_WarmGlowBequest.ipynb → ...equestModel/example_WarmGlowBequest.ipynb b/...equestModel/example_WarmGlowBequest.ipynb → ...equestModel/example_WarmGlowBequest.ipynb
diff --git a/...stModel/example_WarmGlowBequestPort.ipynb → ...stModel/example_WarmGlowBequestPort.ipynb b/...stModel/example_WarmGlowBequestPort.ipynb → ...stModel/example_WarmGlowBequestPort.ipynb
diff --git a/...equestModel/example_WealthPortfolio.ipynb → ...equestModel/example_WealthPortfolio.ipynb b/...equestModel/example_WealthPortfolio.ipynb → ...equestModel/example_WealthPortfolio.ipynb
diff --git a/...sIndShockModel/Finite Cyclical Test.ipynb → ...sIndShockModel/Finite Cyclical Test.ipynb b/...sIndShockModel/Finite Cyclical Test.ipynb → ...sIndShockModel/Finite Cyclical Test.ipynb
diff --git a/...sIndShockModel/IndShockConsumerType.ipynb → ...sIndShockModel/IndShockConsumerType.ipynb b/...sIndShockModel/IndShockConsumerType.ipynb → ...sIndShockModel/IndShockConsumerType.ipynb
diff --git a/...nsIndShockModel/KinkedRconsumerType.ipynb → ...nsIndShockModel/KinkedRconsumerType.ipynb b/...nsIndShockModel/KinkedRconsumerType.ipynb → ...nsIndShockModel/KinkedRconsumerType.ipynb
diff --git a/...hockModel/PerfForesightConsumerType.ipynb → ...hockModel/PerfForesightConsumerType.ipynb b/...hockModel/PerfForesightConsumerType.ipynb → ...hockModel/PerfForesightConsumerType.ipynb
diff --git a/examples/ConsIndShockModel/latexdefs.tex → .../examples/ConsIndShockModel/latexdefs.tex b/examples/ConsIndShockModel/latexdefs.tex → .../examples/ConsIndShockModel/latexdefs.tex
diff --git a/...sNewKeynesianModel/Jacobian_Example.ipynb → ...sNewKeynesianModel/Jacobian_Example.ipynb b/...sNewKeynesianModel/Jacobian_Example.ipynb → ...sNewKeynesianModel/Jacobian_Example.ipynb
diff --git a/...KeynesianModel/KS-HARK-presentation.ipynb → ...KeynesianModel/KS-HARK-presentation.ipynb b/...KeynesianModel/KS-HARK-presentation.ipynb → ...KeynesianModel/KS-HARK-presentation.ipynb
diff --git a/examples/ConsNewKeynesianModel/KS_DAG.jpeg → ...xamples/ConsNewKeynesianModel/KS_DAG.jpeg b/examples/ConsNewKeynesianModel/KS_DAG.jpeg → ...xamples/ConsNewKeynesianModel/KS_DAG.jpeg
diff --git a/...s/ConsNewKeynesianModel/SSJ_example.ipynb → ...s/ConsNewKeynesianModel/SSJ_example.ipynb b/...s/ConsNewKeynesianModel/SSJ_example.ipynb → ...s/ConsNewKeynesianModel/SSJ_example.ipynb
diff --git a/...nsNewKeynesianModel/SSJ_explanation.ipynb → ...nsNewKeynesianModel/SSJ_explanation.ipynb b/...nsNewKeynesianModel/SSJ_explanation.ipynb → ...nsNewKeynesianModel/SSJ_explanation.ipynb
diff --git a/...sianModel/Transition_Matrix_Example.ipynb → ...sianModel/Transition_Matrix_Example.ipynb b/...sianModel/Transition_Matrix_Example.ipynb → ...sianModel/Transition_Matrix_Example.ipynb
diff --git a/...sNewKeynesianModel/estimation/__init__.py → ...sNewKeynesianModel/estimation/__init__.py b/...sNewKeynesianModel/estimation/__init__.py → ...sNewKeynesianModel/estimation/__init__.py
diff --git a/...wKeynesianModel/estimation/create_data.py → ...wKeynesianModel/estimation/create_data.py b/...wKeynesianModel/estimation/create_data.py → ...wKeynesianModel/estimation/create_data.py
diff --git a/...ConsNewKeynesianModel/estimation/model.py → ...ConsNewKeynesianModel/estimation/model.py b/...ConsNewKeynesianModel/estimation/model.py → ...ConsNewKeynesianModel/estimation/model.py
diff --git a/...ConsNewKeynesianModel/estimation/plots.py → ...ConsNewKeynesianModel/estimation/plots.py b/...ConsNewKeynesianModel/estimation/plots.py → ...ConsNewKeynesianModel/estimation/plots.py
diff --git a/...sNewKeynesianModel/estimation/routines.py → ...sNewKeynesianModel/estimation/routines.py b/...sNewKeynesianModel/estimation/routines.py → ...sNewKeynesianModel/estimation/routines.py
diff --git a/...sNewKeynesianModel/estimation/us_data.csv → ...sNewKeynesianModel/estimation/us_data.csv b/...sNewKeynesianModel/estimation/us_data.csv → ...sNewKeynesianModel/estimation/us_data.csv
diff --git a/...lioModel/example_ConsPortfolioModel.ipynb → ...lioModel/example_ConsPortfolioModel.ipynb b/...lioModel/example_ConsPortfolioModel.ipynb → ...lioModel/example_ConsPortfolioModel.ipynb
diff --git a/...ioModel/example_ConsRiskyAssetModel.ipynb → ...ioModel/example_ConsRiskyAssetModel.ipynb b/...ioModel/example_ConsRiskyAssetModel.ipynb → ...ioModel/example_ConsRiskyAssetModel.ipynb
diff --git a/...xample_ConsSequentialPortfolioModel.ipynb → ...xample_ConsSequentialPortfolioModel.ipynb b/...xample_ConsSequentialPortfolioModel.ipynb → ...xample_ConsSequentialPortfolioModel.ipynb
diff --git a/...ionSaving/example_ConsAggShockModel.ipynb → ...ionSaving/example_ConsAggShockModel.ipynb b/...ionSaving/example_ConsAggShockModel.ipynb → ...ionSaving/example_ConsAggShockModel.ipynb
diff --git a/...ving/example_ConsGenIncProcessModel.ipynb → ...ving/example_ConsGenIncProcessModel.ipynb b/...ving/example_ConsGenIncProcessModel.ipynb → ...ving/example_ConsGenIncProcessModel.ipynb
diff --git a/...sumptionSaving/example_ConsIndShock.ipynb → ...sumptionSaving/example_ConsIndShock.ipynb b/...sumptionSaving/example_ConsIndShock.ipynb → ...sumptionSaving/example_ConsIndShock.ipynb
diff --git a/...mptionSaving/example_ConsLaborModel.ipynb → ...mptionSaving/example_ConsLaborModel.ipynb b/...mptionSaving/example_ConsLaborModel.ipynb → ...mptionSaving/example_ConsLaborModel.ipynb
diff --git a/...ptionSaving/example_ConsMarkovModel.ipynb → ...ptionSaving/example_ConsMarkovModel.ipynb b/...ptionSaving/example_ConsMarkovModel.ipynb → ...ptionSaving/example_ConsMarkovModel.ipynb
diff --git a/...sumptionSaving/example_ConsMedModel.ipynb → ...sumptionSaving/example_ConsMedModel.ipynb b/...sumptionSaving/example_ConsMedModel.ipynb → ...sumptionSaving/example_ConsMedModel.ipynb
diff --git a/...onSaving/example_ConsPrefShockModel.ipynb → ...onSaving/example_ConsPrefShockModel.ipynb b/...onSaving/example_ConsPrefShockModel.ipynb → ...onSaving/example_ConsPrefShockModel.ipynb
diff --git a/...ionSaving/example_ConsRepAgentModel.ipynb → ...ionSaving/example_ConsRepAgentModel.ipynb b/...ionSaving/example_ConsRepAgentModel.ipynb → ...ionSaving/example_ConsRepAgentModel.ipynb
diff --git a/...aving/example_ConsRiskyContribModel.ipynb → ...aving/example_ConsRiskyContribModel.ipynb b/...aving/example_ConsRiskyContribModel.ipynb → ...aving/example_ConsRiskyContribModel.ipynb
diff --git a/...g/example_TractableBufferStockModel.ipynb → ...g/example_TractableBufferStockModel.ipynb b/...g/example_TractableBufferStockModel.ipynb → ...g/example_TractableBufferStockModel.ipynb
diff --git a/...butions/DiscreteDistributionLabeled.ipynb → ...butions/DiscreteDistributionLabeled.ipynb b/...butions/DiscreteDistributionLabeled.ipynb → ...butions/DiscreteDistributionLabeled.ipynb
diff --git a/...Distributions/EquiprobableLognormal.ipynb → ...Distributions/EquiprobableLognormal.ipynb b/...Distributions/EquiprobableLognormal.ipynb → ...Distributions/EquiprobableLognormal.ipynb
diff --git a/examples/Distributions/ExpectedValue.ipynb → ...xamples/Distributions/ExpectedValue.ipynb b/examples/Distributions/ExpectedValue.ipynb → ...xamples/Distributions/ExpectedValue.ipynb
diff --git a/...imation/Method of Simulated Moments.ipynb → ...imation/Method of Simulated Moments.ipynb b/...imation/Method of Simulated Moments.ipynb → ...imation/Method of Simulated Moments.ipynb
diff --git a/...nIncProcessModel/GenIncProcessModel.ipynb → ...nIncProcessModel/GenIncProcessModel.ipynb b/...nIncProcessModel/GenIncProcessModel.ipynb → ...nIncProcessModel/GenIncProcessModel.ipynb
diff --git a/...s/Gentle-Intro/Gentle-Intro-To-HARK.ipynb → ...s/Gentle-Intro/Gentle-Intro-To-HARK.ipynb b/...s/Gentle-Intro/Gentle-Intro-To-HARK.ipynb → ...s/Gentle-Intro/Gentle-Intro-To-HARK.ipynb
diff --git a/...Type/HowWeSolveIndShockConsumerType.ipynb → ...Type/HowWeSolveIndShockConsumerType.ipynb b/...Type/HowWeSolveIndShockConsumerType.ipynb → ...Type/HowWeSolveIndShockConsumerType.ipynb
diff --git a/examples/Interpolation/CubicInterp.ipynb → .../examples/Interpolation/CubicInterp.ipynb b/examples/Interpolation/CubicInterp.ipynb → .../examples/Interpolation/CubicInterp.ipynb
diff --git a/examples/Interpolation/DecayInterp.ipynb → .../examples/Interpolation/DecayInterp.ipynb b/examples/Interpolation/DecayInterp.ipynb → .../examples/Interpolation/DecayInterp.ipynb
diff --git a/examples/Journeys/AzureMachineLearning.ipynb → ...mples/Journeys/AzureMachineLearning.ipynb b/examples/Journeys/AzureMachineLearning.ipynb → ...mples/Journeys/AzureMachineLearning.ipynb
diff --git a/examples/Journeys/HAFiscalFig1.png → docs/examples/Journeys/HAFiscalFig1.png b/examples/Journeys/HAFiscalFig1.png → docs/examples/Journeys/HAFiscalFig1.png
diff --git a/examples/Journeys/HARK-ind-sh.png → docs/examples/Journeys/HARK-ind-sh.png b/examples/Journeys/HARK-ind-sh.png → docs/examples/Journeys/HARK-ind-sh.png
diff --git a/examples/Journeys/HARK-struct-2.png → docs/examples/Journeys/HARK-struct-2.png b/examples/Journeys/HARK-struct-2.png → docs/examples/Journeys/HARK-struct-2.png
diff --git a/examples/Journeys/HARK-struct-3.png → docs/examples/Journeys/HARK-struct-3.png b/examples/Journeys/HARK-struct-3.png → docs/examples/Journeys/HARK-struct-3.png
diff --git a/examples/Journeys/HARK-struct-4.png → docs/examples/Journeys/HARK-struct-4.png b/examples/Journeys/HARK-struct-4.png → docs/examples/Journeys/HARK-struct-4.png
diff --git a/...neys/Journey-Engineering-Background.ipynb → ...neys/Journey-Engineering-Background.ipynb b/...neys/Journey-Engineering-Background.ipynb → ...neys/Journey-Engineering-Background.ipynb
diff --git a/examples/Journeys/Journey-PhD.ipynb → docs/examples/Journeys/Journey-PhD.ipynb b/examples/Journeys/Journey-PhD.ipynb → docs/examples/Journeys/Journey-PhD.ipynb
diff --git a/examples/Journeys/Journey-Policymaker.ipynb → ...amples/Journeys/Journey-Policymaker.ipynb b/examples/Journeys/Journey-Policymaker.ipynb → ...amples/Journeys/Journey-Policymaker.ipynb
diff --git a/examples/Journeys/JourneyPhDparam.py → docs/examples/Journeys/JourneyPhDparam.py b/examples/Journeys/JourneyPhDparam.py → docs/examples/Journeys/JourneyPhDparam.py
diff --git a/examples/Journeys/Journeys-into-HARK.ipynb → ...xamples/Journeys/Journeys-into-HARK.ipynb b/examples/Journeys/Journeys-into-HARK.ipynb → ...xamples/Journeys/Journeys-into-HARK.ipynb
diff --git a/examples/Journeys/LorenzcurveDiscRate.png → ...examples/Journeys/LorenzcurveDiscRate.png b/examples/Journeys/LorenzcurveDiscRate.png → ...examples/Journeys/LorenzcurveDiscRate.png
diff --git a/...neys/Quickstart_tutorial/HARK_diagram.png → ...neys/Quickstart_tutorial/HARK_diagram.png b/...neys/Quickstart_tutorial/HARK_diagram.png → ...neys/Quickstart_tutorial/HARK_diagram.png
diff --git a/..._tutorial/Quick_start_with_solution.ipynb → ..._tutorial/Quick_start_with_solution.ipynb b/..._tutorial/Quick_start_with_solution.ipynb → ..._tutorial/Quick_start_with_solution.ipynb
diff --git a/...es/Journeys/Quickstart_tutorial/README.md → ...es/Journeys/Quickstart_tutorial/README.md b/...es/Journeys/Quickstart_tutorial/README.md → ...es/Journeys/Quickstart_tutorial/README.md
diff --git a/...urneys/Quickstart_tutorial/life_table.csv → ...urneys/Quickstart_tutorial/life_table.csv b/...urneys/Quickstart_tutorial/life_table.csv → ...urneys/Quickstart_tutorial/life_table.csv
diff --git a/...ckstart_tutorial/productivity_profile.csv → ...ckstart_tutorial/productivity_profile.csv b/...ckstart_tutorial/productivity_profile.csv → ...ckstart_tutorial/productivity_profile.csv
diff --git a/examples/LabeledModels/LabeledModels.ipynb → ...xamples/LabeledModels/LabeledModels.ipynb b/examples/LabeledModels/LabeledModels.ipynb → ...xamples/LabeledModels/LabeledModels.ipynb
diff --git a/...ples/LifecycleModel/Cycles_tutorial.ipynb → ...ples/LifecycleModel/Cycles_tutorial.ipynb b/...ples/LifecycleModel/Cycles_tutorial.ipynb → ...ples/LifecycleModel/Cycles_tutorial.ipynb
diff --git a/...es/LifecycleModel/EstimationParameters.py → ...es/LifecycleModel/EstimationParameters.py b/...es/LifecycleModel/EstimationParameters.py → ...es/LifecycleModel/EstimationParameters.py
diff --git a/examples/LifecycleModel/LifecycleModel.ipynb → ...mples/LifecycleModel/LifecycleModel.ipynb b/examples/LifecycleModel/LifecycleModel.ipynb → ...mples/LifecycleModel/LifecycleModel.ipynb
diff --git a/...neric Monte Carlo Perfect Foresight.ipynb → ...neric Monte Carlo Perfect Foresight.ipynb b/...neric Monte Carlo Perfect Foresight.ipynb → ...neric Monte Carlo Perfect Foresight.ipynb
diff --git a/docs/overview/index.rst b/docs/overview/index.rst
@@ -13,22 +13,11 @@ Overview
 
 .. nbgallery::
    :caption: Examples
+   :glob:
    :maxdepth: 1
 
-   ../../examples/Gentle-Intro/Gentle-Intro-To-HARK.ipynb
-   ../../examples/LifecycleModel/Cycles_tutorial.ipynb
-   ../../examples/ConsIndShockModel/PerfForesightConsumerType.ipynb
-   ../../examples/ConsIndShockModel/IndShockConsumerType.ipynb
-   ../../examples/ConsIndShockModel/KinkedRconsumerType.ipynb
-   ../../examples/ConsPortfolioModel/example_ConsPortfolioModel.ipynb
-   ../../examples/GenIncProcessModel/GenIncProcessModel.ipynb
-   ../../examples/LifecycleModel/LifecycleModel.ipynb
-   ../../examples/HowWeSolveIndShockConsumerType/HowWeSolveIndShockConsumerType.ipynb
-   ../../examples/Journeys/Journey-PhD.ipynb
-   ../../examples/ConsNewKeynesianModel/Transition_Matrix_Example.ipynb
-   ../../examples/ConsNewKeynesianModel/Jacobian_Example.ipynb
-   ../../examples/ConsNewKeynesianModel/KS-HARK-presentation.ipynb
-   ../../examples/ConsNewKeynesianModel/SSJ_example.ipynb
+   ../examples/*/*
+   ../examples/*/*/*
 
 .. toctree::
    :hidden: