Dorieh Census Pipelines

The census package provides an interface with US Census Data, including the main API, some functionality for working with the TigerWeb API, and the FTP site for Tiger Shapefile Downloads. This package also includes a command line interface to enable quick running of standard workflows.

Introduction

• About

Researchers

• Setting Up Environment
  • Setting up a new environment
  • Updating an existing environment
  • Installing census
  • Setting up Census API Key
  • Registering the Conda Kernal
  • Updating the Environment Recipe
• Quick Start
• Census Variable File Structure
  • Field Definitions
  • Examples
  • Skipping years for a Variable
  • Census Variable Documentation
• Stored Data Files

Developers

• Modules
  • query.py
  • get_census_data()
  • api_geography()
  • assemble_data.py
  • DataPlan
    • DataPlan.assemble_data()
    • DataPlan.get_var_names()
    • DataPlan.add_geoid()
    • DataPlan.adjust_geo_fields()
    • DataPlan.create_missingness()
    • DataPlan.write_data()
    • DataPlan.calculate_densities()
    • DataPlan.interpolate()
    • DataPlan.quality_check()
    • DataPlan.write_schema()
  • VariableDef
    • VariableDef.get_vars()
    • VariableDef.do_query()
    • VariableDef.calculate_var()
  • census_info.py
  • get_endpoint()
  • get_varlist()
  • set_api_key()
  • census_years()
  • tigerweb.py
  • get_area()
  • download_geometry()
  • fst2csv.py
  • CensusContext
    • CensusContext.validate()
  • exceptions.py
  • CensusException
  • utils.py
  • show_api_keys()
• Glossary

Old Doc

• Working with the census Package
  • Running the Command Line Interface
  • Main Python Workflow
  • Shapefile Downloads

Indices and tables

• Index

• Module Index