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.67.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.67.0-py3-none-any.whl (43.9 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: policyengine_us_data-1.67.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.67.0.tar.gz
Algorithm Hash digest
SHA256 476dc225565ef9bc5d1ead251a00db2790b43534cbdd055ec98be555ce833660
MD5 e3e3e03fa7960818d5426cbbff7f594d
BLAKE2b-256 9ba2db4984dc9a3768b87fc013041ca5299b094b82cd09c11aa50c4bf798acc2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for policyengine_us_data-1.67.0-py3-none-any.whl
Algorithm Hash digest
SHA256 681b831493a5df728163710f6f520faf1bf976478d8d010f77598d1f9f73ba11
MD5 031949b6783b01026f05737ff2cd4185
BLAKE2b-256 8a6d0eb15b5f814cf481cfa1c3e245dfa0954211515cbcd1266f6e54137084c2

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