An overview of the package, examples, and other documentation can be found on Read the Docs.
What PyHDFE won't do is provide a convenient interface for running regressions. Instead, the package is meant to be incorporated into statistical projects that would benefit from performant fixed effect absorption. Another goal is facilitating fair comparison of algorithms that have been previously implemented in various languages with different convergence criteria.
Development of the package has been guided by code made publicly available by many researchers and practitioners. For a full list of papers and software cited in this documentation, refer to the references section of the documentation.
The PyHDFE package has been tested on Python versions 3.6 and 3.7. The SciPy instructions for installing related packages is a good guide for how to install a scientific Python environment. A good choice is the Anaconda Distribution, since, along with many other packages that are useful for scientific computing, it comes packaged with PyHDFE's only required dependencies: NumPy and SciPy.
You can install the current release of PyHDFE with pip:
pip install pyhdfe
You can upgrade to a newer release with the
pip install --upgrade pyhdfe
If you lack permissions, you can install PyHDFE in your user directory with the
pip install --user pyhdfe
Bugs and Requests
Please use the GitHub issue tracker to submit bugs or to request features.