Merge 'iworld1991-BayerLuetticke' into BayerLuetticke

.gitignore

@@ -3,6 +3,10 @@ __pycache__/
 *.py[cod]
 *$py.class
 
+# Virtual Environments
+venv/
+econ-ark/
+
 # C extensions
 *.so
 
@@ -262,6 +266,9 @@ Web
 # Emacs automatic backup files
 *~
 
+# Vim swap files
+*.swp
+
 # Autogenerated equations
 eq
 
@@ -272,3 +279,6 @@ eq
 nate-notes/
 
 *_region_*.*
+
+# VSCode 
+settings.json

.travis.yml

@@ -6,4 +6,5 @@ cache: pip
 install:
   - pip install -r requirements.txt
 script:
-  - pytest HARK/tests
+  - pytest
+  # - flake8 HARK

CHANGES.md

@@ -0,0 +1,81 @@
+HARK  
+Version 0.10.1
+Release Notes  
+
+# Introduction
+
+This document contains the release notes for the 0.10.1 version of HARK. HARK aims to produce an open source repository of highly modular, easily interoperable code for solving, simulating, and estimating dynamic economic models with heterogeneous agents.
+
+For more information on HARK, see [our Github organization](https://github.com/econ-ark).
+
+## Changes
+
+### 0.10.1
+
+Release Date: 05-30-2019
+
+No changes from 0.10.0.dev3.
+
+### 0.10.0.dev3
+
+Release Date: 05-18-2019
+
+#### Major Changes
+- Fixes multithreading problems by using Parallels(backend='multiprocessing'). ([287](https://github.com/econ-ark/HARK/pull/287))
+- Fixes bug caused by misapplication of check_conditions. ([284](https://github.com/econ-ark/HARK/pull/284))
+- Adds functions to calculate quadrature nodes and weights for numerically evaluating expectations in the presence of (log-)normally distributed random variables. ([258](https://github.com/econ-ark/HARK/pull/258))
+
+#### Minor Changes
+- Adds method decorator which validates that arguments passed in are not empty. ([282](https://github.com/econ-ark/HARK/pull/282)
+- Lints a variety of files.  These PRs include some additional/related minor changes, like replacing an exec function, removing some lambdas, adding some files to .gitignore, etc. ([274](https://github.com/econ-ark/HARK/pull/274), [276](https://github.com/econ-ark/HARK/pull/276), [277](https://github.com/econ-ark/HARK/pull/277), [278](https://github.com/econ-ark/HARK/pull/278), [281](https://github.com/econ-ark/HARK/pull/281))
+- Adds vim swp files to gitignore. ([269](https://github.com/econ-ark/HARK/pull/269))
+- Adds version dunder in init. ([265](https://github.com/econ-ark/HARK/pull/265))
+- Adds flake8 to requirements.txt and config. ([261](https://github.com/econ-ark/HARK/pull/261))
+- Adds some unit tests for IndShockConsumerType. ([256](https://github.com/econ-ark/HARK/pull/256))
+
+### 0.10.0.dev2
+
+Release Date: 04-18-2019
+
+#### Major Changes
+
+None
+
+#### Minor Changes
+
+* Fix verbosity check in ConsIndShockModel. ([250](https://github.com/econ-ark/HARK/pull/250))
+
+#### Other Changes
+
+None
+
+### 0.10.0.dev1
+
+Release Date: 04-12-2019
+
+#### Major Changes
+
+* Adds [tools](https://github.com/econ-ark/HARK/blob/master/HARK/dcegm.py) to solve problems that arise from the interaction of discrete and continuous variables, using the [DCEGM](https://github.com/econ-ark/DemARK/blob/master/notebooks/DCEGM-Upper-Envelope.ipynb) method of [Iskhakov et al.](https://onlinelibrary.wiley.com/doi/abs/10.3982/QE643), who apply the their discrete-continuous solution algorithm to the problem of optimal endogenous retirement; their results are replicated using our new tool [here](https://github.com/econ-ark/REMARK/blob/master/REMARKs/EndogenousRetirement/Endogenous-Retirement.ipynb). ([226](https://github.com/econ-ark/HARK/pull/226))
+* Parameters of ConsAggShockModel.CobbDouglasEconomy.updateAFunc and ConsAggShockModel.CobbDouglasMarkovEconomy.updateAFunc that govern damping and the number of discarded 'burn-in' periods were previously hardcoded, now proper instance-level parameters. ([244](https://github.com/econ-ark/HARK/pull/244))
+* Improve accuracy and performance of functions for evaluating the integrated value function and conditional choice probabilities for models with extreme value type I taste shocks. ([242](https://github.com/econ-ark/HARK/pull/242))
+* Add calcLogSum, calcChoiceProbs, calcLogSumChoiceProbs to HARK.interpolation. ([209](https://github.com/econ-ark/HARK/pull/209), [217](https://github.com/econ-ark/HARK/pull/217))
+* Create tool to produce an example "template" of a REMARK based on SolvingMicroDSOPs. ([176](https://github.com/econ-ark/HARK/pull/176))
+
+#### Minor Changes
+
+* Moved old utilities tests. ([245](https://github.com/econ-ark/HARK/pull/245))
+* Deleted old files related to "cstwMPCold". ([239](https://github.com/econ-ark/HARK/pull/239))
+* Set numpy floating point error level to ignore. ([238](https://github.com/econ-ark/HARK/pull/238))
+* Fixed miscellaneous imports. ([212](https://github.com/econ-ark/HARK/pull/212), [224](https://github.com/econ-ark/HARK/pull/224), [225](https://github.com/econ-ark/HARK/pull/225))
+* Improve the tests of buffer stock model impatience conditions in IndShockConsumerType. ([219](https://github.com/econ-ark/HARK/pull/219))
+* Add basic support for Travis continuous integration testing. ([208](https://github.com/econ-ark/HARK/pull/208))
+* Add SciPy to requirements.txt. ([207](https://github.com/econ-ark/HARK/pull/207))
+* Fix indexing bug in bilinear interpolation. ([194](https://github.com/econ-ark/HARK/pull/194))
+* Update the build process to handle Python 2 and 3 compatibility. ([172](https://github.com/econ-ark/HARK/pull/172))
+* Add MPCnow attribute to ConsGenIncProcessModel. ([170](https://github.com/econ-ark/HARK/pull/170))
+* All standalone demo files have been removed. The content that was in these files can now be found in similarly named Jupyter notebooks in the DEMARK repository. Some of these notebooks are also linked from econ-ark.org.  ([229](https://github.com/econ-ark/HARK/pull/229), [243](https://github.com/econ-ark/HARK/pull/243))
+
+#### Other Notes
+
+* Not all changes from 0.9.1 may be listed in these release notes.  If you are having trouble addressing a breaking change, please reach out to us.
+

CONTRIBUTING.md

@@ -0,0 +1,38 @@
+# Contributing to Econ-ARK
+
+### Welcome!
+
+Thank you for considering contributing to Econ-ARK!  We're a young project with a small but committed community that's hoping to grow while maintaining our friendly and responsive culture.  Whether you're an economist or a technologist, a writer or a coder, an undergrad or a full professor, a professional or a hobbyist, there's a place for you in the Econ-ARK community. 
+
+We're still creating our contribution infrastructure, so this document is a work in progress.  If you have any questions please feel free to @ or otherwise reach out project manager [Shauna](https://github.com/shaunagm), or lead developers [Chris](https://github.com/llorracc) and [Matt](https://github.com/mnwhite).  If you prefer to connect through email, you can send it to __econ-ark at jhuecon dot org__.
+
+### How to Contribute
+
+We're open to all kinds of contributions, from bug reports to help with our docs to suggestions on how to improve our code.  The best way to figure out if the contribution you'd like to make is something we'd merge or otherwise accept, is to open up an issue in our issue tracker.  Please create an issue rather than immediately submitting pull request, unless the change you'd like to make is so minor you won't mind if the pull request is rejected.  For bigger contributions, we want to proactively talk things through so we don't end up wasting your time.
+
+While we're thrilled to receive all kinds of contributions, there are a few key areas we'd especially like help with:
+
+* porting existing heterogenous agent/agent based models into HARK
+* curating and expanding the collection of projects which use Econ-ARK (which we store in the [remark](https://github.com/econ-ark/REMARK) repository)
+* creating demonstrations of how to use Econ-ARK (which we store in the [DemARK](https://github.com/econ-ark/DemARK) repository)
+* expanding test coverage of our existing code
+
+If you'd like to help with those or any other kind of contribution, reach out to us and we'll help you do so.  
+
+We don't currently have guidelines for opening issues or pull requests, so include as much information as seems relevant to you, and we'll ask you if we need to know more.
+
+### Responding to Issues & Pull Requests
+
+We're trying to get better at managing our open issues and pull requests.  We've created a new set of goals for all issues and pull requests in our Econ-ARK repos:
+
+1. Initial response within one or two days.
+2. Substantive response within two weeks.
+3. Resolution of issue/pull request within three months.  
+
+If you've been waiting on us for more than two weeks for any reason, please feel free to give us a nudge.  Correspondingly, we ask that you respond to any questions or requests from us within two weeks as well, even if it's just to say, "Sorry, I can't get to this for a while yet". If we don't hear back from you, we may close your issue or pull request.  If you want to re-open it, just ask - we're glad to do so.
+
+### Getting Started
+
+The [quick start guide](https://github.com/econ-ark/HARK#ii-quick-start-guide) in our README provides instructions for how to get started running HARK.  This also serves as a setup guide for new contributors.  If you run into any problems, please let us know by opening an issue in the issue tracker.
+
+Thanks again!  We're so glad to have you in our community.