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

Uploaded Python 3

File details

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

File metadata

  • Download URL: policyengine_us_data-1.69.3.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.69.3.tar.gz
Algorithm Hash digest
SHA256 7352b03fe5ddd13d624c254f943504488e91d8177ca3016368903703234bc9dd
MD5 cb1a7db52352b4d0d67797466fee944f
BLAKE2b-256 710fdd14e8173cb350b650d90b2556523e0c10da00047e013a11454998d5e2e0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for policyengine_us_data-1.69.3-py3-none-any.whl
Algorithm Hash digest
SHA256 48b2e053b36e087f84a388cc024737e73317a6a0299db77e89ff9547189aaba5
MD5 224c558fc89df336ce9b76f2084162fa
BLAKE2b-256 6d45b74653f3fbd255236514fa93c98e35b1e40f1f9c68df736a9e3a2693f252

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