Metadata-Version: 2.4
Name: policyengine_us_data
Version: 1.42.5
Summary: A package to create representative microdata for the US.
Author-email: PolicyEngine <hello@policyengine.org>
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: <3.14.0,>=3.11
Description-Content-Type: text/markdown
Requires-Dist: policyengine-us>=1.350.0
Requires-Dist: policyengine-core>=3.19.0
Requires-Dist: pandas>=2.3.1
Requires-Dist: requests>=2.25.0
Requires-Dist: tqdm>=4.60.0
Requires-Dist: microdf_python>=1.0.0
Requires-Dist: setuptools>=60
Requires-Dist: microimpute>=1.0.1
Requires-Dist: pip-system-certs>=3.0
Requires-Dist: google-cloud-storage>=2.0.0
Requires-Dist: google-auth>=2.0.0
Requires-Dist: scipy>=1.15.3
Requires-Dist: statsmodels>=0.14.5
Requires-Dist: openpyxl>=3.1.5
Requires-Dist: tables>=3.10.2
Requires-Dist: torch>=2.7.1
Requires-Dist: us>=2.0.0
Requires-Dist: sqlalchemy>=2.0.41
Requires-Dist: sqlmodel>=0.0.24
Provides-Extra: dev
Requires-Dist: black; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: quantile-forest; extra == "dev"
Requires-Dist: tabulate; extra == "dev"
Requires-Dist: furo; extra == "dev"
Requires-Dist: jupyter-book; extra == "dev"
Requires-Dist: mystmd; extra == "dev"
Requires-Dist: yaml-changelog>=0.1.7; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: tomli; extra == "dev"
Requires-Dist: itables; extra == "dev"

# PolicyEngine US Data

## Installation

While it is possible to install via PyPi:
```bash
pip install policyengine-us-data
```
the recommended installation is 
```
pip install -e .[dev]
```
which installs the development dependencies in a reference-only manner (so that changes
to the package code will be reflected immediately); `policyengine-us-data` is a dev package
and not intended for direct access.

## Building the Paper

### Prerequisites

The paper requires a LaTeX distribution (e.g., TeXLive or MiKTeX) with the following packages:

- graphicx (for figures)
- amsmath (for mathematical notation)
- natbib (for bibliography management)
- hyperref (for PDF links)
- booktabs (for tables)
- geometry (for page layout)
- microtype (for typography)
- xcolor (for colored links)

On Ubuntu/Debian, you can install these with:

```bash
sudo apt-get install texlive-latex-base texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended
```

On macOS with Homebrew:

```bash
brew install --cask mactex
```

### Building

To build the paper:

```bash
make paper
```

To clean LaTeX build files:

```bash
make clean-paper
```

The output PDF will be at `paper/main.pdf`.

## Building the Documentation

### Prerequisites

The documentation uses Jupyter Book 2 (pre-release) with MyST. To install:

```bash
# Install Jupyter Book 2 pre-release
pip install --pre "jupyter-book==2.*"

# Install MyST CLI
npm install -g mystmd
```

### Building

To build and serve the documentation locally:

```bash
cd docs
myst start
```

Or alternatively from the project root:

```bash
jupyter book start docs
```

Both commands will start a local server at http://localhost:3001 where you can view the documentation.

The legacy Makefile command:

```bash
make documentation
```

Note: The Makefile uses the older `jb` command syntax which may not work with Jupyter Book 2. Use `myst start` or `jupyter book start docs` instead.
