pyhdfe

An overview of the package, examples, and other documentation can be found on Read the Docs <https://pyhdfe.readthedocs.io/en/stable/>_.

.. docs-start

PyHDFE is a Python 3 implementation of algorithms for absorbing high dimensional fixed effects. This package was created by Jeff Gortmaker <https://jeffgortmaker.com>_ in collaboration with Anya Tarascina <https://anyatarascina.com>_.

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 <https://pyhdfe.readthedocs.io/en/stable/references.html>_ section of the documentation.

Installation

The PyHDFE package has been tested on Python <https://www.python.org/downloads/>_ versions 3.6 through 3.9. The SciPy instructions <https://scipy.org/install/>_ for installing related packages is a good guide for how to install a scientific Python environment. A good choice is the Anaconda Distribution <https://www.anaconda.com/download>, since, along with many other packages that are useful for scientific computing, it comes packaged with PyHDFE's only required dependencies: NumPy <https://numpy.org/> and SciPy <https://scipy.org/>_.

You can install the current release of PyHDFE with pip <https://pip.pypa.io/en/latest/>_::

pip install pyhdfe

You can upgrade to a newer release with the --upgrade flag::

pip install --upgrade pyhdfe

If you lack permissions, you can install PyHDFE in your user directory with the --user flag::

pip install --user pyhdfe

Alternatively, you can download a wheel or source archive from PyPI <https://pypi.org/project/pyhdfe/>. You can find the latest development code on GitHub <https://github.com/jeffgortmaker/pyhdfe/> and the latest development documentation here <https://pyhdfe.readthedocs.io/en/latest/>_.

Bugs and Requests

Please use the GitHub issue tracker <https://github.com/jeffgortmaker/pyhdfe/issues>_ to submit bugs or to request features.