Skip to main content

A package to create representative microdata for the US.

Project description

PolicyEngine US Data

Installation

While it is possible to install via PyPi:

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.

SSA Data Sources

The following SSA data sources are used in this project:

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:

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

On macOS with Homebrew:

brew install --cask mactex

Building

To build the paper:

make paper

To clean LaTeX build files:

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:

# 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:

cd docs
myst start

Or alternatively from the project root:

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:

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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

policyengine_us_data-1.59.0.tar.gz (50.9 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

policyengine_us_data-1.59.0-py3-none-any.whl (43.8 MB view details)

Uploaded Python 3

File details

Details for the file policyengine_us_data-1.59.0.tar.gz.

File metadata

  • Download URL: policyengine_us_data-1.59.0.tar.gz
  • Upload date:
  • Size: 50.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for policyengine_us_data-1.59.0.tar.gz
Algorithm Hash digest
SHA256 d66d68b9cbf760e799de15ecf92937ee271f910aeb0ab46bfce6a4058e2dde0e
MD5 ff77471f6fb726f68e885a839476b3e3
BLAKE2b-256 8b455cbf1d58db97a4367649d19496f237956b5a56a9f934f1ecff5f0863902b

See more details on using hashes here.

File details

Details for the file policyengine_us_data-1.59.0-py3-none-any.whl.

File metadata

File hashes

Hashes for policyengine_us_data-1.59.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9eaacbd395e4baf22d47072aa785e5813ba2ae6b728d9b4fdf76f825cf42788f
MD5 4af39897df98d15a424d25683531f825
BLAKE2b-256 0f820ae2c52b250097457c8d831c0bf7d12a03c4d7c692e4314e779cf3484ef0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page