Siege Utilities

Getting Started

  • Getting Started
    • Installation
    • Quick Start: The Composition Chain
      • 1. Geocode an Address
      • 2. Normalize a GEOID
      • 3. Download Census Boundaries
      • 4. Use Pluggable Boundary Providers
      • 5. Set a Project-Wide CRS
    • Engine-Agnostic DataFrames
    • Credential Management
    • Lazy Loading
    • Package Overview
  • Installation Troubleshooting
    • Geospatial Extras and GDAL
      • System Dependencies (only for the two cases above)
    • Choosing the Right Extras
    • Common Errors
  • Library Architecture
    • Strategic Intent
    • Composition Chain
    • Layer Model
    • Package Structure
    • Architectural Decisions
    • Design Tensions (Resolved)

Geospatial (the gravitational center)

  • Geo
    • geo_capabilities()
    • get_default_crs()
    • set_default_crs()
    • reproject_if_needed()
    • detect_crs()
    • distance_to_decimal_degrees()
    • reproject_geom()
    • BoundaryFetchResult
      • BoundaryFetchResult.success
      • BoundaryFetchResult.geodataframe
      • BoundaryFetchResult.error_code
      • BoundaryFetchResult.error_stage
      • BoundaryFetchResult.message
      • BoundaryFetchResult.context
      • BoundaryFetchResult.success
      • BoundaryFetchResult.geodataframe
      • BoundaryFetchResult.error_code
      • BoundaryFetchResult.error_stage
      • BoundaryFetchResult.message
      • BoundaryFetchResult.context
      • BoundaryFetchResult.raise_on_error()
      • BoundaryFetchResult.ok()
      • BoundaryFetchResult.fail()
      • BoundaryFetchResult.__init__()
    • BoundaryRetrievalError
      • BoundaryRetrievalError.__init__()
    • BoundaryInputError
      • BoundaryInputError.__init__()
    • BoundaryDiscoveryError
      • BoundaryDiscoveryError.__init__()
    • BoundaryConfigurationError
      • BoundaryConfigurationError.__init__()
    • BoundaryUrlValidationError
      • BoundaryUrlValidationError.__init__()
    • BoundaryDownloadError
      • BoundaryDownloadError.__init__()
    • BoundaryParseError
      • BoundaryParseError.__init__()
    • BoundaryProvider
      • BoundaryProvider.provider_name
      • BoundaryProvider.get_boundary()
      • BoundaryProvider.list_levels()
      • BoundaryProvider.is_available()
    • CensusTIGERProvider
      • CensusTIGERProvider.provider_name
      • CensusTIGERProvider.get_boundary()
      • CensusTIGERProvider.list_levels()
      • CensusTIGERProvider.is_available()
      • CensusTIGERProvider.list_available_vintages()
      • CensusTIGERProvider.latest_vintage()
    • GADMProvider
      • GADMProvider.__init__()
      • GADMProvider.provider_name
      • GADMProvider.get_boundary()
      • GADMProvider.list_levels()
      • GADMProvider.is_available()
    • RDHProvider
      • RDHProvider.__init__()
      • RDHProvider.provider_name
      • RDHProvider.get_boundary()
      • RDHProvider.list_levels()
      • RDHProvider.is_available()
    • BoundaryFetchError
    • resolve_boundary_provider()
    • CensusDirectoryDiscovery
      • CensusDirectoryDiscovery.__init__()
      • CensusDirectoryDiscovery.get_available_years()
      • CensusDirectoryDiscovery.get_year_directory_contents()
      • CensusDirectoryDiscovery.discover_boundary_types()
      • CensusDirectoryDiscovery.get_year_specific_url_patterns()
      • CensusDirectoryDiscovery.construct_download_url()
      • CensusDirectoryDiscovery.validate_download_url()
      • CensusDirectoryDiscovery.get_optimal_year()
    • CensusDataSource
      • CensusDataSource.__init__()
      • CensusDataSource.get_available_years()
      • CensusDataSource.get_year_directory_contents()
      • CensusDataSource.discover_boundary_types()
      • CensusDataSource.get_geographic_boundaries()
      • CensusDataSource.fetch_geographic_boundaries()
      • CensusDataSource.get_available_boundary_types()
      • CensusDataSource.refresh_discovery_cache()
      • CensusDataSource.get_available_state_fips()
      • CensusDataSource.get_state_abbreviations()
      • CensusDataSource.normalize_state_identifier()
      • CensusDataSource.get_comprehensive_state_info()
      • CensusDataSource.get_state_by_abbreviation()
      • CensusDataSource.get_state_by_name()
      • CensusDataSource.validate_state_fips()
      • CensusDataSource.get_state_name()
      • CensusDataSource.get_state_abbreviation()
    • SpatialDataSource
      • SpatialDataSource.__init__()
      • SpatialDataSource.download_data()
    • GovernmentDataSource
      • GovernmentDataSource.__init__()
      • GovernmentDataSource.download_dataset()
    • OpenStreetMapDataSource
      • OpenStreetMapDataSource.__init__()
      • OpenStreetMapDataSource.download_osm_data()
    • get_census_boundaries()
    • download_data()
    • normalize_state_identifier()
    • get_state_by_abbreviation()
    • get_state_by_name()
    • discover_boundary_types()
    • get_census_data()
    • download_osm_data()
    • get_available_years()
    • get_year_directory_contents()
    • construct_download_url()
    • validate_download_url()
    • get_optimal_year()
    • get_geographic_boundaries()
    • fetch_geographic_boundaries()
    • get_available_boundary_types()
    • refresh_discovery_cache()
    • get_available_state_fips()
    • get_state_abbreviations()
    • get_comprehensive_state_info()
    • validate_state_fips()
    • get_state_name()
    • get_state_abbreviation()
    • download_dataset()
    • get_unified_fips_data()
    • normalize_state_identifier_standalone()
    • normalize_state_input()
    • normalize_state_name()
    • normalize_state_abbreviation()
    • normalize_fips_code()
    • CensusDatasetMapper
      • CensusDatasetMapper.__init__()
      • CensusDatasetMapper.get_dataset_info()
      • CensusDatasetMapper.list_datasets_by_type()
      • CensusDatasetMapper.list_datasets_by_geography()
      • CensusDatasetMapper.get_best_dataset_for_use_case()
      • CensusDatasetMapper.get_dataset_relationships()
      • CensusDatasetMapper.compare_datasets()
      • CensusDatasetMapper.get_data_selection_guide()
      • CensusDatasetMapper.export_dataset_catalog()
    • SurveyType
      • SurveyType.DECENNIAL
      • SurveyType.ACS_1YR
      • SurveyType.ACS_3YR
      • SurveyType.ACS_5YR
      • SurveyType.CENSUS_BUSINESS
      • SurveyType.POPULATION_ESTIMATES
      • SurveyType.HOUSING_ESTIMATES
    • GeographyLevel
      • GeographyLevel.NATION
      • GeographyLevel.REGION
      • GeographyLevel.DIVISION
      • GeographyLevel.STATE
      • GeographyLevel.COUNTY
      • GeographyLevel.COUSUB
      • GeographyLevel.PLACE
      • GeographyLevel.CD
      • GeographyLevel.SLDU
      • GeographyLevel.SLDL
      • GeographyLevel.TRACT
      • GeographyLevel.BLOCK_GROUP
      • GeographyLevel.BLOCK
      • GeographyLevel.ZCTA
      • GeographyLevel.CBSA
      • GeographyLevel.PUMA
      • GeographyLevel.VTD
      • GeographyLevel.VTD20
      • GeographyLevel.TABBLOCK20
      • GeographyLevel.TABBLOCK10
      • GeographyLevel.COUNTY_SUBDIVISION
      • GeographyLevel.CONGRESSIONAL_DISTRICT
      • GeographyLevel.STATE_LEGISLATIVE_DISTRICT
      • GeographyLevel.ZIP_CODE
      • GeographyLevel.VOTING_DISTRICT
    • DataReliability
      • DataReliability.HIGH
      • DataReliability.MEDIUM
      • DataReliability.LOW
      • DataReliability.ESTIMATED
    • CensusDataset
      • CensusDataset.dataset_id
      • CensusDataset.name
      • CensusDataset.survey_type
      • CensusDataset.geography_levels
      • CensusDataset.time_period
      • CensusDataset.reliability
      • CensusDataset.description
      • CensusDataset.variables
      • CensusDataset.limitations
      • CensusDataset.best_for
      • CensusDataset.alternatives
      • CensusDataset.data_quality_notes
      • CensusDataset.last_updated
      • CensusDataset.next_update
      • CensusDataset.api_endpoint
      • CensusDataset.download_url
      • CensusDataset.__init__()
    • DatasetRelationship
      • DatasetRelationship.primary_dataset
      • DatasetRelationship.related_dataset
      • DatasetRelationship.relationship_type
      • DatasetRelationship.description
      • DatasetRelationship.when_to_use_primary
      • DatasetRelationship.when_to_use_related
      • DatasetRelationship.overlap_period
      • DatasetRelationship.compatibility_score
      • DatasetRelationship.__init__()
    • get_census_dataset_mapper()
    • get_best_dataset_for_analysis()
    • compare_census_datasets()
    • get_dataset_info()
    • list_datasets_by_type()
    • list_datasets_by_geography()
    • get_best_dataset_for_use_case()
    • get_dataset_relationships()
    • compare_datasets()
    • get_data_selection_guide()
    • export_dataset_catalog()
    • CensusDataSelector
      • CensusDataSelector.__init__()
      • CensusDataSelector.select_datasets_for_analysis()
      • CensusDataSelector.get_dataset_compatibility_matrix()
      • CensusDataSelector.suggest_analysis_approach()
    • get_census_data_selector()
    • select_census_datasets()
    • select_datasets_for_analysis()
    • get_dataset_compatibility_matrix()
    • get_analysis_approach()
    • suggest_analysis_approach()
    • SpatialDataTransformer
      • SpatialDataTransformer.__init__()
      • SpatialDataTransformer.convert_format()
    • SWMapsArchive
      • SWMapsArchive.__init__()
      • SWMapsArchive.db_path
      • SWMapsArchive.close()
    • open_swmaps()
    • read_features()
    • find_vector_dataset_file_in_directory()
    • concatenate_addresses()
    • use_nominatim_geocoder()
    • NominatimGeoClassifier
      • NominatimGeoClassifier.__init__()
      • NominatimGeoClassifier.get_place_ranks_by_label()
      • NominatimGeoClassifier.get_importance_threshold_by_label()
      • NominatimGeoClassifier.to_json()
      • NominatimGeoClassifier.from_json()
    • get_country_name()
    • get_country_code()
    • list_countries()
    • get_coordinates()
    • geocode_with_nominatim_public()
    • geocode_addresses_with_nominatim()
    • GeocodingError
    • validate_geocode_data_pandas()
    • mark_valid_geocode_data_pandas()
    • IsochroneError
    • IsochroneNetworkError
    • IsochroneProviderError
    • IsochroneRequest
      • IsochroneRequest.provider
      • IsochroneRequest.method
      • IsochroneRequest.url
      • IsochroneRequest.headers
      • IsochroneRequest.params
      • IsochroneRequest.json
    • IsochroneProvider
      • IsochroneProvider.fetch()
      • IsochroneProvider.validate_config()
      • IsochroneProvider.provider_name
    • OpenRouteServiceProvider
      • OpenRouteServiceProvider.__init__()
      • OpenRouteServiceProvider.provider_name
      • OpenRouteServiceProvider.validate_config()
      • OpenRouteServiceProvider.fetch()
    • ValhallaProvider
      • ValhallaProvider.__init__()
      • ValhallaProvider.provider_name
      • ValhallaProvider.validate_config()
      • ValhallaProvider.fetch()
    • build_isochrone_request()
    • get_isochrone()
    • isochrone_to_geodataframe()
    • get_provider()
    • CensusGeocodeError
    • CensusVintage
      • CensusVintage.CENSUS_2010
      • CensusVintage.CENSUS_2020
      • CensusVintage.CURRENT
      • CensusVintage.ACS_2022
      • CensusVintage.ACS_2023
      • CensusVintage.benchmark
      • CensusVintage.vintage
      • CensusVintage.__new__()
    • CensusGeocodeResult
      • CensusGeocodeResult.matched
      • CensusGeocodeResult.input_address
      • CensusGeocodeResult.matched_address
      • CensusGeocodeResult.lat
      • CensusGeocodeResult.lon
      • CensusGeocodeResult.state_fips
      • CensusGeocodeResult.county_fips
      • CensusGeocodeResult.tract
      • CensusGeocodeResult.block
      • CensusGeocodeResult.match_type
      • CensusGeocodeResult.side
      • CensusGeocodeResult.tiger_line_id
      • CensusGeocodeResult.matched
      • CensusGeocodeResult.input_address
      • CensusGeocodeResult.matched_address
      • CensusGeocodeResult.lat
      • CensusGeocodeResult.lon
      • CensusGeocodeResult.state_fips
      • CensusGeocodeResult.county_fips
      • CensusGeocodeResult.tract
      • CensusGeocodeResult.block
      • CensusGeocodeResult.match_type
      • CensusGeocodeResult.side
      • CensusGeocodeResult.tiger_line_id
      • CensusGeocodeResult.input_id
      • CensusGeocodeResult.state_geoid
      • CensusGeocodeResult.county_geoid
      • CensusGeocodeResult.tract_geoid
      • CensusGeocodeResult.block_geoid
      • CensusGeocodeResult.block_group_geoid
      • CensusGeocodeResult.__init__()
    • select_vintage_for_cycle()
    • geocode_single()
    • geocode_batch()
    • geocode_batch_chunked()
    • geocode_results_to_dataframe()
    • is_valid_state_fips()
    • is_valid_county_fips()
    • is_valid_tract_geoid()
    • is_valid_block_group_geoid()
    • resolve_geographic_level()
    • LocaleCode
      • LocaleCode.code
      • LocaleCode.category
      • LocaleCode.subcategory
      • LocaleCode.label
      • LocaleCode.code
      • LocaleCode.category
      • LocaleCode.subcategory
      • LocaleCode.label
      • LocaleCode.from_code()
      • LocaleCode.__init__()
    • LocaleType
      • LocaleType.CITY
      • LocaleType.SUBURB
      • LocaleType.TOWN
      • LocaleType.RURAL
      • LocaleType.__new__()
    • NCESLocaleClassifier
      • NCESLocaleClassifier.__init__()
      • NCESLocaleClassifier.locale_index
      • NCESLocaleClassifier.classify_geoid()
      • NCESLocaleClassifier.classify_geoid_or_point()
      • NCESLocaleClassifier.classify_point()
      • NCESLocaleClassifier.classify_points()
      • NCESLocaleClassifier.classify_polygon()
      • NCESLocaleClassifier.classify_polygons()
      • NCESLocaleClassifier.from_census_year()
      • NCESLocaleClassifier.from_nces_boundaries()
      • NCESLocaleClassifier.locale_label()
    • locale_from_code()
    • NCESDownloader
      • NCESDownloader.__init__()
      • NCESDownloader.download_locale_boundaries()
      • NCESDownloader.download_school_locations()
      • NCESDownloader.download_district_data()
    • NCESDownloadError
    • Gazetteer
      • Gazetteer.provider_name
      • Gazetteer.lookup()
      • Gazetteer.search()
      • Gazetteer.is_available()
      • Gazetteer.__init__()
    • GazetteerResult
      • GazetteerResult.name
      • GazetteerResult.canonical_path
      • GazetteerResult.geometry
      • GazetteerResult.centroid
      • GazetteerResult.country
      • GazetteerResult.admin_levels
      • GazetteerResult.source
      • GazetteerResult.raw
      • GazetteerResult.name
      • GazetteerResult.canonical_path
      • GazetteerResult.geometry
      • GazetteerResult.centroid
      • GazetteerResult.country
      • GazetteerResult.admin_levels
      • GazetteerResult.source
      • GazetteerResult.raw
      • GazetteerResult.__init__()
    • GazetteerCandidate
      • GazetteerCandidate.name
      • GazetteerCandidate.canonical_path
      • GazetteerCandidate.country
      • GazetteerCandidate.admin_levels
      • GazetteerCandidate.score
      • GazetteerCandidate.source
      • GazetteerCandidate.__init__()
    • GazetteerError
    • GazetteerNotFoundError
    • GazetteerAmbiguousError
      • GazetteerAmbiguousError.__init__()
    • GazetteerBackendError
    • resolve_gazetteer()
    • EtterError
    • EtterParseError
    • EtterLowConfidenceError
    • EtterFilter
      • EtterFilter.original_query
      • EtterFilter.spatial_relation
      • EtterFilter.reference_location
      • EtterFilter.buffer_distance_m
      • EtterFilter.confidence
      • EtterFilter.raw
      • EtterFilter.original_query
      • EtterFilter.spatial_relation
      • EtterFilter.reference_location
      • EtterFilter.buffer_distance_m
      • EtterFilter.confidence
      • EtterFilter.raw
      • EtterFilter.from_geoquery()
      • EtterFilter.__init__()
    • EtterParser
      • EtterParser.__init__()
      • EtterParser.parse()
    • default_llm()
    • RelationSemantics
      • RelationSemantics.BOUNDED
      • RelationSemantics.HALFPLANE
      • RelationSemantics.CONTAINS_CENTROID
      • RelationSemantics.__new__()
    • EtterGeometryResult
      • EtterGeometryResult.geometry
      • EtterGeometryResult.relation
      • EtterGeometryResult.reference
      • EtterGeometryResult.buffer_km
      • EtterGeometryResult.semantics
      • EtterGeometryResult.notes
      • EtterGeometryResult.geometry
      • EtterGeometryResult.relation
      • EtterGeometryResult.reference
      • EtterGeometryResult.buffer_km
      • EtterGeometryResult.semantics
      • EtterGeometryResult.notes
      • EtterGeometryResult.__init__()
    • EtterToGeometryError
    • EtterReferenceNotFoundError
    • EtterUnknownRelationError
    • etter_to_geometry()
    • SpatialLoaderPlan
      • SpatialLoaderPlan.primary_loader
      • SpatialLoaderPlan.loader_order
      • SpatialLoaderPlan.reason
      • SpatialLoaderPlan.__init__()
    • select_spatial_loader()
    • build_census_table_name()
    • build_census_ingest_targets()
    • SpatialRuntimePlan
      • SpatialRuntimePlan.runtime
      • SpatialRuntimePlan.native_spatial_available
      • SpatialRuntimePlan.sedona_available
      • SpatialRuntimePlan.loader_order
      • SpatialRuntimePlan.reason
      • SpatialRuntimePlan.__init__()
    • resolve_spatial_runtime_plan()
    • GeometryPayload
      • GeometryPayload.geometry_wkt
      • GeometryPayload.geometry_wkb
      • GeometryPayload.geometry_geojson
      • GeometryPayload.crs
      • GeometryPayload.geometry_type
      • GeometryPayload.__init__()
    • encode_geometry()
    • decode_geometry()
    • payload_to_spark_row()
    • spark_row_to_payload()
    • s2_index_points()
    • s2_index_polygon()
    • s2_region_cover()
    • s2_spatial_join()
    • s2_cell_to_boundary()
    • s2_level_for_area()
    • s2_level_for_admin_level()
    • s2_kring()
    • s2_distance()
    • s2_parent()
    • s2_children()
    • s2_cell_id_to_uint64()
    • s2_uint64_to_cell_id()
    • s2_cell_id_to_token()
    • s2_token_to_cell_id()
    • s2_bbox_to_cells()
    • s2_cells_to_ranges()
    • index_points()
    • index_polygon()
    • infer_grid()
    • PlanAuthority
      • PlanAuthority.LEGISLATURE
      • PlanAuthority.COURT
      • PlanAuthority.COMMISSION
      • PlanAuthority.DEFAULT
      • PlanAuthority.__new__()
    • PlanDistrict
      • PlanDistrict.state_fips
      • PlanDistrict.district_type
      • PlanDistrict.district_id
      • PlanDistrict.plan_name
      • PlanDistrict.authority
      • PlanDistrict.effective_from
      • PlanDistrict.effective_to
      • PlanDistrict.geometry_source
      • PlanDistrict.notes
      • PlanDistrict.state_fips
      • PlanDistrict.district_type
      • PlanDistrict.district_id
      • PlanDistrict.plan_name
      • PlanDistrict.authority
      • PlanDistrict.effective_from
      • PlanDistrict.effective_to
      • PlanDistrict.geometry_source
      • PlanDistrict.notes
      • PlanDistrict.covers_date()
      • PlanDistrict.__init__()
    • RedistrictingPlan
      • RedistrictingPlan.plan_name
      • RedistrictingPlan.state_fips
      • RedistrictingPlan.district_type
      • RedistrictingPlan.authority
      • RedistrictingPlan.effective_from
      • RedistrictingPlan.effective_to
      • RedistrictingPlan.districts
      • RedistrictingPlan.metadata
      • RedistrictingPlan.plan_name
      • RedistrictingPlan.state_fips
      • RedistrictingPlan.district_type
      • RedistrictingPlan.authority
      • RedistrictingPlan.effective_from
      • RedistrictingPlan.effective_to
      • RedistrictingPlan.districts
      • RedistrictingPlan.metadata
      • RedistrictingPlan.covers_date()
      • RedistrictingPlan.district()
      • RedistrictingPlan.__init__()
    • PlanRegistry
      • PlanRegistry.__init__()
      • PlanRegistry.register_plan()
      • PlanRegistry.register_plans()
      • PlanRegistry.clear()
      • PlanRegistry.plans_for_state()
      • PlanRegistry.resolve_plan_at_date()
      • PlanRegistry.resolve_district_at_date()
    • PlanResolutionError
    • PlanOverlapError
    • get_default_plan_registry()
    • detect_format()
    • extract_attributes_ogr()
    • extract_attributes_kml()
    • extract_attributes_swmaps()
    • TemporalDataStore
      • TemporalDataStore.SUPPORTED_FORMATS
      • TemporalDataStore.__init__()
      • TemporalDataStore.save_boundaries()
      • TemporalDataStore.load_boundaries()
      • TemporalDataStore.query_boundaries_at_date()
      • TemporalDataStore.list_available_vintages()
      • TemporalDataStore.save_demographics()
      • TemporalDataStore.load_demographics()
      • TemporalDataStore.save_timeseries()
      • TemporalDataStore.load_timeseries()
    • get_temporal_store()
    • save_boundaries()
    • load_boundaries()
    • query_boundaries_at_date()
    • save_demographics()
    • load_demographics()
    • spatial_query()
    • temporal_filter()
    • point_in_boundary()
    • Core Spatial Modules
      • SpatialDataError
      • SpatialDataSource
        • SpatialDataSource.__init__()
        • SpatialDataSource.download_data()
      • CensusDataSource
        • CensusDataSource.__init__()
        • CensusDataSource.get_available_years()
        • CensusDataSource.get_year_directory_contents()
        • CensusDataSource.discover_boundary_types()
        • CensusDataSource.get_geographic_boundaries()
        • CensusDataSource.fetch_geographic_boundaries()
        • CensusDataSource.get_available_boundary_types()
        • CensusDataSource.refresh_discovery_cache()
        • CensusDataSource.get_available_state_fips()
        • CensusDataSource.get_state_abbreviations()
        • CensusDataSource.normalize_state_identifier()
        • CensusDataSource.get_comprehensive_state_info()
        • CensusDataSource.get_state_by_abbreviation()
        • CensusDataSource.get_state_by_name()
        • CensusDataSource.validate_state_fips()
        • CensusDataSource.get_state_name()
        • CensusDataSource.get_state_abbreviation()
      • GovernmentDataSource
        • GovernmentDataSource.__init__()
        • GovernmentDataSource.download_dataset()
      • OpenStreetMapDataSource
        • OpenStreetMapDataSource.__init__()
        • OpenStreetMapDataSource.download_osm_data()
      • CensusDirectoryDiscovery
        • CensusDirectoryDiscovery.__init__()
        • CensusDirectoryDiscovery.get_available_years()
        • CensusDirectoryDiscovery.get_year_directory_contents()
        • CensusDirectoryDiscovery.discover_boundary_types()
        • CensusDirectoryDiscovery.get_year_specific_url_patterns()
        • CensusDirectoryDiscovery.construct_download_url()
        • CensusDirectoryDiscovery.validate_download_url()
        • CensusDirectoryDiscovery.get_optimal_year()
      • get_census_data()
      • get_census_boundaries()
      • get_available_years()
      • get_year_directory_contents()
      • discover_boundary_types()
      • download_data()
      • download_dataset()
      • get_geographic_boundaries()
      • fetch_geographic_boundaries()
      • load_census_inventory()
      • update_census_inventory()
      • refresh_discovery_cache()
      • construct_download_url()
      • validate_download_url()
      • get_optimal_year()
      • get_available_boundary_types()
      • normalize_state_identifier()
      • normalize_state_identifier_standalone()
      • normalize_state_input()
      • normalize_state_name()
      • normalize_state_abbreviation()
      • normalize_fips_code()
      • get_state_by_abbreviation()
      • get_state_by_name()
      • get_state_name()
      • get_state_abbreviation()
      • get_state_abbreviations()
      • get_available_state_fips()
      • get_unified_fips_data()
      • get_comprehensive_state_info()
      • validate_state_fips()
      • download_osm_data()
      • SpatialQueryError
      • SpatialDataTransformer
        • SpatialDataTransformer.__init__()
        • SpatialDataTransformer.convert_format()
      • PostGISConnector
        • PostGISConnector.__init__()
        • PostGISConnector.close()
        • PostGISConnector.upload_spatial_data()
        • PostGISConnector.download_spatial_data()
        • PostGISConnector.execute_spatial_query()
      • DuckDBConnector
        • DuckDBConnector.__init__()
        • DuckDBConnector.connect()
        • DuckDBConnector.close()
        • DuckDBConnector.upload_spatial_data()
        • DuckDBConnector.download_spatial_data()
        • DuckDBConnector.execute_spatial_query()
      • convert_spatial_format()
      • upload_to_postgis()
      • download_from_postgis()
      • execute_postgis_query()
      • upload_to_duckdb()
      • download_from_duckdb()
      • execute_duckdb_query()
      • SpatialRuntimePlan
        • SpatialRuntimePlan.runtime
        • SpatialRuntimePlan.native_spatial_available
        • SpatialRuntimePlan.sedona_available
        • SpatialRuntimePlan.loader_order
        • SpatialRuntimePlan.reason
        • SpatialRuntimePlan.__init__()
      • resolve_spatial_runtime_plan()
      • GeometryPayload
        • GeometryPayload.geometry_wkt
        • GeometryPayload.geometry_wkb
        • GeometryPayload.geometry_geojson
        • GeometryPayload.crs
        • GeometryPayload.geometry_type
        • GeometryPayload.__init__()
      • encode_geometry()
      • decode_geometry()
      • payload_to_spark_row()
      • spark_row_to_payload()
      • get_default_crs()
      • set_default_crs()
      • reproject_if_needed()
      • detect_crs()
      • distance_to_decimal_degrees()
      • reproject_geom()
      • GEOIDValidator
        • GEOIDValidator.__init__()
        • GEOIDValidator.deconstruct()
      • normalize_geoid()
      • normalize_geoid_column()
      • construct_geoid()
      • construct_geoid_from_row()
      • parse_geoid()
      • extract_parent_geoid()
      • validate_geoid()
      • can_normalize_geoid()
      • validate_geoid_column()
      • prepare_geoid_for_join()
      • geoid_to_slug()
      • slug_to_geoid()
      • find_geoid_column()
      • GeocodingError
      • get_country_name()
      • get_country_code()
      • list_countries()
      • concatenate_addresses()
      • get_coordinates()
      • use_nominatim_geocoder()
      • geocode_with_nominatim_public()
      • geocode_addresses_with_nominatim()
      • NominatimGeoClassifier
        • NominatimGeoClassifier.__init__()
        • NominatimGeoClassifier.get_place_ranks_by_label()
        • NominatimGeoClassifier.get_importance_threshold_by_label()
        • NominatimGeoClassifier.to_json()
        • NominatimGeoClassifier.from_json()
      • validate_geocode_data_pandas()
      • mark_valid_geocode_data_pandas()
      • SpatiaLiteCache
        • SpatiaLiteCache.__init__()
        • SpatiaLiteCache.put_geocode()
        • SpatiaLiteCache.get_geocode()
        • SpatiaLiteCache.get_geocode_or_fetch()
        • SpatiaLiteCache.get_geocodes_in_bbox()
        • SpatiaLiteCache.put_boundary()
        • SpatiaLiteCache.get_boundary()
        • SpatiaLiteCache.put_crosswalk()
        • SpatiaLiteCache.get_crosswalk()
        • SpatiaLiteCache.stats()
        • SpatiaLiteCache.clear()
        • SpatiaLiteCache.close()
      • Grid
      • index_points()
      • index_polygon()
      • infer_grid()
      • h3_hex_to_boundary()
      • h3_index_points()
      • h3_index_polygon()
      • h3_resolution_for_admin_level()
      • h3_resolution_for_area()
      • h3_spatial_join()
      • Why both
      • Polygon coverage limitation
      • s2_index_points()
      • s2_index_polygon()
      • s2_region_cover()
      • s2_spatial_join()
      • s2_cell_to_boundary()
      • s2_level_for_area()
      • s2_level_for_admin_level()
      • s2_kring()
      • s2_distance()
      • s2_parent()
      • s2_children()
      • s2_cell_id_to_uint64()
      • s2_uint64_to_cell_id()
      • s2_cell_id_to_token()
      • s2_token_to_cell_id()
      • s2_bbox_to_cells()
      • s2_cells_to_ranges()
      • IsochroneError
      • IsochroneNetworkError
      • IsochroneProvider
        • IsochroneProvider.fetch()
        • IsochroneProvider.validate_config()
        • IsochroneProvider.provider_name
      • IsochroneProviderError
      • IsochroneRequest
        • IsochroneRequest.provider
        • IsochroneRequest.method
        • IsochroneRequest.url
        • IsochroneRequest.headers
        • IsochroneRequest.params
        • IsochroneRequest.json
      • OpenRouteServiceProvider
        • OpenRouteServiceProvider.__init__()
        • OpenRouteServiceProvider.provider_name
        • OpenRouteServiceProvider.validate_config()
        • OpenRouteServiceProvider.fetch()
      • ValhallaProvider
        • ValhallaProvider.__init__()
        • ValhallaProvider.provider_name
        • ValhallaProvider.validate_config()
        • ValhallaProvider.fetch()
      • build_isochrone_request()
      • get_isochrone()
      • get_provider()
      • isochrone_to_geodataframe()
      • BlockGroupGEOIDValidator
        • BlockGroupGEOIDValidator.message
        • BlockGroupGEOIDValidator.code
      • CountyFIPSValidator
        • CountyFIPSValidator.message
        • CountyFIPSValidator.code
      • StateFIPSValidator
        • StateFIPSValidator.message
        • StateFIPSValidator.code
      • TractGEOIDValidator
        • TractGEOIDValidator.message
        • TractGEOIDValidator.code
      • is_valid_block_group_geoid()
      • is_valid_county_fips()
      • is_valid_state_fips()
      • is_valid_tract_geoid()
      • LocaleCode
        • LocaleCode.code
        • LocaleCode.category
        • LocaleCode.subcategory
        • LocaleCode.label
        • LocaleCode.code
        • LocaleCode.category
        • LocaleCode.subcategory
        • LocaleCode.label
        • LocaleCode.from_code()
        • LocaleCode.__init__()
      • LocaleIndex
        • LocaleIndex.__init__()
        • LocaleIndex.add()
        • LocaleIndex.add_bulk()
        • LocaleIndex.get()
        • LocaleIndex.from_dataframe()
      • LocaleType
        • LocaleType.CITY
        • LocaleType.SUBURB
        • LocaleType.TOWN
        • LocaleType.RURAL
        • LocaleType.__new__()
      • NCESLocaleClassifier
        • NCESLocaleClassifier.__init__()
        • NCESLocaleClassifier.locale_index
        • NCESLocaleClassifier.classify_geoid()
        • NCESLocaleClassifier.classify_geoid_or_point()
        • NCESLocaleClassifier.classify_point()
        • NCESLocaleClassifier.classify_points()
        • NCESLocaleClassifier.classify_polygon()
        • NCESLocaleClassifier.classify_polygons()
        • NCESLocaleClassifier.from_census_year()
        • NCESLocaleClassifier.from_nces_boundaries()
        • NCESLocaleClassifier.locale_label()
      • locale_from_code()
      • geo_capabilities()
    • Boundaries and Providers
      • BoundaryFetchError
      • BoundaryProvider
        • BoundaryProvider.provider_name
        • BoundaryProvider.get_boundary()
        • BoundaryProvider.list_levels()
        • BoundaryProvider.is_available()
      • CensusTIGERProvider
        • CensusTIGERProvider.provider_name
        • CensusTIGERProvider.get_boundary()
        • CensusTIGERProvider.list_levels()
        • CensusTIGERProvider.is_available()
        • CensusTIGERProvider.list_available_vintages()
        • CensusTIGERProvider.latest_vintage()
      • GADMProvider
        • GADMProvider.__init__()
        • GADMProvider.provider_name
        • GADMProvider.get_boundary()
        • GADMProvider.list_levels()
        • GADMProvider.is_available()
      • RDHProvider
        • RDHProvider.__init__()
        • RDHProvider.provider_name
        • RDHProvider.get_boundary()
        • RDHProvider.list_levels()
        • RDHProvider.is_available()
      • resolve_boundary_provider()
      • BoundaryConfigurationError
        • BoundaryConfigurationError.__init__()
      • BoundaryDiscoveryError
        • BoundaryDiscoveryError.__init__()
      • BoundaryDownloadError
        • BoundaryDownloadError.__init__()
      • BoundaryFetchResult
        • BoundaryFetchResult.success
        • BoundaryFetchResult.geodataframe
        • BoundaryFetchResult.error_code
        • BoundaryFetchResult.error_stage
        • BoundaryFetchResult.message
        • BoundaryFetchResult.context
        • BoundaryFetchResult.success
        • BoundaryFetchResult.geodataframe
        • BoundaryFetchResult.error_code
        • BoundaryFetchResult.error_stage
        • BoundaryFetchResult.message
        • BoundaryFetchResult.context
        • BoundaryFetchResult.raise_on_error()
        • BoundaryFetchResult.ok()
        • BoundaryFetchResult.fail()
        • BoundaryFetchResult.__init__()
      • BoundaryInputError
        • BoundaryInputError.__init__()
      • BoundaryParseError
        • BoundaryParseError.__init__()
      • BoundaryRetrievalError
        • BoundaryRetrievalError.__init__()
      • BoundaryUrlValidationError
        • BoundaryUrlValidationError.__init__()
      • load_census_boundaries()
      • load_gadm_boundaries()
      • load_rdh_boundaries()
      • stage_census_boundaries()
      • BoundaryFetchError
      • BoundaryProvider
        • BoundaryProvider.provider_name
        • BoundaryProvider.get_boundary()
        • BoundaryProvider.list_levels()
        • BoundaryProvider.is_available()
      • CensusTIGERProvider
        • CensusTIGERProvider.provider_name
        • CensusTIGERProvider.get_boundary()
        • CensusTIGERProvider.list_levels()
        • CensusTIGERProvider.is_available()
        • CensusTIGERProvider.list_available_vintages()
        • CensusTIGERProvider.latest_vintage()
      • GADMProvider
        • GADMProvider.__init__()
        • GADMProvider.provider_name
        • GADMProvider.get_boundary()
        • GADMProvider.list_levels()
        • GADMProvider.is_available()
      • RDHProvider
        • RDHProvider.__init__()
        • RDHProvider.provider_name
        • RDHProvider.get_boundary()
        • RDHProvider.list_levels()
        • RDHProvider.is_available()
      • resolve_boundary_provider()
      • CensusGeocodeError
      • CensusGeocodeResult
        • CensusGeocodeResult.matched
        • CensusGeocodeResult.input_address
        • CensusGeocodeResult.matched_address
        • CensusGeocodeResult.lat
        • CensusGeocodeResult.lon
        • CensusGeocodeResult.state_fips
        • CensusGeocodeResult.county_fips
        • CensusGeocodeResult.tract
        • CensusGeocodeResult.block
        • CensusGeocodeResult.match_type
        • CensusGeocodeResult.side
        • CensusGeocodeResult.tiger_line_id
        • CensusGeocodeResult.matched
        • CensusGeocodeResult.input_address
        • CensusGeocodeResult.matched_address
        • CensusGeocodeResult.lat
        • CensusGeocodeResult.lon
        • CensusGeocodeResult.state_fips
        • CensusGeocodeResult.county_fips
        • CensusGeocodeResult.tract
        • CensusGeocodeResult.block
        • CensusGeocodeResult.match_type
        • CensusGeocodeResult.side
        • CensusGeocodeResult.tiger_line_id
        • CensusGeocodeResult.input_id
        • CensusGeocodeResult.state_geoid
        • CensusGeocodeResult.county_geoid
        • CensusGeocodeResult.tract_geoid
        • CensusGeocodeResult.block_geoid
        • CensusGeocodeResult.block_group_geoid
        • CensusGeocodeResult.__init__()
      • CensusVintage
        • CensusVintage.CENSUS_2010
        • CensusVintage.CENSUS_2020
        • CensusVintage.CURRENT
        • CensusVintage.ACS_2022
        • CensusVintage.ACS_2023
        • CensusVintage.benchmark
        • CensusVintage.vintage
        • CensusVintage.__new__()
      • geocode_batch()
      • geocode_batch_chunked()
      • geocode_results_to_dataframe()
      • geocode_single()
      • select_vintage_for_cycle()
      • CompositeBatchGeocoder
        • CompositeBatchGeocoder.__init__()
        • CompositeBatchGeocoder.backend_name
        • CompositeBatchGeocoder.geocode()
      • AddressInput
        • AddressInput.street
        • AddressInput.city
        • AddressInput.state
        • AddressInput.zipcode
        • AddressInput.input_id
        • AddressInput.one_line
        • AddressInput.__init__()
      • BatchGeocoder
        • BatchGeocoder.backend_name
        • BatchGeocoder.geocode()
        • BatchGeocoder.is_available()
      • BatchGeocodingResult
        • BatchGeocodingResult.results
        • BatchGeocodingResult.backend
        • BatchGeocodingResult.errors
        • BatchGeocodingResult.total
        • BatchGeocodingResult.matched_count
        • BatchGeocodingResult.match_rate
        • BatchGeocodingResult.to_dataframe()
        • BatchGeocodingResult.to_geodataframe()
        • BatchGeocodingResult.__init__()
      • GeocodingResult
        • GeocodingResult.input_address
        • GeocodingResult.input_id
        • GeocodingResult.matched_address
        • GeocodingResult.lat
        • GeocodingResult.lon
        • GeocodingResult.match_quality
        • GeocodingResult.block_geoid
        • GeocodingResult.tract_geoid
        • GeocodingResult.county_geoid
        • GeocodingResult.state_geoid
        • GeocodingResult.backend
        • GeocodingResult.input_address
        • GeocodingResult.input_id
        • GeocodingResult.matched_address
        • GeocodingResult.lat
        • GeocodingResult.lon
        • GeocodingResult.match_quality
        • GeocodingResult.block_geoid
        • GeocodingResult.tract_geoid
        • GeocodingResult.county_geoid
        • GeocodingResult.state_geoid
        • GeocodingResult.backend
        • GeocodingResult.matched
        • GeocodingResult.has_block
        • GeocodingResult.has_tract
        • GeocodingResult.to_dict()
        • GeocodingResult.__init__()
      • MatchQuality
        • MatchQuality.EXACT
        • MatchQuality.INTERPOLATED
        • MatchQuality.APPROXIMATE
        • MatchQuality.CENTROID
        • MatchQuality.NO_MATCH
        • MatchQuality.__new__()
      • normalize_addresses()
      • CensusBatchGeocoder
        • CensusBatchGeocoder.__init__()
        • CensusBatchGeocoder.backend_name
        • CensusBatchGeocoder.geocode()
      • NominatimBatchGeocoder
        • NominatimBatchGeocoder.__init__()
        • NominatimBatchGeocoder.backend_name
        • NominatimBatchGeocoder.geocode()
      • TAMUBatchGeocoder
        • TAMUBatchGeocoder.__init__()
        • TAMUBatchGeocoder.backend_name
        • TAMUBatchGeocoder.is_available()
        • TAMUBatchGeocoder.geocode()
      • Why a thin wrapper?
      • EtterError
      • EtterParseError
      • EtterLowConfidenceError
      • EtterFilter
        • EtterFilter.original_query
        • EtterFilter.spatial_relation
        • EtterFilter.reference_location
        • EtterFilter.buffer_distance_m
        • EtterFilter.confidence
        • EtterFilter.raw
        • EtterFilter.original_query
        • EtterFilter.spatial_relation
        • EtterFilter.reference_location
        • EtterFilter.buffer_distance_m
        • EtterFilter.confidence
        • EtterFilter.raw
        • EtterFilter.from_geoquery()
        • EtterFilter.__init__()
      • EtterParser
        • EtterParser.__init__()
        • EtterParser.parse()
      • default_llm()
      • RelationSemantics
        • RelationSemantics.BOUNDED
        • RelationSemantics.HALFPLANE
        • RelationSemantics.CONTAINS_CENTROID
        • RelationSemantics.__new__()
      • EtterGeometryResult
        • EtterGeometryResult.geometry
        • EtterGeometryResult.relation
        • EtterGeometryResult.reference
        • EtterGeometryResult.buffer_km
        • EtterGeometryResult.semantics
        • EtterGeometryResult.notes
        • EtterGeometryResult.geometry
        • EtterGeometryResult.relation
        • EtterGeometryResult.reference
        • EtterGeometryResult.buffer_km
        • EtterGeometryResult.semantics
        • EtterGeometryResult.notes
        • EtterGeometryResult.__init__()
      • EtterToGeometryError
      • EtterReferenceNotFoundError
      • EtterUnknownRelationError
      • etter_to_geometry()
      • RDHClient
        • RDHClient.__init__()
        • RDHClient.close()
        • RDHClient.credentials_present()
        • RDHClient.validate_credentials()
        • RDHClient.list_datasets()
        • RDHClient.download_dataset()
        • RDHClient.load_csv()
        • RDHClient.load_shapefile()
        • RDHClient.get_enacted_plans()
        • RDHClient.get_precinct_data()
        • RDHClient.get_cvap_data()
        • RDHClient.get_pl94171_data()
        • RDHClient.to_crosstab_input()
      • RDHDataset
        • RDHDataset.title
        • RDHDataset.url
        • RDHDataset.state
        • RDHDataset.format
        • RDHDataset.year
        • RDHDataset.geography
        • RDHDataset.dataset_type
        • RDHDataset.official
        • RDHDataset.file_size
        • RDHDataset.raw
        • RDHDataset.filename
        • RDHDataset.is_shapefile
        • RDHDataset.is_csv
        • RDHDataset.__init__()
      • RDHDataFormat
        • RDHDataFormat.CSV
        • RDHDataFormat.SHAPEFILE
        • RDHDataFormat.__new__()
      • RDHDatasetType
        • RDHDatasetType.PL94171
        • RDHDatasetType.CVAP
        • RDHDatasetType.ACS5
        • RDHDatasetType.ELECTION
        • RDHDatasetType.LEGISLATIVE
        • RDHDatasetType.PRECINCT
        • RDHDatasetType.VOTER_FILE
        • RDHDatasetType.PROJECTION
        • RDHDatasetType.__new__()
      • polsby_popper()
      • reock()
      • convex_hull_ratio()
      • schwartzberg()
      • compute_compactness()
      • CompactnessScores
        • CompactnessScores.district_id
        • CompactnessScores.polsby_popper
        • CompactnessScores.reock
        • CompactnessScores.convex_hull_ratio
        • CompactnessScores.schwartzberg
        • CompactnessScores.__init__()
      • compare_plans()
      • demographic_profile()
      • fetch_enacted_plan()
      • fetch_precinct_results()
      • fetch_cvap()
      • fetch_pl94171()
      • fetch_demographic_summary()
      • NCESDownloadError
      • NCESDownloader
        • NCESDownloader.__init__()
        • NCESDownloader.download_locale_boundaries()
        • NCESDownloader.download_school_locations()
        • NCESDownloader.download_district_data()
      • NLRBCache
        • NLRBCache.__init__()
        • NLRBCache.get()
        • NLRBCache.put()
        • NLRBCache.invalidate()
        • NLRBCache.invalidate_all()
      • NLRBLoader
        • NLRBLoader.__init__()
        • NLRBLoader.load()
      • CaseStatus
        • CaseStatus.OPEN
        • CaseStatus.CLOSED
        • CaseStatus.PENDING
        • CaseStatus.UNKNOWN
        • CaseStatus.__new__()
      • CaseType
        • CaseType.R
        • CaseType.C
        • CaseType.CB
        • CaseType.CD
        • CaseType.CE
        • CaseType.CA
        • CaseType.AC
        • CaseType.UC
        • CaseType.UD
        • CaseType.WH
        • CaseType.RM
        • CaseType.RD
        • CaseType.RC
        • CaseType.__new__()
      • ElectionRecord
        • ElectionRecord.case_number
        • ElectionRecord.tally_date
        • ElectionRecord.eligible_voters
        • ElectionRecord.votes_for
        • ElectionRecord.votes_against
        • ElectionRecord.void_ballots
        • ElectionRecord.union_name
        • ElectionRecord.source
        • ElectionRecord.to_dict()
        • ElectionRecord.__init__()
      • NLRBCaseRecord
        • NLRBCaseRecord.case_number
        • NLRBCaseRecord.case_type
        • NLRBCaseRecord.case_name
        • NLRBCaseRecord.status
        • NLRBCaseRecord.date_filed
        • NLRBCaseRecord.date_closed
        • NLRBCaseRecord.region
        • NLRBCaseRecord.city
        • NLRBCaseRecord.state
        • NLRBCaseRecord.union_name
        • NLRBCaseRecord.unit_description
        • NLRBCaseRecord.naics_code
        • NLRBCaseRecord.employee_count
        • NLRBCaseRecord.source
        • NLRBCaseRecord.to_dict()
        • NLRBCaseRecord.__init__()
      • NLRBDataClient
        • NLRBDataClient.SOURCE_PRIORITY
        • NLRBDataClient.__init__()
        • NLRBDataClient.fetch_all()
      • NLRBDatagovClient
        • NLRBDatagovClient.__init__()
        • NLRBDatagovClient.fetch_cases()
      • NLRBFetchResult
        • NLRBFetchResult.cases
        • NLRBFetchResult.elections
        • NLRBFetchResult.ulp_charges
        • NLRBFetchResult.errors
        • NLRBFetchResult.source
        • NLRBFetchResult.success
        • NLRBFetchResult.total_records
        • NLRBFetchResult.__init__()
      • NLRBLabordataClient
        • NLRBLabordataClient.__init__()
        • NLRBLabordataClient.fetch_cases()
      • NLRBNxGenClient
        • NLRBNxGenClient.__init__()
        • NLRBNxGenClient.fetch_case()
      • ULPRecord
        • ULPRecord.case_number
        • ULPRecord.allegation
        • ULPRecord.charging_party
        • ULPRecord.charged_party
        • ULPRecord.section_of_act
        • ULPRecord.date_filed
        • ULPRecord.source
        • ULPRecord.to_dict()
        • ULPRecord.__init__()
      • cases_to_dataframe()
      • elections_to_dataframe()
      • fetch_result_to_dataframes()
      • ulp_charges_to_dataframe()
      • aggregate_by_region()
      • assign_region()
      • lookup_region_by_state()
      • region_summary()
    • Census Data Intelligence
      • CatalogCache
        • CatalogCache.__init__()
        • CatalogCache.get()
        • CatalogCache.put()
        • CatalogCache.clear()
      • CatalogLoader
        • CatalogLoader.__init__()
        • CatalogLoader.load()
      • CensusAPI
        • CensusAPI.__init__()
        • CensusAPI.fetch_data()
        • CensusAPI.clear_cache()
        • CensusAPI.get_variable_metadata()
        • CensusAPI.list_available_variables()
      • CensusCatalog
        • CensusCatalog.__init__()
        • CensusCatalog.add_table()
        • CensusCatalog.add_tables()
        • CensusCatalog.add_family()
        • CensusCatalog.add_subject()
        • CensusCatalog.add_dataset()
        • CensusCatalog.get_table()
        • CensusCatalog.get_family()
        • CensusCatalog.get_subject()
        • CensusCatalog.get_dataset()
        • CensusCatalog.tables
        • CensusCatalog.families
        • CensusCatalog.subjects
        • CensusCatalog.datasets
        • CensusCatalog.tables_for_geography()
        • CensusCatalog.geography_for_table()
        • CensusCatalog.families_for_table()
        • CensusCatalog.search()
        • CensusCatalog.build_families()
      • CensusCatalogPopulator
        • CensusCatalogPopulator.__init__()
        • CensusCatalogPopulator.populate()
      • CensusCatalogDataset
        • CensusCatalogDataset.dataset_id
        • CensusCatalogDataset.survey_type
        • CensusCatalogDataset.year
        • CensusCatalogDataset.subjects
        • CensusCatalogDataset.tables
        • CensusCatalogDataset.__init__()
      • CensusFamily
        • CensusFamily.family_id
        • CensusFamily.family_type
        • CensusFamily.root_table_id
        • CensusFamily.tables
        • CensusFamily.description
        • CensusFamily.table_ids
        • CensusFamily.__init__()
      • CensusSubject
        • CensusSubject.subject_id
        • CensusSubject.label
        • CensusSubject.families
        • CensusSubject.tables
        • CensusSubject.all_tables
        • CensusSubject.__init__()
      • CensusTable
        • CensusTable.table_id
        • CensusTable.label
        • CensusTable.concept
        • CensusTable.universe
        • CensusTable.variables
        • CensusTable.geography_levels
        • CensusTable.parsed_id
        • CensusTable.root_table_id
        • CensusTable.race_suffix
        • CensusTable.__init__()
      • CensusVariable
        • CensusVariable.code
        • CensusVariable.label
        • CensusVariable.concept
        • CensusVariable.table_id
        • CensusVariable.stat_type
        • CensusVariable.parse_code()
        • CensusVariable.__init__()
      • DatasetSelector
        • DatasetSelector.API_SUPPORTED_GEOGRAPHIES
        • DatasetSelector.get_dataset_path()
        • DatasetSelector.validate_geography()
        • DatasetSelector.build_geography_clause()
        • DatasetSelector.normalize_state()
      • FamilyType
        • FamilyType.RACE_ITERATION
        • FamilyType.TOPICAL_KINSHIP
      • SearchLevel
        • SearchLevel.DATASET
        • SearchLevel.SUBJECT
        • SearchLevel.FAMILY
        • SearchLevel.TABLE
        • SearchLevel.VARIABLE
      • SearchResult
        • SearchResult.level
        • SearchResult.id
        • SearchResult.label
        • SearchResult.score
        • SearchResult.obj
        • SearchResult.__init__()
      • VariableRegistry
        • VariableRegistry.__init__()
        • VariableRegistry.resolve_variables()
        • VariableRegistry.add_moe_variables()
        • VariableRegistry.get_description()
        • VariableRegistry.get_variable_metadata()
        • VariableRegistry.list_available_variables()
        • VariableRegistry.list_groups()
      • CensusAPI
        • CensusAPI.__init__()
        • CensusAPI.fetch_data()
        • CensusAPI.clear_cache()
        • CensusAPI.get_variable_metadata()
        • CensusAPI.list_available_variables()
      • CensusCatalog
        • CensusCatalog.__init__()
        • CensusCatalog.add_table()
        • CensusCatalog.add_tables()
        • CensusCatalog.add_family()
        • CensusCatalog.add_subject()
        • CensusCatalog.add_dataset()
        • CensusCatalog.get_table()
        • CensusCatalog.get_family()
        • CensusCatalog.get_subject()
        • CensusCatalog.get_dataset()
        • CensusCatalog.tables
        • CensusCatalog.families
        • CensusCatalog.subjects
        • CensusCatalog.datasets
        • CensusCatalog.tables_for_geography()
        • CensusCatalog.geography_for_table()
        • CensusCatalog.families_for_table()
        • CensusCatalog.search()
        • CensusCatalog.build_families()
      • CensusCatalogDataset
        • CensusCatalogDataset.dataset_id
        • CensusCatalogDataset.survey_type
        • CensusCatalogDataset.year
        • CensusCatalogDataset.subjects
        • CensusCatalogDataset.tables
        • CensusCatalogDataset.__init__()
      • CensusFamily
        • CensusFamily.family_id
        • CensusFamily.family_type
        • CensusFamily.root_table_id
        • CensusFamily.tables
        • CensusFamily.description
        • CensusFamily.table_ids
        • CensusFamily.__init__()
      • CensusSubject
        • CensusSubject.subject_id
        • CensusSubject.label
        • CensusSubject.families
        • CensusSubject.tables
        • CensusSubject.all_tables
        • CensusSubject.__init__()
      • CensusTable
        • CensusTable.table_id
        • CensusTable.label
        • CensusTable.concept
        • CensusTable.universe
        • CensusTable.variables
        • CensusTable.geography_levels
        • CensusTable.parsed_id
        • CensusTable.root_table_id
        • CensusTable.race_suffix
        • CensusTable.__init__()
      • CensusVariable
        • CensusVariable.code
        • CensusVariable.label
        • CensusVariable.concept
        • CensusVariable.table_id
        • CensusVariable.stat_type
        • CensusVariable.parse_code()
        • CensusVariable.__init__()
      • FamilyType
        • FamilyType.RACE_ITERATION
        • FamilyType.TOPICAL_KINSHIP
      • SearchLevel
        • SearchLevel.DATASET
        • SearchLevel.SUBJECT
        • SearchLevel.FAMILY
        • SearchLevel.TABLE
        • SearchLevel.VARIABLE
      • SearchResult
        • SearchResult.level
        • SearchResult.id
        • SearchResult.label
        • SearchResult.score
        • SearchResult.obj
        • SearchResult.__init__()
      • detect_race_iteration_families()
      • detect_topical_families()
      • parse_table_id()
      • CatalogCache
        • CatalogCache.__init__()
        • CatalogCache.get()
        • CatalogCache.put()
        • CatalogCache.clear()
      • CatalogLoader
        • CatalogLoader.__init__()
        • CatalogLoader.load()
      • generate_catalog_docs()
      • generate_catalog_markdown()
      • CensusCatalogPopulator
        • CensusCatalogPopulator.__init__()
        • CensusCatalogPopulator.populate()
      • DatasetSelector
        • DatasetSelector.API_SUPPORTED_GEOGRAPHIES
        • DatasetSelector.get_dataset_path()
        • DatasetSelector.validate_geography()
        • DatasetSelector.build_geography_clause()
        • DatasetSelector.normalize_state()
      • get_last_fetched_vintage()
      • set_last_fetched_vintage()
      • check_for_updates()
      • VariableRegistry
        • VariableRegistry.__init__()
        • VariableRegistry.resolve_variables()
        • VariableRegistry.add_moe_variables()
        • VariableRegistry.get_description()
        • VariableRegistry.get_variable_metadata()
        • VariableRegistry.list_available_variables()
        • VariableRegistry.list_groups()
      • CensusAPIError
      • CensusAPIKeyError
      • CensusRateLimitError
      • CensusVariableError
      • CensusGeographyError
      • CensusAPIClient
        • CensusAPIClient.__init__()
        • CensusAPIClient.api_key
        • CensusAPIClient.timeout
        • CensusAPIClient.base_url
        • CensusAPIClient.cache_dir
        • CensusAPIClient.cache_backend
        • CensusAPIClient.cache_ttl
        • CensusAPIClient.fetch_data()
        • CensusAPIClient.get_variable_metadata()
        • CensusAPIClient.list_available_variables()
        • CensusAPIClient.clear_cache()
      • get_demographics()
      • get_population()
      • get_income_data()
      • get_education_data()
      • get_housing_data()
      • get_census_api_client()
      • get_census_data_with_geometry()
      • join_demographics_to_shapes()
      • CensusDataSelector
        • CensusDataSelector.__init__()
        • CensusDataSelector.select_datasets_for_analysis()
        • CensusDataSelector.get_dataset_compatibility_matrix()
        • CensusDataSelector.suggest_analysis_approach()
      • get_census_data_selector()
      • select_census_datasets()
      • select_datasets_for_analysis()
      • get_dataset_compatibility_matrix()
      • get_analysis_approach()
      • suggest_analysis_approach()
      • SurveyType
        • SurveyType.DECENNIAL
        • SurveyType.ACS_1YR
        • SurveyType.ACS_3YR
        • SurveyType.ACS_5YR
        • SurveyType.CENSUS_BUSINESS
        • SurveyType.POPULATION_ESTIMATES
        • SurveyType.HOUSING_ESTIMATES
      • GeographyLevel
        • GeographyLevel.NATION
        • GeographyLevel.REGION
        • GeographyLevel.DIVISION
        • GeographyLevel.STATE
        • GeographyLevel.COUNTY
        • GeographyLevel.COUSUB
        • GeographyLevel.PLACE
        • GeographyLevel.CD
        • GeographyLevel.SLDU
        • GeographyLevel.SLDL
        • GeographyLevel.TRACT
        • GeographyLevel.BLOCK_GROUP
        • GeographyLevel.BLOCK
        • GeographyLevel.ZCTA
        • GeographyLevel.CBSA
        • GeographyLevel.PUMA
        • GeographyLevel.VTD
        • GeographyLevel.VTD20
        • GeographyLevel.TABBLOCK20
        • GeographyLevel.TABBLOCK10
        • GeographyLevel.COUNTY_SUBDIVISION
        • GeographyLevel.CONGRESSIONAL_DISTRICT
        • GeographyLevel.STATE_LEGISLATIVE_DISTRICT
        • GeographyLevel.ZIP_CODE
        • GeographyLevel.VOTING_DISTRICT
      • DataReliability
        • DataReliability.HIGH
        • DataReliability.MEDIUM
        • DataReliability.LOW
        • DataReliability.ESTIMATED
      • CensusDataset
        • CensusDataset.dataset_id
        • CensusDataset.name
        • CensusDataset.survey_type
        • CensusDataset.geography_levels
        • CensusDataset.time_period
        • CensusDataset.reliability
        • CensusDataset.description
        • CensusDataset.variables
        • CensusDataset.limitations
        • CensusDataset.best_for
        • CensusDataset.alternatives
        • CensusDataset.data_quality_notes
        • CensusDataset.last_updated
        • CensusDataset.next_update
        • CensusDataset.api_endpoint
        • CensusDataset.download_url
        • CensusDataset.__init__()
      • DatasetRelationship
        • DatasetRelationship.primary_dataset
        • DatasetRelationship.related_dataset
        • DatasetRelationship.relationship_type
        • DatasetRelationship.description
        • DatasetRelationship.when_to_use_primary
        • DatasetRelationship.when_to_use_related
        • DatasetRelationship.overlap_period
        • DatasetRelationship.compatibility_score
        • DatasetRelationship.__init__()
      • CensusDatasetMapper
        • CensusDatasetMapper.__init__()
        • CensusDatasetMapper.datasets
        • CensusDatasetMapper.relationships
        • CensusDatasetMapper.get_dataset_info()
        • CensusDatasetMapper.list_datasets_by_type()
        • CensusDatasetMapper.list_datasets_by_geography()
        • CensusDatasetMapper.get_best_dataset_for_use_case()
        • CensusDatasetMapper.get_dataset_relationships()
        • CensusDatasetMapper.compare_datasets()
        • CensusDatasetMapper.get_data_selection_guide()
        • CensusDatasetMapper.export_dataset_catalog()
      • get_census_dataset_mapper()
      • get_best_dataset_for_analysis()
      • get_dataset_info()
      • list_datasets_by_type()
      • list_datasets_by_geography()
      • get_dataset_relationships()
      • get_best_dataset_for_use_case()
      • export_dataset_catalog()
      • get_data_selection_guide()
      • compare_datasets()
      • compare_census_datasets()
      • CensusGeocodeError
      • CensusGeocodeResult
        • CensusGeocodeResult.matched
        • CensusGeocodeResult.input_address
        • CensusGeocodeResult.matched_address
        • CensusGeocodeResult.lat
        • CensusGeocodeResult.lon
        • CensusGeocodeResult.state_fips
        • CensusGeocodeResult.county_fips
        • CensusGeocodeResult.tract
        • CensusGeocodeResult.block
        • CensusGeocodeResult.match_type
        • CensusGeocodeResult.side
        • CensusGeocodeResult.tiger_line_id
        • CensusGeocodeResult.matched
        • CensusGeocodeResult.input_address
        • CensusGeocodeResult.matched_address
        • CensusGeocodeResult.lat
        • CensusGeocodeResult.lon
        • CensusGeocodeResult.state_fips
        • CensusGeocodeResult.county_fips
        • CensusGeocodeResult.tract
        • CensusGeocodeResult.block
        • CensusGeocodeResult.match_type
        • CensusGeocodeResult.side
        • CensusGeocodeResult.tiger_line_id
        • CensusGeocodeResult.input_id
        • CensusGeocodeResult.state_geoid
        • CensusGeocodeResult.county_geoid
        • CensusGeocodeResult.tract_geoid
        • CensusGeocodeResult.block_geoid
        • CensusGeocodeResult.block_group_geoid
        • CensusGeocodeResult.__init__()
      • CensusVintage
        • CensusVintage.CENSUS_2010
        • CensusVintage.CENSUS_2020
        • CensusVintage.CURRENT
        • CensusVintage.ACS_2022
        • CensusVintage.ACS_2023
        • CensusVintage.benchmark
        • CensusVintage.vintage
        • CensusVintage.__new__()
      • geocode_batch()
      • geocode_batch_chunked()
      • geocode_results_to_dataframe()
      • geocode_single()
      • select_vintage_for_cycle()
      • PLFileDownloader
        • PLFileDownloader.__init__()
        • PLFileDownloader.get_data()
        • PLFileDownloader.clear_cache()
      • get_pl_data()
      • get_pl_blocks()
      • get_pl_tracts()
      • download_pl_file()
      • list_available_pl_files()
      • PLFileDownloader
        • PLFileDownloader.__init__()
        • PLFileDownloader.get_data()
        • PLFileDownloader.clear_cache()
      • get_pl_data()
      • get_pl_blocks()
      • get_pl_tracts()
      • download_pl_file()
      • list_available_pl_files()
    • Crosswalks and Interpolation
      • RelationshipType
        • RelationshipType.ONE_TO_ONE
        • RelationshipType.SPLIT
        • RelationshipType.MERGED
        • RelationshipType.PARTIAL_OVERLAP
      • WeightMethod
        • WeightMethod.AREA
        • WeightMethod.POPULATION
        • WeightMethod.HOUSING
        • WeightMethod.EQUAL
      • CrosswalkRelationship
        • CrosswalkRelationship.source_geoid
        • CrosswalkRelationship.target_geoid
        • CrosswalkRelationship.relationship_type
        • CrosswalkRelationship.area_weight
        • CrosswalkRelationship.population_weight
        • CrosswalkRelationship.housing_weight
        • CrosswalkRelationship.source_area
        • CrosswalkRelationship.target_area
        • CrosswalkRelationship.overlap_area
        • CrosswalkRelationship.source_geoid
        • CrosswalkRelationship.target_geoid
        • CrosswalkRelationship.relationship_type
        • CrosswalkRelationship.area_weight
        • CrosswalkRelationship.population_weight
        • CrosswalkRelationship.housing_weight
        • CrosswalkRelationship.source_area
        • CrosswalkRelationship.target_area
        • CrosswalkRelationship.overlap_area
        • CrosswalkRelationship.get_weight()
        • CrosswalkRelationship.__init__()
      • CrosswalkMetadata
        • CrosswalkMetadata.source_year
        • CrosswalkMetadata.target_year
        • CrosswalkMetadata.geography_level
        • CrosswalkMetadata.state_fips
        • CrosswalkMetadata.total_source_units
        • CrosswalkMetadata.total_target_units
        • CrosswalkMetadata.one_to_one_count
        • CrosswalkMetadata.split_count
        • CrosswalkMetadata.merged_count
        • CrosswalkMetadata.source_url
        • CrosswalkMetadata.download_date
        • CrosswalkMetadata.source_year
        • CrosswalkMetadata.target_year
        • CrosswalkMetadata.geography_level
        • CrosswalkMetadata.state_fips
        • CrosswalkMetadata.total_source_units
        • CrosswalkMetadata.total_target_units
        • CrosswalkMetadata.one_to_one_count
        • CrosswalkMetadata.split_count
        • CrosswalkMetadata.merged_count
        • CrosswalkMetadata.source_url
        • CrosswalkMetadata.download_date
        • CrosswalkMetadata.change_rate
        • CrosswalkMetadata.summary()
        • CrosswalkMetadata.__init__()
      • GeographyChange
        • GeographyChange.source_geoid
        • GeographyChange.relationship_type
        • GeographyChange.target_geoids
        • GeographyChange.weights
        • GeographyChange.population_2010
        • GeographyChange.population_2020
        • GeographyChange.source_geoid
        • GeographyChange.relationship_type
        • GeographyChange.target_geoids
        • GeographyChange.weights
        • GeographyChange.population_2010
        • GeographyChange.__init__()
        • GeographyChange.population_2020
        • GeographyChange.is_unchanged
        • GeographyChange.was_split
        • GeographyChange.was_merged
        • GeographyChange.num_targets
      • CrosswalkClient
        • CrosswalkClient.cache_dir
        • CrosswalkClient.timeout
        • CrosswalkClient.__init__()
        • CrosswalkClient.get_crosswalk()
        • CrosswalkClient.get_crosswalk_metadata()
        • CrosswalkClient.list_available_crosswalks()
        • CrosswalkClient.clear_cache()
      • get_crosswalk()
      • get_crosswalk_client()
      • get_crosswalk_metadata()
      • list_available_crosswalks()
      • CrosswalkProcessor
        • CrosswalkProcessor.crosswalk_df
        • CrosswalkProcessor.source_year
        • CrosswalkProcessor.target_year
        • CrosswalkProcessor.geography_level
        • CrosswalkProcessor.__init__()
        • CrosswalkProcessor.get_relationship_type()
        • CrosswalkProcessor.get_geography_change()
        • CrosswalkProcessor.transform()
      • apply_crosswalk()
      • normalize_to_year()
      • identify_boundary_changes()
      • get_split_tracts()
      • get_merged_tracts()
      • CrosswalkClient
        • CrosswalkClient.cache_dir
        • CrosswalkClient.timeout
        • CrosswalkClient.__init__()
        • CrosswalkClient.get_crosswalk()
        • CrosswalkClient.get_crosswalk_metadata()
        • CrosswalkClient.list_available_crosswalks()
        • CrosswalkClient.clear_cache()
      • get_crosswalk_client()
      • get_crosswalk()
      • get_crosswalk_metadata()
      • list_available_crosswalks()
      • CrosswalkProcessor
        • CrosswalkProcessor.crosswalk_df
        • CrosswalkProcessor.source_year
        • CrosswalkProcessor.target_year
        • CrosswalkProcessor.geography_level
        • CrosswalkProcessor.__init__()
        • CrosswalkProcessor.get_relationship_type()
        • CrosswalkProcessor.get_geography_change()
        • CrosswalkProcessor.transform()
      • apply_crosswalk()
      • normalize_to_year()
      • identify_boundary_changes()
      • get_split_tracts()
      • get_merged_tracts()
      • RelationshipType
        • RelationshipType.ONE_TO_ONE
        • RelationshipType.SPLIT
        • RelationshipType.MERGED
        • RelationshipType.PARTIAL_OVERLAP
      • WeightMethod
        • WeightMethod.AREA
        • WeightMethod.POPULATION
        • WeightMethod.HOUSING
        • WeightMethod.EQUAL
      • CrosswalkRelationship
        • CrosswalkRelationship.source_geoid
        • CrosswalkRelationship.target_geoid
        • CrosswalkRelationship.relationship_type
        • CrosswalkRelationship.area_weight
        • CrosswalkRelationship.population_weight
        • CrosswalkRelationship.housing_weight
        • CrosswalkRelationship.source_area
        • CrosswalkRelationship.target_area
        • CrosswalkRelationship.overlap_area
        • CrosswalkRelationship.source_geoid
        • CrosswalkRelationship.target_geoid
        • CrosswalkRelationship.relationship_type
        • CrosswalkRelationship.area_weight
        • CrosswalkRelationship.population_weight
        • CrosswalkRelationship.housing_weight
        • CrosswalkRelationship.source_area
        • CrosswalkRelationship.target_area
        • CrosswalkRelationship.overlap_area
        • CrosswalkRelationship.get_weight()
        • CrosswalkRelationship.__init__()
      • CrosswalkMetadata
        • CrosswalkMetadata.source_year
        • CrosswalkMetadata.target_year
        • CrosswalkMetadata.geography_level
        • CrosswalkMetadata.state_fips
        • CrosswalkMetadata.total_source_units
        • CrosswalkMetadata.total_target_units
        • CrosswalkMetadata.one_to_one_count
        • CrosswalkMetadata.split_count
        • CrosswalkMetadata.merged_count
        • CrosswalkMetadata.source_url
        • CrosswalkMetadata.download_date
        • CrosswalkMetadata.source_year
        • CrosswalkMetadata.target_year
        • CrosswalkMetadata.geography_level
        • CrosswalkMetadata.state_fips
        • CrosswalkMetadata.total_source_units
        • CrosswalkMetadata.total_target_units
        • CrosswalkMetadata.one_to_one_count
        • CrosswalkMetadata.split_count
        • CrosswalkMetadata.merged_count
        • CrosswalkMetadata.source_url
        • CrosswalkMetadata.download_date
        • CrosswalkMetadata.change_rate
        • CrosswalkMetadata.summary()
        • CrosswalkMetadata.__init__()
      • GeographyChange
        • GeographyChange.source_geoid
        • GeographyChange.relationship_type
        • GeographyChange.target_geoids
        • GeographyChange.weights
        • GeographyChange.population_2010
        • GeographyChange.population_2020
        • GeographyChange.source_geoid
        • GeographyChange.relationship_type
        • GeographyChange.target_geoids
        • GeographyChange.weights
        • GeographyChange.population_2010
        • GeographyChange.__init__()
        • GeographyChange.population_2020
        • GeographyChange.is_unchanged
        • GeographyChange.was_split
        • GeographyChange.was_merged
        • GeographyChange.num_targets
      • ArealInterpolationResult
        • ArealInterpolationResult.data
        • ArealInterpolationResult.extensive_variables
        • ArealInterpolationResult.intensive_variables
        • ArealInterpolationResult.source_crs
        • ArealInterpolationResult.target_crs
        • ArealInterpolationResult.n_source
        • ArealInterpolationResult.n_target
        • ArealInterpolationResult.warnings
        • ArealInterpolationResult.backend
        • ArealInterpolationResult.data
        • ArealInterpolationResult.extensive_variables
        • ArealInterpolationResult.intensive_variables
        • ArealInterpolationResult.source_crs
        • ArealInterpolationResult.target_crs
        • ArealInterpolationResult.n_source
        • ArealInterpolationResult.n_target
        • ArealInterpolationResult.warnings
        • ArealInterpolationResult.backend
        • ArealInterpolationResult.__init__()
      • interpolate_areal()
      • interpolate_extensive()
      • interpolate_intensive()
      • compute_area_weights()
      • ArealInterpolationResult
        • ArealInterpolationResult.data
        • ArealInterpolationResult.extensive_variables
        • ArealInterpolationResult.intensive_variables
        • ArealInterpolationResult.source_crs
        • ArealInterpolationResult.target_crs
        • ArealInterpolationResult.n_source
        • ArealInterpolationResult.n_target
        • ArealInterpolationResult.warnings
        • ArealInterpolationResult.backend
        • ArealInterpolationResult.data
        • ArealInterpolationResult.extensive_variables
        • ArealInterpolationResult.intensive_variables
        • ArealInterpolationResult.source_crs
        • ArealInterpolationResult.target_crs
        • ArealInterpolationResult.n_source
        • ArealInterpolationResult.n_target
        • ArealInterpolationResult.warnings
        • ArealInterpolationResult.backend
        • ArealInterpolationResult.__init__()
      • interpolate_areal()
      • interpolate_extensive()
      • interpolate_intensive()
      • compute_area_weights()
    • Gazetteers and Place History
      • Gazetteer
        • Gazetteer.provider_name
        • Gazetteer.lookup()
        • Gazetteer.search()
        • Gazetteer.is_available()
        • Gazetteer.__init__()
      • GazetteerCandidate
        • GazetteerCandidate.name
        • GazetteerCandidate.canonical_path
        • GazetteerCandidate.country
        • GazetteerCandidate.admin_levels
        • GazetteerCandidate.score
        • GazetteerCandidate.source
        • GazetteerCandidate.__init__()
      • GazetteerResult
        • GazetteerResult.name
        • GazetteerResult.canonical_path
        • GazetteerResult.geometry
        • GazetteerResult.centroid
        • GazetteerResult.country
        • GazetteerResult.admin_levels
        • GazetteerResult.source
        • GazetteerResult.raw
        • GazetteerResult.name
        • GazetteerResult.canonical_path
        • GazetteerResult.geometry
        • GazetteerResult.centroid
        • GazetteerResult.country
        • GazetteerResult.admin_levels
        • GazetteerResult.source
        • GazetteerResult.raw
        • GazetteerResult.__init__()
      • GazetteerError
      • GazetteerNotFoundError
      • GazetteerAmbiguousError
        • GazetteerAmbiguousError.__init__()
      • GazetteerBackendError
      • resolve_gazetteer()
      • Gazetteer
        • Gazetteer.provider_name
        • Gazetteer.lookup()
        • Gazetteer.search()
        • Gazetteer.is_available()
        • Gazetteer.__init__()
      • GazetteerResult
        • GazetteerResult.name
        • GazetteerResult.canonical_path
        • GazetteerResult.geometry
        • GazetteerResult.centroid
        • GazetteerResult.country
        • GazetteerResult.admin_levels
        • GazetteerResult.source
        • GazetteerResult.raw
        • GazetteerResult.name
        • GazetteerResult.canonical_path
        • GazetteerResult.geometry
        • GazetteerResult.centroid
        • GazetteerResult.country
        • GazetteerResult.admin_levels
        • GazetteerResult.source
        • GazetteerResult.raw
        • GazetteerResult.__init__()
      • GazetteerCandidate
        • GazetteerCandidate.name
        • GazetteerCandidate.canonical_path
        • GazetteerCandidate.country
        • GazetteerCandidate.admin_levels
        • GazetteerCandidate.score
        • GazetteerCandidate.source
        • GazetteerCandidate.__init__()
      • GazetteerError
      • GazetteerNotFoundError
      • GazetteerAmbiguousError
        • GazetteerAmbiguousError.__init__()
      • GazetteerBackendError
      • CensusGazetteer
        • CensusGazetteer.provider_name
        • CensusGazetteer.__init__()
        • CensusGazetteer.is_available()
        • CensusGazetteer.lookup()
        • CensusGazetteer.search()
      • NominatimGazetteer
        • NominatimGazetteer.provider_name
        • NominatimGazetteer.__init__()
        • NominatimGazetteer.is_available()
        • NominatimGazetteer.lookup()
        • NominatimGazetteer.search()
      • WikidataGazetteer
        • WikidataGazetteer.provider_name
        • WikidataGazetteer.__init__()
        • WikidataGazetteer.close()
        • WikidataGazetteer.is_available()
        • WikidataGazetteer.lookup()
        • WikidataGazetteer.search()
      • WklsGazetteer
        • WklsGazetteer.provider_name
        • WklsGazetteer.__init__()
        • WklsGazetteer.is_available()
        • WklsGazetteer.lookup()
        • WklsGazetteer.search()
      • CrosswalkProvider
        • CrosswalkProvider.get_forward_mappings()
        • CrosswalkProvider.get_reverse_mappings()
      • CrosswalkRecord
        • CrosswalkRecord.source_geoid
        • CrosswalkRecord.target_geoid
        • CrosswalkRecord.weight
        • CrosswalkRecord.relationship
        • CrosswalkRecord.__init__()
      • DictCrosswalkProvider
        • DictCrosswalkProvider.__init__()
        • DictCrosswalkProvider.add()
        • DictCrosswalkProvider.get_forward_mappings()
        • DictCrosswalkProvider.get_reverse_mappings()
      • Lineage
        • Lineage.origin_geoid
        • Lineage.origin_year
        • Lineage.steps
        • Lineage.terminal_geoids
        • Lineage.direction
        • Lineage.origin_geoid
        • Lineage.origin_year
        • Lineage.steps
        • Lineage.terminal_geoids
        • Lineage.direction
        • Lineage.is_unchanged
        • Lineage.__init__()
      • LineageStep
        • LineageStep.source_geoid
        • LineageStep.target_geoid
        • LineageStep.source_year
        • LineageStep.target_year
        • LineageStep.weight
        • LineageStep.relationship
        • LineageStep.source_geoid
        • LineageStep.target_geoid
        • LineageStep.source_year
        • LineageStep.target_year
        • LineageStep.weight
        • LineageStep.relationship
        • LineageStep.__init__()
      • PlaceHistoryResult
        • PlaceHistoryResult.geoid
        • PlaceHistoryResult.from_year
        • PlaceHistoryResult.to_year
        • PlaceHistoryResult.lineage
        • PlaceHistoryResult.overlays
        • PlaceHistoryResult.errors
        • PlaceHistoryResult.geoid
        • PlaceHistoryResult.from_year
        • PlaceHistoryResult.to_year
        • PlaceHistoryResult.lineage
        • PlaceHistoryResult.overlays
        • PlaceHistoryResult.errors
        • PlaceHistoryResult.has_lineage
        • PlaceHistoryResult.direction
        • PlaceHistoryResult.__init__()
      • place_history()
    • Overlays
      • OverlayRegistry
        • OverlayRegistry.__init__()
        • OverlayRegistry.register()
        • OverlayRegistry.register_instance()
        • OverlayRegistry.get()
        • OverlayRegistry.list_overlays()
        • OverlayRegistry.is_registered()
        • OverlayRegistry.unregister()
        • OverlayRegistry.clear()
      • PlaceHistoryOverlay
        • PlaceHistoryOverlay.name
        • PlaceHistoryOverlay.fetch()
        • PlaceHistoryOverlay.is_available()
      • DemographicPoint
        • DemographicPoint.year
        • DemographicPoint.geoid
        • DemographicPoint.dataset
        • DemographicPoint.total_population
        • DemographicPoint.median_household_income
        • DemographicPoint.median_age
        • DemographicPoint.values
        • DemographicPoint.year
        • DemographicPoint.geoid
        • DemographicPoint.dataset
        • DemographicPoint.total_population
        • DemographicPoint.median_household_income
        • DemographicPoint.median_age
        • DemographicPoint.values
        • DemographicPoint.__init__()
      • DemographicsDataProvider
        • DemographicsDataProvider.get_snapshots()
      • DemographicsOverlay
        • DemographicsOverlay.__init__()
        • DemographicsOverlay.name
        • DemographicsOverlay.fetch()
      • DemographicsOverlayResult
        • DemographicsOverlayResult.geoid
        • DemographicsOverlayResult.time_series
        • DemographicsOverlayResult.geoids_queried
        • DemographicsOverlayResult.geoid
        • DemographicsOverlayResult.time_series
        • DemographicsOverlayResult.geoids_queried
        • DemographicsOverlayResult.years
        • DemographicsOverlayResult.has_data
        • DemographicsOverlayResult.for_year()
        • DemographicsOverlayResult.population_series()
        • DemographicsOverlayResult.__init__()
      • DictDemographicsProvider
        • DictDemographicsProvider.__init__()
        • DictDemographicsProvider.add()
        • DictDemographicsProvider.get_snapshots()
      • DictElectionDataProvider
        • DictElectionDataProvider.__init__()
        • DictElectionDataProvider.add()
        • DictElectionDataProvider.get_election_returns()
      • ElectionDataProvider
        • ElectionDataProvider.get_election_returns()
      • ElectionResultsOverlay
        • ElectionResultsOverlay.__init__()
        • ElectionResultsOverlay.name
        • ElectionResultsOverlay.fetch()
        • ElectionResultsOverlay.is_available()
      • ElectionResultsOverlayResult
        • ElectionResultsOverlayResult.geoid
        • ElectionResultsOverlayResult.returns
        • ElectionResultsOverlayResult.election_years
        • ElectionResultsOverlayResult.offices
        • ElectionResultsOverlayResult.geoid
        • ElectionResultsOverlayResult.returns
        • ElectionResultsOverlayResult.election_years
        • ElectionResultsOverlayResult.offices
        • ElectionResultsOverlayResult.for_year()
        • ElectionResultsOverlayResult.for_office()
        • ElectionResultsOverlayResult.for_year_office()
        • ElectionResultsOverlayResult.party_totals()
        • ElectionResultsOverlayResult.__init__()
      • ElectionReturn
        • ElectionReturn.precinct_id
        • ElectionReturn.election_year
        • ElectionReturn.election_type
        • ElectionReturn.office
        • ElectionReturn.candidate
        • ElectionReturn.party
        • ElectionReturn.votes
        • ElectionReturn.total_votes
        • ElectionReturn.vote_share
        • ElectionReturn.state
        • ElectionReturn.reconciliation_method
        • ElectionReturn.precinct_id
        • ElectionReturn.election_year
        • ElectionReturn.election_type
        • ElectionReturn.office
        • ElectionReturn.candidate
        • ElectionReturn.party
        • ElectionReturn.votes
        • ElectionReturn.total_votes
        • ElectionReturn.vote_share
        • ElectionReturn.state
        • ElectionReturn.reconciliation_method
        • ElectionReturn.__init__()
      • DictEventsProvider
        • DictEventsProvider.__init__()
        • DictEventsProvider.add()
        • DictEventsProvider.get_events()
      • EventRecord
        • EventRecord.event_id
        • EventRecord.event_type
        • EventRecord.title
        • EventRecord.description
        • EventRecord.date
        • EventRecord.end_date
        • EventRecord.geoids_affected
        • EventRecord.source
        • EventRecord.metadata
        • EventRecord.event_id
        • EventRecord.event_type
        • EventRecord.title
        • EventRecord.description
        • EventRecord.date
        • EventRecord.end_date
        • EventRecord.geoids_affected
        • EventRecord.source
        • EventRecord.metadata
        • EventRecord.year
        • EventRecord.has_duration
        • EventRecord.__init__()
      • EventsDataProvider
        • EventsDataProvider.get_events()
      • EventsOverlay
        • EventsOverlay.__init__()
        • EventsOverlay.name
        • EventsOverlay.fetch()
      • EventsOverlayResult
        • EventsOverlayResult.geoid
        • EventsOverlayResult.events
        • EventsOverlayResult.geoid
        • EventsOverlayResult.events
        • EventsOverlayResult.has_events
        • EventsOverlayResult.event_types
        • EventsOverlayResult.for_type()
        • EventsOverlayResult.count
        • EventsOverlayResult.__init__()
      • DictRedistrictingDataProvider
        • DictRedistrictingDataProvider.__init__()
        • DictRedistrictingDataProvider.add()
        • DictRedistrictingDataProvider.get_district_assignments()
      • DistrictAssignment
        • DistrictAssignment.plan_id
        • DistrictAssignment.plan_name
        • DistrictAssignment.plan_type
        • DistrictAssignment.district_id
        • DistrictAssignment.state
        • DistrictAssignment.from_date
        • DistrictAssignment.to_date
        • DistrictAssignment.enacted_by
        • DistrictAssignment.court_case
        • DistrictAssignment.containment_pct
        • DistrictAssignment.plan_id
        • DistrictAssignment.plan_name
        • DistrictAssignment.plan_type
        • DistrictAssignment.district_id
        • DistrictAssignment.state
        • DistrictAssignment.from_date
        • DistrictAssignment.to_date
        • DistrictAssignment.enacted_by
        • DistrictAssignment.court_case
        • DistrictAssignment.containment_pct
        • DistrictAssignment.__init__()
      • RedistrictingDataProvider
        • RedistrictingDataProvider.get_district_assignments()
      • RedistrictingOverlay
        • RedistrictingOverlay.__init__()
        • RedistrictingOverlay.name
        • RedistrictingOverlay.fetch()
        • RedistrictingOverlay.is_available()
      • RedistrictingOverlayResult
        • RedistrictingOverlayResult.geoid
        • RedistrictingOverlayResult.assignments
        • RedistrictingOverlayResult.plan_count
        • RedistrictingOverlayResult.had_court_intervention
        • RedistrictingOverlayResult.geoid
        • RedistrictingOverlayResult.assignments
        • RedistrictingOverlayResult.plan_count
        • RedistrictingOverlayResult.had_court_intervention
        • RedistrictingOverlayResult.plan_types
        • RedistrictingOverlayResult.for_plan_type()
        • RedistrictingOverlayResult.active_at()
        • RedistrictingOverlayResult.__init__()
      • DictSeatsProvider
        • DictSeatsProvider.__init__()
        • DictSeatsProvider.add()
        • DictSeatsProvider.get_assignments()
      • SeatAssignment
        • SeatAssignment.seat_label
        • SeatAssignment.office
        • SeatAssignment.district_label
        • SeatAssignment.state_fips
        • SeatAssignment.plan_name
        • SeatAssignment.plan_year
        • SeatAssignment.from_year
        • SeatAssignment.to_year
        • SeatAssignment.containment_pct
        • SeatAssignment.seat_label
        • SeatAssignment.office
        • SeatAssignment.district_label
        • SeatAssignment.state_fips
        • SeatAssignment.plan_name
        • SeatAssignment.plan_year
        • SeatAssignment.from_year
        • SeatAssignment.to_year
        • SeatAssignment.containment_pct
        • SeatAssignment.__init__()
      • SeatsDataProvider
        • SeatsDataProvider.get_assignments()
      • SeatsOverlay
        • SeatsOverlay.__init__()
        • SeatsOverlay.name
        • SeatsOverlay.fetch()
      • SeatsOverlayResult
        • SeatsOverlayResult.geoid
        • SeatsOverlayResult.assignments
        • SeatsOverlayResult.current_districts
        • SeatsOverlayResult.geoid
        • SeatsOverlayResult.assignments
        • SeatsOverlayResult.current_districts
        • SeatsOverlayResult.offices
        • SeatsOverlayResult.for_office()
        • SeatsOverlayResult.__init__()
      • DictUrbanicityProvider
        • DictUrbanicityProvider.__init__()
        • DictUrbanicityProvider.add()
        • DictUrbanicityProvider.classify()
      • UrbanicityDataProvider
        • UrbanicityDataProvider.classify()
      • UrbanicityOverlay
        • UrbanicityOverlay.__init__()
        • UrbanicityOverlay.name
        • UrbanicityOverlay.fetch()
      • UrbanicityOverlayResult
        • UrbanicityOverlayResult.geoid
        • UrbanicityOverlayResult.classifications
        • UrbanicityOverlayResult.geoid
        • UrbanicityOverlayResult.classifications
        • UrbanicityOverlayResult.years
        • UrbanicityOverlayResult.has_data
        • UrbanicityOverlayResult.for_year()
        • UrbanicityOverlayResult.changed
        • UrbanicityOverlayResult.current_category
        • UrbanicityOverlayResult.__init__()
      • UrbanicityPoint
        • UrbanicityPoint.year
        • UrbanicityPoint.geoid
        • UrbanicityPoint.locale_code
        • UrbanicityPoint.locale_label
        • UrbanicityPoint.category
        • UrbanicityPoint.size
        • UrbanicityPoint.year
        • UrbanicityPoint.geoid
        • UrbanicityPoint.locale_code
        • UrbanicityPoint.locale_label
        • UrbanicityPoint.category
        • UrbanicityPoint.size
        • UrbanicityPoint.__init__()
    • Redistricting and Plans
      • PlanAuthority
        • PlanAuthority.LEGISLATURE
        • PlanAuthority.COURT
        • PlanAuthority.COMMISSION
        • PlanAuthority.DEFAULT
        • PlanAuthority.__new__()
      • PlanDistrict
        • PlanDistrict.state_fips
        • PlanDistrict.district_type
        • PlanDistrict.district_id
        • PlanDistrict.plan_name
        • PlanDistrict.authority
        • PlanDistrict.effective_from
        • PlanDistrict.effective_to
        • PlanDistrict.geometry_source
        • PlanDistrict.notes
        • PlanDistrict.state_fips
        • PlanDistrict.district_type
        • PlanDistrict.district_id
        • PlanDistrict.plan_name
        • PlanDistrict.authority
        • PlanDistrict.effective_from
        • PlanDistrict.effective_to
        • PlanDistrict.geometry_source
        • PlanDistrict.notes
        • PlanDistrict.covers_date()
        • PlanDistrict.__init__()
      • RedistrictingPlan
        • RedistrictingPlan.plan_name
        • RedistrictingPlan.state_fips
        • RedistrictingPlan.district_type
        • RedistrictingPlan.authority
        • RedistrictingPlan.effective_from
        • RedistrictingPlan.effective_to
        • RedistrictingPlan.districts
        • RedistrictingPlan.metadata
        • RedistrictingPlan.plan_name
        • RedistrictingPlan.state_fips
        • RedistrictingPlan.district_type
        • RedistrictingPlan.authority
        • RedistrictingPlan.effective_from
        • RedistrictingPlan.effective_to
        • RedistrictingPlan.districts
        • RedistrictingPlan.metadata
        • RedistrictingPlan.covers_date()
        • RedistrictingPlan.district()
        • RedistrictingPlan.__init__()
      • PlanRegistry
        • PlanRegistry.__init__()
        • PlanRegistry.register_plan()
        • PlanRegistry.register_plans()
        • PlanRegistry.clear()
        • PlanRegistry.plans_for_state()
        • PlanRegistry.resolve_plan_at_date()
        • PlanRegistry.resolve_district_at_date()
      • PlanResolutionError
      • PlanOverlapError
      • get_default_plan_registry()
      • PlanAuthority
        • PlanAuthority.LEGISLATURE
        • PlanAuthority.COURT
        • PlanAuthority.COMMISSION
        • PlanAuthority.DEFAULT
        • PlanAuthority.__new__()
      • PlanDistrict
        • PlanDistrict.state_fips
        • PlanDistrict.district_type
        • PlanDistrict.district_id
        • PlanDistrict.plan_name
        • PlanDistrict.authority
        • PlanDistrict.effective_from
        • PlanDistrict.effective_to
        • PlanDistrict.geometry_source
        • PlanDistrict.notes
        • PlanDistrict.state_fips
        • PlanDistrict.district_type
        • PlanDistrict.district_id
        • PlanDistrict.plan_name
        • PlanDistrict.authority
        • PlanDistrict.effective_from
        • PlanDistrict.effective_to
        • PlanDistrict.geometry_source
        • PlanDistrict.notes
        • PlanDistrict.covers_date()
        • PlanDistrict.__init__()
      • RedistrictingPlan
        • RedistrictingPlan.plan_name
        • RedistrictingPlan.state_fips
        • RedistrictingPlan.district_type
        • RedistrictingPlan.authority
        • RedistrictingPlan.effective_from
        • RedistrictingPlan.effective_to
        • RedistrictingPlan.districts
        • RedistrictingPlan.metadata
        • RedistrictingPlan.plan_name
        • RedistrictingPlan.state_fips
        • RedistrictingPlan.district_type
        • RedistrictingPlan.authority
        • RedistrictingPlan.effective_from
        • RedistrictingPlan.effective_to
        • RedistrictingPlan.districts
        • RedistrictingPlan.metadata
        • RedistrictingPlan.covers_date()
        • RedistrictingPlan.district()
        • RedistrictingPlan.__init__()
      • PlanRegistry
        • PlanRegistry.__init__()
        • PlanRegistry.register_plan()
        • PlanRegistry.register_plans()
        • PlanRegistry.clear()
        • PlanRegistry.plans_for_state()
        • PlanRegistry.resolve_plan_at_date()
        • PlanRegistry.resolve_district_at_date()
      • PlanResolutionError
      • PlanOverlapError
      • get_default_plan_registry()
      • DictPlanLifecycleProvider
        • DictPlanLifecycleProvider.__init__()
        • DictPlanLifecycleProvider.add()
        • DictPlanLifecycleProvider.get_plans()
        • DictPlanLifecycleProvider.get_plan()
      • EnactedBy
        • EnactedBy.LEGISLATURE
        • EnactedBy.COMMISSION
        • EnactedBy.COURT
        • EnactedBy.SPECIAL_MASTER
        • EnactedBy.__new__()
      • PlanLifecycleEvent
        • PlanLifecycleEvent.plan_id
        • PlanLifecycleEvent.status
        • PlanLifecycleEvent.effective_date
        • PlanLifecycleEvent.source
        • PlanLifecycleEvent.notes
        • PlanLifecycleEvent.court_case
        • PlanLifecycleEvent.plan_id
        • PlanLifecycleEvent.status
        • PlanLifecycleEvent.effective_date
        • PlanLifecycleEvent.source
        • PlanLifecycleEvent.notes
        • PlanLifecycleEvent.court_case
        • PlanLifecycleEvent.__init__()
      • PlanLifecycleProvider
        • PlanLifecycleProvider.get_plans()
        • PlanLifecycleProvider.get_plan()
      • PlanLifecycleStatus
        • PlanLifecycleStatus.PROPOSED
        • PlanLifecycleStatus.ADOPTED
        • PlanLifecycleStatus.ENACTED
        • PlanLifecycleStatus.CHALLENGED
        • PlanLifecycleStatus.STAYED
        • PlanLifecycleStatus.STRUCK
        • PlanLifecycleStatus.SUPERSEDED
        • PlanLifecycleStatus.EXPIRED
        • PlanLifecycleStatus.__new__()
      • PlanLineage
        • PlanLineage.plans
        • PlanLineage.state
        • PlanLineage.plan_type
        • PlanLineage.plans
        • PlanLineage.state
        • PlanLineage.plan_type
        • PlanLineage.current_plan
        • PlanLineage.plan_at()
        • PlanLineage.__init__()
      • PlanType
        • PlanType.CONGRESSIONAL
        • PlanType.STATE_SENATE
        • PlanType.STATE_HOUSE
        • PlanType.__new__()
      • RedistrictingPlan
        • RedistrictingPlan.plan_id
        • RedistrictingPlan.state
        • RedistrictingPlan.plan_type
        • RedistrictingPlan.plan_name
        • RedistrictingPlan.enacted_by
        • RedistrictingPlan.enacted_date
        • RedistrictingPlan.supersedes_id
        • RedistrictingPlan.court_case
        • RedistrictingPlan.events
        • RedistrictingPlan.plan_id
        • RedistrictingPlan.state
        • RedistrictingPlan.plan_type
        • RedistrictingPlan.plan_name
        • RedistrictingPlan.enacted_by
        • RedistrictingPlan.enacted_date
        • RedistrictingPlan.supersedes_id
        • RedistrictingPlan.court_case
        • RedistrictingPlan.events
        • RedistrictingPlan.current_status
        • RedistrictingPlan.latest_event
        • RedistrictingPlan.is_terminal
        • RedistrictingPlan.is_active
        • RedistrictingPlan.status_at()
        • RedistrictingPlan.was_active_at()
        • RedistrictingPlan.to_dict()
        • RedistrictingPlan.__init__()
      • build_lineage()
      • resolve_plan_at()
      • ConfidenceLevel
        • ConfidenceLevel.HIGH
        • ConfidenceLevel.MEDIUM
        • ConfidenceLevel.LOW
        • ConfidenceLevel.__new__()
      • DictNameMatchProvider
        • DictNameMatchProvider.__init__()
        • DictNameMatchProvider.add_precinct()
        • DictNameMatchProvider.add_vtd()
        • DictNameMatchProvider.get_precinct_names()
        • DictNameMatchProvider.get_vtd_names()
      • DictSpatialOverlapProvider
        • DictSpatialOverlapProvider.__init__()
        • DictSpatialOverlapProvider.add()
        • DictSpatialOverlapProvider.compute_overlaps()
      • NameMatchProvider
        • NameMatchProvider.get_precinct_names()
        • NameMatchProvider.get_vtd_names()
      • OfficialCrosswalkEntry
        • OfficialCrosswalkEntry.precinct_id
        • OfficialCrosswalkEntry.vtd_geoid
        • OfficialCrosswalkEntry.state
        • OfficialCrosswalkEntry.county
        • OfficialCrosswalkEntry.source
        • OfficialCrosswalkEntry.precinct_id
        • OfficialCrosswalkEntry.vtd_geoid
        • OfficialCrosswalkEntry.state
        • OfficialCrosswalkEntry.county
        • OfficialCrosswalkEntry.source
        • OfficialCrosswalkEntry.__init__()
      • PrecinctVTDMapping
        • PrecinctVTDMapping.precinct_id
        • PrecinctVTDMapping.vtd_geoid
        • PrecinctVTDMapping.overlap_pct
        • PrecinctVTDMapping.confidence
        • PrecinctVTDMapping.confidence_level
        • PrecinctVTDMapping.method
        • PrecinctVTDMapping.name_similarity
        • PrecinctVTDMapping.notes
        • PrecinctVTDMapping.precinct_id
        • PrecinctVTDMapping.vtd_geoid
        • PrecinctVTDMapping.overlap_pct
        • PrecinctVTDMapping.confidence
        • PrecinctVTDMapping.confidence_level
        • PrecinctVTDMapping.method
        • PrecinctVTDMapping.name_similarity
        • PrecinctVTDMapping.notes
        • PrecinctVTDMapping.to_dict()
        • PrecinctVTDMapping.__init__()
      • PrecinctVTDReconciler
        • PrecinctVTDReconciler.__init__()
        • PrecinctVTDReconciler.reconcile()
      • ReconciliationMethod
        • ReconciliationMethod.SPATIAL
        • ReconciliationMethod.NAME_MATCH
        • ReconciliationMethod.OFFICIAL_CROSSWALK
        • ReconciliationMethod.COMBINED
        • ReconciliationMethod.__new__()
      • ReconciliationResult
        • ReconciliationResult.mappings
        • ReconciliationResult.total_precincts
        • ReconciliationResult.matched_precincts
        • ReconciliationResult.unmatched_precincts
        • ReconciliationResult.method_counts
        • ReconciliationResult.errors
        • ReconciliationResult.mappings
        • ReconciliationResult.total_precincts
        • ReconciliationResult.matched_precincts
        • ReconciliationResult.unmatched_precincts
        • ReconciliationResult.method_counts
        • ReconciliationResult.errors
        • ReconciliationResult.match_rate
        • ReconciliationResult.high_confidence_count
        • ReconciliationResult.for_precinct()
        • ReconciliationResult.to_dict()
        • ReconciliationResult.__init__()
      • SpatialOverlap
        • SpatialOverlap.precinct_id
        • SpatialOverlap.vtd_geoid
        • SpatialOverlap.overlap_area
        • SpatialOverlap.precinct_area
        • SpatialOverlap.vtd_area
        • SpatialOverlap.overlap_pct
        • SpatialOverlap.precinct_id
        • SpatialOverlap.vtd_geoid
        • SpatialOverlap.overlap_area
        • SpatialOverlap.precinct_area
        • SpatialOverlap.vtd_area
        • SpatialOverlap.overlap_pct
        • SpatialOverlap.__init__()
      • SpatialOverlapProvider
        • SpatialOverlapProvider.compute_overlaps()
      • reconcile_names()
      • reconcile_official()
      • reconcile_spatial()
    • Codification
      • BlockProfile
        • BlockProfile.block_geoid
        • BlockProfile.tract_geoid
        • BlockProfile.county_geoid
        • BlockProfile.state_geoid
        • BlockProfile.address_count
        • BlockProfile.demographics
        • BlockProfile.urbanicity
        • BlockProfile.recency
        • BlockProfile.block_geoid
        • BlockProfile.tract_geoid
        • BlockProfile.county_geoid
        • BlockProfile.state_geoid
        • BlockProfile.address_count
        • BlockProfile.demographics
        • BlockProfile.urbanicity
        • BlockProfile.recency
        • BlockProfile.__init__()
      • CodificationResult
        • CodificationResult.total_addresses
        • CodificationResult.matched_addresses
        • CodificationResult.match_rate
        • CodificationResult.blocks
        • CodificationResult.geocoding_backend
        • CodificationResult.census_year
        • CodificationResult.errors
        • CodificationResult.total_addresses
        • CodificationResult.matched_addresses
        • CodificationResult.match_rate
        • CodificationResult.blocks
        • CodificationResult.geocoding_backend
        • CodificationResult.census_year
        • CodificationResult.errors
        • CodificationResult.block_count
        • CodificationResult.tract_count
        • CodificationResult.county_count
        • CodificationResult.state_count
        • CodificationResult.top_blocks()
        • CodificationResult.summarize()
        • CodificationResult.__init__()
      • codify_area()
      • BlockAssignment
        • BlockAssignment.block_geoid
        • BlockAssignment.tract_geoid
        • BlockAssignment.county_geoid
        • BlockAssignment.state_geoid
        • BlockAssignment.lat
        • BlockAssignment.lon
        • BlockAssignment.input_id
        • BlockAssignment.block_geoid
        • BlockAssignment.tract_geoid
        • BlockAssignment.county_geoid
        • BlockAssignment.state_geoid
        • BlockAssignment.lat
        • BlockAssignment.lon
        • BlockAssignment.input_id
        • BlockAssignment.__init__()
      • BlockGroup
        • BlockGroup.block_geoid
        • BlockGroup.tract_geoid
        • BlockGroup.county_geoid
        • BlockGroup.state_geoid
        • BlockGroup.address_count
        • BlockGroup.centroid_lat
        • BlockGroup.centroid_lon
        • BlockGroup.block_geoid
        • BlockGroup.tract_geoid
        • BlockGroup.county_geoid
        • BlockGroup.state_geoid
        • BlockGroup.address_count
        • BlockGroup.centroid_lat
        • BlockGroup.centroid_lon
        • BlockGroup.__init__()
      • SpreadMetrics
        • SpreadMetrics.block_count
        • SpreadMetrics.tract_count
        • SpreadMetrics.county_count
        • SpreadMetrics.state_count
        • SpreadMetrics.concentration
        • SpreadMetrics.max_block_pct
        • SpreadMetrics.bbox_lat_range
        • SpreadMetrics.bbox_lon_range
        • SpreadMetrics.block_count
        • SpreadMetrics.tract_count
        • SpreadMetrics.county_count
        • SpreadMetrics.state_count
        • SpreadMetrics.concentration
        • SpreadMetrics.max_block_pct
        • SpreadMetrics.bbox_lat_range
        • SpreadMetrics.bbox_lon_range
        • SpreadMetrics.__init__()
      • assign_blocks()
      • group_by_block()
      • compute_spread()
      • BlockDemographics
        • BlockDemographics.block_geoid
        • BlockDemographics.total_population
        • BlockDemographics.voting_age_population
        • BlockDemographics.white
        • BlockDemographics.black
        • BlockDemographics.hispanic
        • BlockDemographics.asian
        • BlockDemographics.other_race
        • BlockDemographics.housing_total
        • BlockDemographics.housing_occupied
        • BlockDemographics.housing_vacant
        • BlockDemographics.block_geoid
        • BlockDemographics.total_population
        • BlockDemographics.voting_age_population
        • BlockDemographics.white
        • BlockDemographics.black
        • BlockDemographics.hispanic
        • BlockDemographics.asian
        • BlockDemographics.other_race
        • BlockDemographics.housing_total
        • BlockDemographics.housing_occupied
        • BlockDemographics.housing_vacant
        • BlockDemographics.__init__()
      • DemographicSignature
        • DemographicSignature.total_block_population
        • DemographicSignature.weighted_blocks
        • DemographicSignature.pct_white
        • DemographicSignature.pct_black
        • DemographicSignature.pct_hispanic
        • DemographicSignature.pct_asian
        • DemographicSignature.pct_other
        • DemographicSignature.pct_voting_age
        • DemographicSignature.pct_housing_occupied
        • DemographicSignature.pct_housing_vacant
        • DemographicSignature.total_block_population
        • DemographicSignature.weighted_blocks
        • DemographicSignature.pct_white
        • DemographicSignature.pct_black
        • DemographicSignature.pct_hispanic
        • DemographicSignature.pct_asian
        • DemographicSignature.pct_other
        • DemographicSignature.pct_voting_age
        • DemographicSignature.pct_housing_occupied
        • DemographicSignature.pct_housing_vacant
        • DemographicSignature.__init__()
      • BlockDemographicsProvider
        • BlockDemographicsProvider.get_demographics()
      • DictBlockDemographicsProvider
        • DictBlockDemographicsProvider.__init__()
        • DictBlockDemographicsProvider.add()
        • DictBlockDemographicsProvider.get_demographics()
      • compute_demographic_signature()
      • AddressVintage
        • AddressVintage.input_id
        • AddressVintage.first_vintage
        • AddressVintage.present_in
        • AddressVintage.input_id
        • AddressVintage.first_vintage
        • AddressVintage.present_in
        • AddressVintage.is_new_construction
        • AddressVintage.__init__()
      • RecencyAnalysis
        • RecencyAnalysis.total_analyzed
        • RecencyAnalysis.vintage_distribution
        • RecencyAnalysis.vintage_pct
        • RecencyAnalysis.new_construction_count
        • RecencyAnalysis.new_construction_pct
        • RecencyAnalysis.median_vintage
        • RecencyAnalysis.total_analyzed
        • RecencyAnalysis.vintage_distribution
        • RecencyAnalysis.vintage_pct
        • RecencyAnalysis.new_construction_count
        • RecencyAnalysis.new_construction_pct
        • RecencyAnalysis.median_vintage
        • RecencyAnalysis.__init__()
      • AddressVintageProvider
        • AddressVintageProvider.get_vintages()
      • DictAddressVintageProvider
        • DictAddressVintageProvider.__init__()
        • DictAddressVintageProvider.add()
        • DictAddressVintageProvider.get_vintages()
      • compute_recency()
      • AreaPortrait
        • AreaPortrait.geocoding_summary
        • AreaPortrait.spread
        • AreaPortrait.demographics
        • AreaPortrait.urbanicity
        • AreaPortrait.recency
        • AreaPortrait.top_blocks
        • AreaPortrait.headline_metrics()
        • AreaPortrait.to_dict()
        • AreaPortrait.__init__()
      • build_portrait()
      • BlockLocale
        • BlockLocale.block_geoid
        • BlockLocale.locale_code
        • BlockLocale.locale_label
        • BlockLocale.category
        • BlockLocale.block_geoid
        • BlockLocale.locale_code
        • BlockLocale.locale_label
        • BlockLocale.category
        • BlockLocale.__init__()
      • UrbanicityDistribution
        • UrbanicityDistribution.total_classified
        • UrbanicityDistribution.distribution
        • UrbanicityDistribution.category_distribution
        • UrbanicityDistribution.dominant_locale
        • UrbanicityDistribution.dominant_category
        • UrbanicityDistribution.total_classified
        • UrbanicityDistribution.distribution
        • UrbanicityDistribution.category_distribution
        • UrbanicityDistribution.dominant_locale
        • UrbanicityDistribution.dominant_category
        • UrbanicityDistribution.__init__()
      • BlockLocaleProvider
        • BlockLocaleProvider.classify_blocks()
      • DictBlockLocaleProvider
        • DictBlockLocaleProvider.__init__()
        • DictBlockLocaleProvider.add()
        • DictBlockLocaleProvider.classify_blocks()
      • compute_urbanicity_distribution()
    • Schemas
      • TemporalGeographicFeatureSchema
        • TemporalGeographicFeatureSchema.valid_from
        • TemporalGeographicFeatureSchema.valid_to
        • TemporalGeographicFeatureSchema.model_config
      • TemporalBoundarySchema
        • TemporalBoundarySchema.area_land
        • TemporalBoundarySchema.area_water
        • TemporalBoundarySchema.internal_point_wkt
        • TemporalBoundarySchema.sync_ids()
      • CensusTIGERSchema
        • CensusTIGERSchema.sync_from_geoid()
      • StateSchema
      • CountySchema
      • TractSchema
      • BlockGroupSchema
      • BlockSchema
      • PlaceSchema
      • ZCTASchema
      • CongressionalDistrictSchema
        • CongressionalDistrictSchema.congress_number
      • StateLegislativeUpperSchema
      • StateLegislativeLowerSchema
      • VTDSchema
        • VTDSchema.registered_voters
      • PrecinctSchema
      • GADMBoundarySchema
      • GADMCountrySchema
      • GADMAdmin1Schema
      • GADMAdmin2Schema
      • GADMAdmin3Schema
      • GADMAdmin4Schema
      • GADMAdmin5Schema
      • SchoolDistrictBaseSchema
      • SchoolDistrictElementarySchema
      • SchoolDistrictSecondarySchema
      • SchoolDistrictUnifiedSchema
      • NCESLocaleBoundarySchema
      • SchoolLocationSchema
      • NLRBRegionSchema
        • NLRBRegionSchema.region_number
      • FederalJudicialDistrictSchema
        • FederalJudicialDistrictSchema.circuit_number
      • BoundaryIntersectionSchema
        • BoundaryIntersectionSchema.intersection_area
        • BoundaryIntersectionSchema.pct_of_source
        • BoundaryIntersectionSchema.pct_of_target
        • BoundaryIntersectionSchema.is_dominant
        • BoundaryIntersectionSchema.model_config
      • CountyCDIntersectionSchema
        • CountyCDIntersectionSchema.county_id
        • CountyCDIntersectionSchema.congressional_district_id
        • CountyCDIntersectionSchema.vintage_year
        • CountyCDIntersectionSchema.intersection_area
        • CountyCDIntersectionSchema.pct_of_county
        • CountyCDIntersectionSchema.pct_of_cd
        • CountyCDIntersectionSchema.is_dominant
        • CountyCDIntersectionSchema.model_config
      • VTDCDIntersectionSchema
        • VTDCDIntersectionSchema.vtd_id
        • VTDCDIntersectionSchema.congressional_district_id
        • VTDCDIntersectionSchema.vintage_year
        • VTDCDIntersectionSchema.intersection_area
        • VTDCDIntersectionSchema.pct_of_vtd
        • VTDCDIntersectionSchema.pct_of_cd
        • VTDCDIntersectionSchema.is_dominant
        • VTDCDIntersectionSchema.model_config
      • TractCDIntersectionSchema
        • TractCDIntersectionSchema.tract_id
        • TractCDIntersectionSchema.congressional_district_id
        • TractCDIntersectionSchema.vintage_year
        • TractCDIntersectionSchema.intersection_area
        • TractCDIntersectionSchema.pct_of_tract
        • TractCDIntersectionSchema.pct_of_cd
        • TractCDIntersectionSchema.is_dominant
        • TractCDIntersectionSchema.model_config
      • TemporalCrosswalkSchema
        • TemporalCrosswalkSchema.source_population
        • TemporalCrosswalkSchema.target_population
        • TemporalCrosswalkSchema.allocated_population
        • TemporalCrosswalkSchema.area_sq_meters
        • TemporalCrosswalkSchema.model_config
      • DemographicVariableSchema
        • DemographicVariableSchema.concept
        • DemographicVariableSchema.predicate_type
        • DemographicVariableSchema.group
        • DemographicVariableSchema.universe
        • DemographicVariableSchema.model_config
        • DemographicVariableSchema.is_estimate
        • DemographicVariableSchema.is_moe
        • DemographicVariableSchema.base_code
      • DemographicSnapshotSchema
        • DemographicSnapshotSchema.vintage
        • DemographicSnapshotSchema.total_population
        • DemographicSnapshotSchema.median_household_income
        • DemographicSnapshotSchema.median_age
        • DemographicSnapshotSchema.source_url
        • DemographicSnapshotSchema.model_config
        • DemographicSnapshotSchema.auto_populate_summaries()
        • DemographicSnapshotSchema.get_value()
        • DemographicSnapshotSchema.get_moe()
      • DemographicTimeSeriesSchema
        • DemographicTimeSeriesSchema.start_year
        • DemographicTimeSeriesSchema.end_year
        • DemographicTimeSeriesSchema.years
        • DemographicTimeSeriesSchema.values
        • DemographicTimeSeriesSchema.mean_value
        • DemographicTimeSeriesSchema.std_dev
        • DemographicTimeSeriesSchema.cagr
        • DemographicTimeSeriesSchema.trend_direction
        • DemographicTimeSeriesSchema.model_config
      • RedistrictingPlanSchema
        • RedistrictingPlanSchema.source_url
        • RedistrictingPlanSchema.num_districts
        • RedistrictingPlanSchema.enacted_date
        • RedistrictingPlanSchema.effective_from
        • RedistrictingPlanSchema.effective_to
        • RedistrictingPlanSchema.superseded_by_id
        • RedistrictingPlanSchema.court_case
        • RedistrictingPlanSchema.model_config
        • RedistrictingPlanSchema.validate_effective_range()
      • PlanDistrictSchema
        • PlanDistrictSchema.plan_id
        • PlanDistrictSchema.total_population
        • PlanDistrictSchema.vap
        • PlanDistrictSchema.cvap
        • PlanDistrictSchema.deviation_pct
      • DistrictDemographicsSchema
        • DistrictDemographicsSchema.district_id
        • DistrictDemographicsSchema.pop_white
        • DistrictDemographicsSchema.pop_black
        • DistrictDemographicsSchema.pop_hispanic
        • DistrictDemographicsSchema.pop_asian
        • DistrictDemographicsSchema.pop_native
        • DistrictDemographicsSchema.pop_other
        • DistrictDemographicsSchema.pop_two_or_more
        • DistrictDemographicsSchema.median_household_income
        • DistrictDemographicsSchema.model_config
        • DistrictDemographicsSchema.auto_populate_race_from_values()
      • PrecinctElectionResultSchema
        • PrecinctElectionResultSchema.votes
        • PrecinctElectionResultSchema.total_votes
        • PrecinctElectionResultSchema.model_config
      • CongressionalTermSchema
        • CongressionalTermSchema.start_date
        • CongressionalTermSchema.end_date
        • CongressionalTermSchema.election_year
        • CongressionalTermSchema.is_presidential
        • CongressionalTermSchema.model_config
      • SeatSchema
        • SeatSchema.is_active
        • SeatSchema.model_config
      • StateElectionCalendarSchema
        • StateElectionCalendarSchema.primary_date
        • StateElectionCalendarSchema.primary_runoff_date
        • StateElectionCalendarSchema.general_date
        • StateElectionCalendarSchema.general_runoff_date
        • StateElectionCalendarSchema.registration_deadline
        • StateElectionCalendarSchema.early_voting_start
        • StateElectionCalendarSchema.early_voting_end
        • StateElectionCalendarSchema.mail_ballot_request_deadline
        • StateElectionCalendarSchema.mail_ballot_return_deadline
        • StateElectionCalendarSchema.certification_deadline
        • StateElectionCalendarSchema.model_config
      • RaceSchema
        • RaceSchema.seat_id
        • RaceSchema.is_special
        • RaceSchema.model_config
      • RaceEventSchema
        • RaceEventSchema.race_id
        • RaceEventSchema.event_date
        • RaceEventSchema.event_start
        • RaceEventSchema.event_end
        • RaceEventSchema.external_event_id
        • RaceEventSchema.notes
        • RaceEventSchema.model_config
      • SpatioTemporalEventSchema
        • SpatioTemporalEventSchema.event_start
        • SpatioTemporalEventSchema.event_end
        • SpatioTemporalEventSchema.description
        • SpatioTemporalEventSchema.model_config
      • ReturnSnapshotSchema
        • ReturnSnapshotSchema.race_id
        • ReturnSnapshotSchema.timestamp
        • ReturnSnapshotSchema.precincts_reporting
        • ReturnSnapshotSchema.total_precincts
        • ReturnSnapshotSchema.total_ballots_counted
        • ReturnSnapshotSchema.ballots_outstanding
        • ReturnSnapshotSchema.is_final
        • ReturnSnapshotSchema.model_config
      • gdf_to_schemas()
      • schemas_to_gdf()
      • schemas_to_orm()
      • orm_to_gdf()
      • CensusTIGERSchema
        • CensusTIGERSchema.sync_from_geoid()
      • TemporalBoundarySchema
        • TemporalBoundarySchema.area_land
        • TemporalBoundarySchema.area_water
        • TemporalBoundarySchema.internal_point_wkt
        • TemporalBoundarySchema.sync_ids()
      • TemporalGeographicFeatureSchema
        • TemporalGeographicFeatureSchema.valid_from
        • TemporalGeographicFeatureSchema.valid_to
        • TemporalGeographicFeatureSchema.model_config
      • BlockGroupSchema
      • BlockSchema
      • CongressionalDistrictSchema
        • CongressionalDistrictSchema.congress_number
      • CountySchema
      • PlaceSchema
      • StateSchema
      • TractSchema
      • ZCTASchema
      • gdf_to_schemas()
      • orm_to_gdf()
      • schemas_to_gdf()
      • schemas_to_orm()
      • TemporalCrosswalkSchema
        • TemporalCrosswalkSchema.source_population
        • TemporalCrosswalkSchema.target_population
        • TemporalCrosswalkSchema.allocated_population
        • TemporalCrosswalkSchema.area_sq_meters
        • TemporalCrosswalkSchema.model_config
      • DemographicSnapshotSchema
        • DemographicSnapshotSchema.vintage
        • DemographicSnapshotSchema.total_population
        • DemographicSnapshotSchema.median_household_income
        • DemographicSnapshotSchema.median_age
        • DemographicSnapshotSchema.source_url
        • DemographicSnapshotSchema.model_config
        • DemographicSnapshotSchema.auto_populate_summaries()
        • DemographicSnapshotSchema.get_value()
        • DemographicSnapshotSchema.get_moe()
      • DemographicTimeSeriesSchema
        • DemographicTimeSeriesSchema.start_year
        • DemographicTimeSeriesSchema.end_year
        • DemographicTimeSeriesSchema.years
        • DemographicTimeSeriesSchema.values
        • DemographicTimeSeriesSchema.mean_value
        • DemographicTimeSeriesSchema.std_dev
        • DemographicTimeSeriesSchema.cagr
        • DemographicTimeSeriesSchema.trend_direction
        • DemographicTimeSeriesSchema.model_config
      • DemographicVariableSchema
        • DemographicVariableSchema.concept
        • DemographicVariableSchema.predicate_type
        • DemographicVariableSchema.group
        • DemographicVariableSchema.universe
        • DemographicVariableSchema.model_config
        • DemographicVariableSchema.is_estimate
        • DemographicVariableSchema.is_moe
        • DemographicVariableSchema.base_code
      • NCESLocaleBoundarySchema
      • SchoolDistrictBaseSchema
      • SchoolDistrictElementarySchema
      • SchoolDistrictSecondarySchema
      • SchoolDistrictUnifiedSchema
      • SchoolLocationSchema
      • FederalJudicialDistrictSchema
        • FederalJudicialDistrictSchema.circuit_number
      • NLRBRegionSchema
        • NLRBRegionSchema.region_number
      • GADMAdmin1Schema
      • GADMAdmin2Schema
      • GADMAdmin3Schema
      • GADMAdmin4Schema
      • GADMAdmin5Schema
      • GADMBoundarySchema
      • GADMCountrySchema
      • BoundaryIntersectionSchema
        • BoundaryIntersectionSchema.intersection_area
        • BoundaryIntersectionSchema.pct_of_source
        • BoundaryIntersectionSchema.pct_of_target
        • BoundaryIntersectionSchema.is_dominant
        • BoundaryIntersectionSchema.model_config
      • CountyCDIntersectionSchema
        • CountyCDIntersectionSchema.county_id
        • CountyCDIntersectionSchema.congressional_district_id
        • CountyCDIntersectionSchema.vintage_year
        • CountyCDIntersectionSchema.intersection_area
        • CountyCDIntersectionSchema.pct_of_county
        • CountyCDIntersectionSchema.pct_of_cd
        • CountyCDIntersectionSchema.is_dominant
        • CountyCDIntersectionSchema.model_config
      • TractCDIntersectionSchema
        • TractCDIntersectionSchema.tract_id
        • TractCDIntersectionSchema.congressional_district_id
        • TractCDIntersectionSchema.vintage_year
        • TractCDIntersectionSchema.intersection_area
        • TractCDIntersectionSchema.pct_of_tract
        • TractCDIntersectionSchema.pct_of_cd
        • TractCDIntersectionSchema.is_dominant
        • TractCDIntersectionSchema.model_config
      • VTDCDIntersectionSchema
        • VTDCDIntersectionSchema.vtd_id
        • VTDCDIntersectionSchema.congressional_district_id
        • VTDCDIntersectionSchema.vintage_year
        • VTDCDIntersectionSchema.intersection_area
        • VTDCDIntersectionSchema.pct_of_vtd
        • VTDCDIntersectionSchema.pct_of_cd
        • VTDCDIntersectionSchema.is_dominant
        • VTDCDIntersectionSchema.model_config
      • PrecinctSchema
      • StateLegislativeLowerSchema
      • StateLegislativeUpperSchema
      • VTDSchema
        • VTDSchema.registered_voters
      • DistrictDemographicsSchema
        • DistrictDemographicsSchema.district_id
        • DistrictDemographicsSchema.pop_white
        • DistrictDemographicsSchema.pop_black
        • DistrictDemographicsSchema.pop_hispanic
        • DistrictDemographicsSchema.pop_asian
        • DistrictDemographicsSchema.pop_native
        • DistrictDemographicsSchema.pop_other
        • DistrictDemographicsSchema.pop_two_or_more
        • DistrictDemographicsSchema.median_household_income
        • DistrictDemographicsSchema.model_config
        • DistrictDemographicsSchema.auto_populate_race_from_values()
      • PlanDistrictSchema
        • PlanDistrictSchema.plan_id
        • PlanDistrictSchema.total_population
        • PlanDistrictSchema.vap
        • PlanDistrictSchema.cvap
        • PlanDistrictSchema.deviation_pct
      • PrecinctElectionResultSchema
        • PrecinctElectionResultSchema.votes
        • PrecinctElectionResultSchema.total_votes
        • PrecinctElectionResultSchema.model_config
      • RedistrictingPlanSchema
        • RedistrictingPlanSchema.source_url
        • RedistrictingPlanSchema.num_districts
        • RedistrictingPlanSchema.enacted_date
        • RedistrictingPlanSchema.effective_from
        • RedistrictingPlanSchema.effective_to
        • RedistrictingPlanSchema.superseded_by_id
        • RedistrictingPlanSchema.court_case
        • RedistrictingPlanSchema.model_config
        • RedistrictingPlanSchema.validate_effective_range()
      • RaceEventSchema
        • RaceEventSchema.race_id
        • RaceEventSchema.event_date
        • RaceEventSchema.event_start
        • RaceEventSchema.event_end
        • RaceEventSchema.external_event_id
        • RaceEventSchema.notes
        • RaceEventSchema.model_config
      • RaceSchema
        • RaceSchema.seat_id
        • RaceSchema.is_special
        • RaceSchema.model_config
      • ReturnSnapshotSchema
        • ReturnSnapshotSchema.race_id
        • ReturnSnapshotSchema.timestamp
        • ReturnSnapshotSchema.precincts_reporting
        • ReturnSnapshotSchema.total_precincts
        • ReturnSnapshotSchema.total_ballots_counted
        • ReturnSnapshotSchema.ballots_outstanding
        • ReturnSnapshotSchema.is_final
        • ReturnSnapshotSchema.model_config
      • SpatioTemporalEventSchema
        • SpatioTemporalEventSchema.event_start
        • SpatioTemporalEventSchema.event_end
        • SpatioTemporalEventSchema.description
        • SpatioTemporalEventSchema.model_config
      • CongressionalTermSchema
        • CongressionalTermSchema.start_date
        • CongressionalTermSchema.end_date
        • CongressionalTermSchema.election_year
        • CongressionalTermSchema.is_presidential
        • CongressionalTermSchema.model_config
      • SeatSchema
        • SeatSchema.is_active
        • SeatSchema.model_config
      • StateElectionCalendarSchema
        • StateElectionCalendarSchema.primary_date
        • StateElectionCalendarSchema.primary_runoff_date
        • StateElectionCalendarSchema.general_date
        • StateElectionCalendarSchema.general_runoff_date
        • StateElectionCalendarSchema.registration_deadline
        • StateElectionCalendarSchema.early_voting_start
        • StateElectionCalendarSchema.early_voting_end
        • StateElectionCalendarSchema.mail_ballot_request_deadline
        • StateElectionCalendarSchema.mail_ballot_return_deadline
        • StateElectionCalendarSchema.certification_deadline
        • StateElectionCalendarSchema.model_config
    • Temporal and Timeseries
      • TemporalDataStore
        • TemporalDataStore.SUPPORTED_FORMATS
        • TemporalDataStore.__init__()
        • TemporalDataStore.save_boundaries()
        • TemporalDataStore.load_boundaries()
        • TemporalDataStore.query_boundaries_at_date()
        • TemporalDataStore.list_available_vintages()
        • TemporalDataStore.save_demographics()
        • TemporalDataStore.load_demographics()
        • TemporalDataStore.save_timeseries()
        • TemporalDataStore.load_timeseries()
      • get_temporal_store()
      • save_boundaries()
      • load_boundaries()
      • query_boundaries_at_date()
      • save_demographics()
      • load_demographics()
      • temporal_filter()
      • spatial_query()
      • point_in_boundary()
      • TemporalTimeseriesBuilder
        • TemporalTimeseriesBuilder.__init__()
        • TemporalTimeseriesBuilder.build()
      • TemporalDemographicService
        • TemporalDemographicService.__init__()
        • TemporalDemographicService.build_snapshots()
      • TimeseriesBuildResult
        • TimeseriesBuildResult.variable_code
        • TimeseriesBuildResult.geography_type
        • TimeseriesBuildResult.records_created
        • TimeseriesBuildResult.records_skipped
        • TimeseriesBuildResult.errors
        • TimeseriesBuildResult.total_processed
        • TimeseriesBuildResult.success
        • TimeseriesBuildResult.__init__()
      • temporal_filter()
      • spatial_query()
      • point_in_boundary()
      • TimeseriesBuildResult
        • TimeseriesBuildResult.variable_code
        • TimeseriesBuildResult.geography_type
        • TimeseriesBuildResult.records_created
        • TimeseriesBuildResult.records_skipped
        • TimeseriesBuildResult.errors
        • TimeseriesBuildResult.total_processed
        • TimeseriesBuildResult.success
        • TimeseriesBuildResult.__init__()
      • TemporalTimeseriesBuilder
        • TemporalTimeseriesBuilder.__init__()
        • TemporalTimeseriesBuilder.build()
      • TemporalDemographicService
        • TemporalDemographicService.__init__()
        • TemporalDemographicService.build_snapshots()
      • TemporalDataStore
        • TemporalDataStore.SUPPORTED_FORMATS
        • TemporalDataStore.__init__()
        • TemporalDataStore.save_boundaries()
        • TemporalDataStore.load_boundaries()
        • TemporalDataStore.query_boundaries_at_date()
        • TemporalDataStore.list_available_vintages()
        • TemporalDataStore.save_demographics()
        • TemporalDataStore.load_demographics()
        • TemporalDataStore.save_timeseries()
        • TemporalDataStore.load_timeseries()
      • get_temporal_store()
      • save_boundaries()
      • load_boundaries()
      • query_boundaries_at_date()
      • save_demographics()
      • load_demographics()
      • get_longitudinal_data()
      • get_available_years()
      • get_available_survey_years()
      • validate_longitudinal_years()
      • calculate_change_metrics()
      • calculate_multi_period_changes()
      • calculate_index()
      • get_change_summary()
      • TrendCategory
        • TrendCategory.RAPID_GROWTH
        • TrendCategory.MODERATE_GROWTH
        • TrendCategory.STABLE
        • TrendCategory.MODERATE_DECLINE
        • TrendCategory.RAPID_DECLINE
      • TrendThresholds
        • TrendThresholds.rapid_growth
        • TrendThresholds.moderate_growth
        • TrendThresholds.stable_lower
        • TrendThresholds.moderate_decline
        • TrendThresholds.rapid_decline
        • TrendThresholds.rapid_growth
        • TrendThresholds.moderate_growth
        • TrendThresholds.stable_lower
        • TrendThresholds.moderate_decline
        • TrendThresholds.to_dict()
        • TrendThresholds.__init__()
      • classify_trends()
      • classify_by_zscore()
      • classify_by_quantiles()
      • get_trend_summary()
      • identify_outliers()
      • compare_trends()
      • BoundaryStabilityMetrics
        • BoundaryStabilityMetrics.source_year
        • BoundaryStabilityMetrics.target_year
        • BoundaryStabilityMetrics.geography_type
        • BoundaryStabilityMetrics.total_source
        • BoundaryStabilityMetrics.total_target
        • BoundaryStabilityMetrics.unchanged
        • BoundaryStabilityMetrics.split
        • BoundaryStabilityMetrics.merged
        • BoundaryStabilityMetrics.net_change
        • BoundaryStabilityMetrics.pct_unchanged
        • BoundaryStabilityMetrics.churn_rate
        • BoundaryStabilityMetrics.source_year
        • BoundaryStabilityMetrics.target_year
        • BoundaryStabilityMetrics.geography_type
        • BoundaryStabilityMetrics.total_source
        • BoundaryStabilityMetrics.total_target
        • BoundaryStabilityMetrics.unchanged
        • BoundaryStabilityMetrics.split
        • BoundaryStabilityMetrics.merged
        • BoundaryStabilityMetrics.net_change
        • BoundaryStabilityMetrics.pct_unchanged
        • BoundaryStabilityMetrics.churn_rate
        • BoundaryStabilityMetrics.__init__()
      • AllocationEfficiencyMetrics
        • AllocationEfficiencyMetrics.mean_weight
        • AllocationEfficiencyMetrics.median_weight
        • AllocationEfficiencyMetrics.std_weight
        • AllocationEfficiencyMetrics.pct_above_90
        • AllocationEfficiencyMetrics.pct_above_50
        • AllocationEfficiencyMetrics.pct_below_10
        • AllocationEfficiencyMetrics.n_relationships
        • AllocationEfficiencyMetrics.mean_weight
        • AllocationEfficiencyMetrics.median_weight
        • AllocationEfficiencyMetrics.std_weight
        • AllocationEfficiencyMetrics.pct_above_90
        • AllocationEfficiencyMetrics.pct_above_50
        • AllocationEfficiencyMetrics.pct_below_10
        • AllocationEfficiencyMetrics.n_relationships
        • AllocationEfficiencyMetrics.__init__()
      • ChainLink
        • ChainLink.source_geoid
        • ChainLink.target_geoid
        • ChainLink.source_year
        • ChainLink.target_year
        • ChainLink.weight
        • ChainLink.relationship
        • ChainLink.source_geoid
        • ChainLink.target_geoid
        • ChainLink.source_year
        • ChainLink.target_year
        • ChainLink.weight
        • ChainLink.relationship
        • ChainLink.__init__()
      • ReallocationChain
        • ReallocationChain.origin_geoid
        • ReallocationChain.origin_year
        • ReallocationChain.links
        • ReallocationChain.terminal_geoids
        • ReallocationChain.cumulative_weight
        • ReallocationChain.origin_geoid
        • ReallocationChain.origin_year
        • ReallocationChain.links
        • ReallocationChain.terminal_geoids
        • ReallocationChain.cumulative_weight
        • ReallocationChain.__init__()
      • compute_boundary_stability()
      • compute_allocation_efficiency()
      • build_reallocation_chain()
      • compare_vintage_stability()
      • identify_volatile_boundaries()
      • calculate_change_metrics()
      • calculate_index()
      • calculate_multi_period_changes()
      • get_change_summary()
      • AllocationEfficiencyMetrics
        • AllocationEfficiencyMetrics.mean_weight
        • AllocationEfficiencyMetrics.median_weight
        • AllocationEfficiencyMetrics.std_weight
        • AllocationEfficiencyMetrics.pct_above_90
        • AllocationEfficiencyMetrics.pct_above_50
        • AllocationEfficiencyMetrics.pct_below_10
        • AllocationEfficiencyMetrics.n_relationships
        • AllocationEfficiencyMetrics.mean_weight
        • AllocationEfficiencyMetrics.median_weight
        • AllocationEfficiencyMetrics.std_weight
        • AllocationEfficiencyMetrics.pct_above_90
        • AllocationEfficiencyMetrics.pct_above_50
        • AllocationEfficiencyMetrics.pct_below_10
        • AllocationEfficiencyMetrics.n_relationships
        • AllocationEfficiencyMetrics.__init__()
      • BoundaryStabilityMetrics
        • BoundaryStabilityMetrics.source_year
        • BoundaryStabilityMetrics.target_year
        • BoundaryStabilityMetrics.geography_type
        • BoundaryStabilityMetrics.total_source
        • BoundaryStabilityMetrics.total_target
        • BoundaryStabilityMetrics.unchanged
        • BoundaryStabilityMetrics.split
        • BoundaryStabilityMetrics.merged
        • BoundaryStabilityMetrics.net_change
        • BoundaryStabilityMetrics.pct_unchanged
        • BoundaryStabilityMetrics.churn_rate
        • BoundaryStabilityMetrics.source_year
        • BoundaryStabilityMetrics.target_year
        • BoundaryStabilityMetrics.geography_type
        • BoundaryStabilityMetrics.total_source
        • BoundaryStabilityMetrics.total_target
        • BoundaryStabilityMetrics.unchanged
        • BoundaryStabilityMetrics.split
        • BoundaryStabilityMetrics.merged
        • BoundaryStabilityMetrics.net_change
        • BoundaryStabilityMetrics.pct_unchanged
        • BoundaryStabilityMetrics.churn_rate
        • BoundaryStabilityMetrics.__init__()
      • ChainLink
        • ChainLink.source_geoid
        • ChainLink.target_geoid
        • ChainLink.source_year
        • ChainLink.target_year
        • ChainLink.weight
        • ChainLink.relationship
        • ChainLink.source_geoid
        • ChainLink.target_geoid
        • ChainLink.source_year
        • ChainLink.target_year
        • ChainLink.weight
        • ChainLink.relationship
        • ChainLink.__init__()
      • ReallocationChain
        • ReallocationChain.origin_geoid
        • ReallocationChain.origin_year
        • ReallocationChain.links
        • ReallocationChain.terminal_geoids
        • ReallocationChain.cumulative_weight
        • ReallocationChain.origin_geoid
        • ReallocationChain.origin_year
        • ReallocationChain.links
        • ReallocationChain.terminal_geoids
        • ReallocationChain.cumulative_weight
        • ReallocationChain.__init__()
      • build_reallocation_chain()
      • compare_vintage_stability()
      • compute_allocation_efficiency()
      • compute_boundary_stability()
      • identify_volatile_boundaries()
      • AlignmentResult
        • AlignmentResult.data
        • AlignmentResult.source_vintage
        • AlignmentResult.target_vintage
        • AlignmentResult.method
        • AlignmentResult.rows_before
        • AlignmentResult.rows_after
        • AlignmentResult.warnings
        • AlignmentResult.data
        • AlignmentResult.source_vintage
        • AlignmentResult.target_vintage
        • AlignmentResult.method
        • AlignmentResult.rows_before
        • AlignmentResult.rows_after
        • AlignmentResult.warnings
        • AlignmentResult.__init__()
      • LongitudinalAligner
        • LongitudinalAligner.__init__()
        • LongitudinalAligner.align()
        • LongitudinalAligner.adjust_inflation()
      • get_available_years()
      • get_longitudinal_data()
      • inflation_factor()
      • validate_longitudinal_years()
      • TrendCategory
        • TrendCategory.RAPID_GROWTH
        • TrendCategory.MODERATE_GROWTH
        • TrendCategory.STABLE
        • TrendCategory.MODERATE_DECLINE
        • TrendCategory.RAPID_DECLINE
      • TrendThresholds
        • TrendThresholds.rapid_growth
        • TrendThresholds.moderate_growth
        • TrendThresholds.stable_lower
        • TrendThresholds.moderate_decline
        • TrendThresholds.rapid_decline
        • TrendThresholds.rapid_growth
        • TrendThresholds.moderate_growth
        • TrendThresholds.stable_lower
        • TrendThresholds.moderate_decline
        • TrendThresholds.to_dict()
        • TrendThresholds.__init__()
      • classify_by_quantiles()
      • classify_by_zscore()
      • classify_trends()
      • compare_trends()
      • get_trend_summary()
      • identify_outliers()
    • Other Modules
      • BivariateAnalysisResult
        • BivariateAnalysisResult.bivariate_fig
        • BivariateAnalysisResult.bivariate_axes
        • BivariateAnalysisResult.crosstab
        • BivariateAnalysisResult.crosstab_fig
        • BivariateAnalysisResult.crosstab_ax
        • BivariateAnalysisResult.companion_fig
        • BivariateAnalysisResult.companion_axes
        • BivariateAnalysisResult.verification
        • BivariateAnalysisResult.var1_breaks
        • BivariateAnalysisResult.var2_breaks
        • BivariateAnalysisResult.bivariate_fig
        • BivariateAnalysisResult.bivariate_axes
        • BivariateAnalysisResult.crosstab
        • BivariateAnalysisResult.crosstab_fig
        • BivariateAnalysisResult.crosstab_ax
        • BivariateAnalysisResult.companion_fig
        • BivariateAnalysisResult.companion_axes
        • BivariateAnalysisResult.verification
        • BivariateAnalysisResult.var1_breaks
        • BivariateAnalysisResult.var2_breaks
        • BivariateAnalysisResult.__init__()
      • classify_choropleth()
      • classify_series()
      • create_bivariate_analysis()
      • create_bivariate_choropleth()
      • create_bivariate_companion_maps()
      • create_bivariate_crosstab()
      • create_choropleth()
      • create_choropleth_comparison()
      • create_classified_comparison()
      • save_map()
      • verify_bivariate_classification()
      • detect_format()
      • extract_attributes_kml()
      • extract_attributes_ogr()
      • extract_attributes_swmaps()
      • SpatialLoaderPlan
        • SpatialLoaderPlan.primary_loader
        • SpatialLoaderPlan.loader_order
        • SpatialLoaderPlan.reason
        • SpatialLoaderPlan.__init__()
      • build_census_ingest_targets()
      • build_census_table_name()
      • select_spatial_loader()
      • NCESDownloadError
      • NCESDownloader
        • NCESDownloader.__init__()
        • NCESDownloader.download_locale_boundaries()
        • NCESDownloader.download_school_locations()
        • NCESDownloader.download_district_data()
      • CatalogEntry
        • CatalogEntry.title
        • CatalogEntry.url
        • CatalogEntry.state
        • CatalogEntry.year
        • CatalogEntry.chamber
        • CatalogEntry.dataset_type
        • CatalogEntry.format
        • CatalogEntry.geography
        • CatalogEntry.official
        • CatalogEntry.file_size
        • CatalogEntry.title
        • CatalogEntry.url
        • CatalogEntry.state
        • CatalogEntry.year
        • CatalogEntry.chamber
        • CatalogEntry.dataset_type
        • CatalogEntry.format
        • CatalogEntry.geography
        • CatalogEntry.official
        • CatalogEntry.file_size
        • CatalogEntry.matches()
        • CatalogEntry.to_dict()
        • CatalogEntry.from_dict()
        • CatalogEntry.__init__()
      • CoverageCell
        • CoverageCell.state
        • CoverageCell.year
        • CoverageCell.dataset_type
        • CoverageCell.count
        • CoverageCell.formats
        • CoverageCell.state
        • CoverageCell.year
        • CoverageCell.dataset_type
        • CoverageCell.count
        • CoverageCell.formats
        • CoverageCell.__init__()
      • DictRDHCatalogProvider
        • DictRDHCatalogProvider.__init__()
        • DictRDHCatalogProvider.add()
        • DictRDHCatalogProvider.fetch_all_datasets()
      • RDHCatalog
        • RDHCatalog.__init__()
        • RDHCatalog.entries
        • RDHCatalog.is_loaded
        • RDHCatalog.entry_count
        • RDHCatalog.load()
        • RDHCatalog.search()
        • RDHCatalog.coverage_matrix()
        • RDHCatalog.states()
        • RDHCatalog.years()
        • RDHCatalog.dataset_types()
        • RDHCatalog.for_state()
      • RDHCatalogProvider
        • RDHCatalogProvider.fetch_all_datasets()
      • SearchResult
        • SearchResult.entry
        • SearchResult.score
        • SearchResult.entry
        • SearchResult.score
        • SearchResult.__init__()
      • SWMapsArchive
        • SWMapsArchive.__init__()
        • SWMapsArchive.db_path
        • SWMapsArchive.close()
      • open_swmaps()
      • read_features()
  • Geocoding
    • Module Overview
      • GeocodingError
      • get_country_name()
      • get_country_code()
      • list_countries()
      • concatenate_addresses()
      • get_coordinates()
      • use_nominatim_geocoder()
      • geocode_with_nominatim_public()
      • geocode_addresses_with_nominatim()
      • NominatimGeoClassifier
        • NominatimGeoClassifier.__init__()
        • NominatimGeoClassifier.get_place_ranks_by_label()
        • NominatimGeoClassifier.get_importance_threshold_by_label()
        • NominatimGeoClassifier.to_json()
        • NominatimGeoClassifier.from_json()
      • validate_geocode_data_pandas()
      • mark_valid_geocode_data_pandas()
      • SpatiaLiteCache
        • SpatiaLiteCache.__init__()
        • SpatiaLiteCache.put_geocode()
        • SpatiaLiteCache.get_geocode()
        • SpatiaLiteCache.get_geocode_or_fetch()
        • SpatiaLiteCache.get_geocodes_in_bbox()
        • SpatiaLiteCache.put_boundary()
        • SpatiaLiteCache.get_boundary()
        • SpatiaLiteCache.put_crosswalk()
        • SpatiaLiteCache.get_crosswalk()
        • SpatiaLiteCache.stats()
        • SpatiaLiteCache.clear()
        • SpatiaLiteCache.close()
    • Functions
    • Usage Examples
    • Unit Tests
  • Geo Django
    • get_model()
    • get_service()
    • Models
      • CensusTIGERBoundary
        • CensusTIGERBoundary.Meta
        • CensusTIGERBoundary.save()
        • CensusTIGERBoundary.get_geoid_length()
        • CensusTIGERBoundary.parse_geoid()
      • TemporalBoundary
        • TemporalBoundary.Meta
        • TemporalBoundary.total_area
        • TemporalBoundary.land_percentage
        • TemporalBoundary.save()
      • TemporalGeographicFeature
        • TemporalGeographicFeature.Meta
        • TemporalGeographicFeature.is_current
      • TemporalLinearFeature
        • TemporalLinearFeature.Meta
      • TemporalPointFeature
        • TemporalPointFeature.Meta
      • Block
        • Block.state
        • Block.county
        • Block.tract
        • Block.block_group_ref
        • Block.Meta
        • Block.get_geoid_length()
        • Block.parse_geoid()
        • Block.block_group
      • BlockGroup
        • BlockGroup.state
        • BlockGroup.county
        • BlockGroup.tract
        • BlockGroup.Meta
        • BlockGroup.get_geoid_length()
        • BlockGroup.parse_geoid()
      • CongressionalDistrict
        • CongressionalDistrict.state
        • CongressionalDistrict.Meta
        • CongressionalDistrict.get_geoid_length()
        • CongressionalDistrict.parse_geoid()
        • CongressionalDistrict.is_at_large
      • County
        • County.state
        • County.Meta
        • County.get_geoid_length()
        • County.parse_geoid()
      • Place
        • Place.state
        • Place.Meta
        • Place.get_geoid_length()
        • Place.parse_geoid()
      • State
        • State.Meta
        • State.get_geoid_length()
        • State.parse_geoid()
      • Tract
        • Tract.state
        • Tract.county
        • Tract.Meta
        • Tract.get_geoid_length()
        • Tract.parse_geoid()
        • Tract.tract_number
        • Tract.urbanicity_category
        • Tract.urbanicity_subcategory
      • ZCTA
        • ZCTA.Meta
        • ZCTA.get_geoid_length()
        • ZCTA.parse_geoid()
      • CBSA
        • CBSA.CBSA_TYPE_CHOICES
        • CBSA.Meta
        • CBSA.get_geoid_length()
        • CBSA.parse_geoid()
      • UrbanArea
        • UrbanArea.UA_TYPE_CHOICES
        • UrbanArea.Meta
        • UrbanArea.get_geoid_length()
        • UrbanArea.parse_geoid()
      • PUMA
        • PUMA.Meta
        • PUMA.get_geoid_length()
        • PUMA.parse_geoid()
      • TribalArea
        • TribalArea.Meta
        • TribalArea.get_geoid_length()
        • TribalArea.parse_geoid()
      • CountySubdivision
        • CountySubdivision.state
        • CountySubdivision.county
        • CountySubdivision.Meta
        • CountySubdivision.get_geoid_length()
        • CountySubdivision.parse_geoid()
      • DemographicVariable
        • DemographicVariable.DATASET_CHOICES
        • DemographicVariable.Meta
        • DemographicVariable.is_estimate
        • DemographicVariable.is_moe
        • DemographicVariable.base_code
      • DemographicSnapshot
        • DemographicSnapshot.DATASET_CHOICES
        • DemographicSnapshot.content_object
        • DemographicSnapshot.Meta
        • DemographicSnapshot.get_value()
        • DemographicSnapshot.get_moe()
        • DemographicSnapshot.save()
      • DemographicTimeSeries
        • DemographicTimeSeries.content_object
        • DemographicTimeSeries.Meta
      • SchoolDistrictBase
        • SchoolDistrictBase.state
        • SchoolDistrictBase.Meta
        • SchoolDistrictBase.get_geoid_length()
        • SchoolDistrictBase.parse_geoid()
      • SchoolDistrictElementary
        • SchoolDistrictElementary.Meta
      • SchoolDistrictSecondary
        • SchoolDistrictSecondary.Meta
      • SchoolDistrictUnified
        • SchoolDistrictUnified.Meta
      • NCESLocaleBoundary
        • NCESLocaleBoundary.Meta
        • NCESLocaleBoundary.save()
      • SchoolLocation
        • SchoolLocation.state
        • SchoolLocation.Meta
        • SchoolLocation.save()
      • NLRBRegion
        • NLRBRegion.Meta
        • NLRBRegion.save()
      • FederalJudicialDistrict
        • FederalJudicialDistrict.Meta
        • FederalJudicialDistrict.save()
      • GADMBoundary
        • GADMBoundary.Meta
        • GADMBoundary.save()
      • GADMCountry
        • GADMCountry.Meta
      • GADMAdmin1
        • GADMAdmin1.country
        • GADMAdmin1.Meta
        • GADMAdmin1.populate_parent_relationships()
      • GADMAdmin2
        • GADMAdmin2.admin1
        • GADMAdmin2.Meta
        • GADMAdmin2.populate_parent_relationships()
      • GADMAdmin3
        • GADMAdmin3.admin2
        • GADMAdmin3.Meta
        • GADMAdmin3.populate_parent_relationships()
      • GADMAdmin4
        • GADMAdmin4.admin3
        • GADMAdmin4.Meta
        • GADMAdmin4.populate_parent_relationships()
      • GADMAdmin5
        • GADMAdmin5.admin4
        • GADMAdmin5.Meta
        • GADMAdmin5.populate_parent_relationships()
      • BoundaryIntersection
        • BoundaryIntersection.Meta
      • CountyCDIntersection
        • CountyCDIntersection.county
        • CountyCDIntersection.congressional_district
        • CountyCDIntersection.Meta
      • VTDCDIntersection
        • VTDCDIntersection.vtd
        • VTDCDIntersection.congressional_district
        • VTDCDIntersection.Meta
      • TractCDIntersection
        • TractCDIntersection.tract
        • TractCDIntersection.congressional_district
        • TractCDIntersection.Meta
      • IsochroneResult
        • IsochroneResult.Meta
        • IsochroneResult.save()
      • NLRBCase
        • NLRBCase.region
        • NLRBCase.Meta
        • NLRBCase.to_record()
        • NLRBCase.from_record()
      • ElectionResult
        • ElectionResult.case
        • ElectionResult.Meta
        • ElectionResult.to_record()
      • ULPCharge
        • ULPCharge.case
        • ULPCharge.Meta
        • ULPCharge.to_record()
      • BargainingUnit
        • BargainingUnit.case
        • BargainingUnit.Meta
      • StateLegislativeUpper
        • StateLegislativeUpper.state
        • StateLegislativeUpper.Meta
        • StateLegislativeUpper.get_geoid_length()
        • StateLegislativeUpper.parse_geoid()
      • StateLegislativeLower
        • StateLegislativeLower.state
        • StateLegislativeLower.Meta
        • StateLegislativeLower.get_geoid_length()
        • StateLegislativeLower.parse_geoid()
      • VTD
        • VTD.state
        • VTD.county
        • VTD.congressional_district
        • VTD.Meta
        • VTD.get_geoid_length()
        • VTD.parse_geoid()
        • VTD.clean()
        • VTD.populate_parent_relationships()
      • Precinct
        • Precinct.state
        • Precinct.county
        • Precinct.Meta
        • Precinct.get_geoid_length()
        • Precinct.parse_geoid()
      • SpecialDistrictBase
        • SpecialDistrictBase.Meta
      • FireProtectionDistrict
        • FireProtectionDistrict.Meta
      • WaterSupplyDistrict
        • WaterSupplyDistrict.Meta
      • HospitalDistrict
        • HospitalDistrict.Meta
      • LibraryDistrict
        • LibraryDistrict.Meta
      • CemeteryDistrict
        • CemeteryDistrict.Meta
      • MosquitoAbatementDistrict
        • MosquitoAbatementDistrict.Meta
      • OtherSpecialDistrict
        • OtherSpecialDistrict.Meta
      • TimezoneGeometry
        • TimezoneGeometry.Meta
        • TimezoneGeometry.save()
    • Managers
      • BoundaryManager
        • BoundaryManager.get_queryset()
        • BoundaryManager.for_year()
        • BoundaryManager.for_state()
        • BoundaryManager.current()
        • BoundaryManager.valid_on()
        • BoundaryManager.containing_point()
        • BoundaryManager.intersecting()
        • BoundaryManager.within_distance()
        • BoundaryManager.nearest()
        • BoundaryManager.get_by_geoid()
        • BoundaryManager.get_children()
        • BoundaryManager.bulk_create_from_geodataframe()
      • BoundaryQuerySet
        • BoundaryQuerySet.for_year()
        • BoundaryQuerySet.for_state()
        • BoundaryQuerySet.current()
        • BoundaryQuerySet.valid_on()
        • BoundaryQuerySet.containing_point()
        • BoundaryQuerySet.intersecting()
        • BoundaryQuerySet.within_distance()
        • BoundaryQuerySet.nearest()
        • BoundaryQuerySet.with_area()
        • BoundaryQuerySet.by_land_area()
        • BoundaryQuerySet.by_population()
        • BoundaryQuerySet.geojson()
      • BoundaryQuerySet
        • BoundaryQuerySet.for_year()
        • BoundaryQuerySet.for_state()
        • BoundaryQuerySet.current()
        • BoundaryQuerySet.valid_on()
        • BoundaryQuerySet.containing_point()
        • BoundaryQuerySet.intersecting()
        • BoundaryQuerySet.within_distance()
        • BoundaryQuerySet.nearest()
        • BoundaryQuerySet.with_area()
        • BoundaryQuerySet.by_land_area()
        • BoundaryQuerySet.by_population()
        • BoundaryQuerySet.geojson()
      • BoundaryManager
        • BoundaryManager.get_queryset()
        • BoundaryManager.for_year()
        • BoundaryManager.for_state()
        • BoundaryManager.current()
        • BoundaryManager.valid_on()
        • BoundaryManager.containing_point()
        • BoundaryManager.intersecting()
        • BoundaryManager.within_distance()
        • BoundaryManager.nearest()
        • BoundaryManager.get_by_geoid()
        • BoundaryManager.get_children()
        • BoundaryManager.bulk_create_from_geodataframe()
    • Services
      • CrosswalkPopulationResult
        • CrosswalkPopulationResult.geography_type
        • CrosswalkPopulationResult.source_year
        • CrosswalkPopulationResult.target_year
        • CrosswalkPopulationResult.state_fips
        • CrosswalkPopulationResult.records_created
        • CrosswalkPopulationResult.records_updated
        • CrosswalkPopulationResult.records_skipped
        • CrosswalkPopulationResult.errors
        • CrosswalkPopulationResult.total_processed
        • CrosswalkPopulationResult.success
        • CrosswalkPopulationResult.__init__()
      • CrosswalkPopulationService
        • CrosswalkPopulationService.__init__()
        • CrosswalkPopulationService.populate()
        • CrosswalkPopulationService.populate_tract_crosswalk()
        • CrosswalkPopulationService.populate_block_group_crosswalk()
        • CrosswalkPopulationService.populate_county_crosswalk()
      • DemographicPopulationResult
        • DemographicPopulationResult.geography_type
        • DemographicPopulationResult.year
        • DemographicPopulationResult.dataset
        • DemographicPopulationResult.state_fips
        • DemographicPopulationResult.variable_group
        • DemographicPopulationResult.records_created
        • DemographicPopulationResult.records_updated
        • DemographicPopulationResult.records_skipped
        • DemographicPopulationResult.errors
        • DemographicPopulationResult.total_processed
        • DemographicPopulationResult.success
        • DemographicPopulationResult.__init__()
      • DemographicPopulationService
        • DemographicPopulationService.CENSUS_GEOGRAPHIES
        • DemographicPopulationService.__init__()
        • DemographicPopulationService.client
        • DemographicPopulationService.populate()
        • DemographicPopulationService.populate_income()
        • DemographicPopulationService.populate_education()
        • DemographicPopulationService.populate_housing()
        • DemographicPopulationService.populate_race_ethnicity()
        • DemographicPopulationService.populate_all_groups()
      • IsochroneComputeResult
        • IsochroneComputeResult.records_created
        • IsochroneComputeResult.records_cached
        • IsochroneComputeResult.errors
        • IsochroneComputeResult.success
        • IsochroneComputeResult.__init__()
      • IsochroneComputeService
        • IsochroneComputeService.compute_and_store()
        • IsochroneComputeService.get_cached()
      • NCESPopulationResult
        • NCESPopulationResult.action
        • NCESPopulationResult.year
        • NCESPopulationResult.records_created
        • NCESPopulationResult.records_updated
        • NCESPopulationResult.records_skipped
        • NCESPopulationResult.errors
        • NCESPopulationResult.total_processed
        • NCESPopulationResult.success
        • NCESPopulationResult.__init__()
      • NCESPopulationService
        • NCESPopulationService.__init__()
        • NCESPopulationService.populate_locale_boundaries()
        • NCESPopulationService.populate_school_locations()
        • NCESPopulationService.enrich_school_districts()
      • NLRBPopulationResult
        • NLRBPopulationResult.records_created
        • NLRBPopulationResult.records_updated
        • NLRBPopulationResult.records_skipped
        • NLRBPopulationResult.errors
        • NLRBPopulationResult.success
        • NLRBPopulationResult.__init__()
      • NLRBPopulationService
        • NLRBPopulationService.populate()
      • PopulationResult
        • PopulationResult.geography_type
        • PopulationResult.year
        • PopulationResult.state_fips
        • PopulationResult.records_created
        • PopulationResult.records_updated
        • PopulationResult.records_skipped
        • PopulationResult.errors
        • PopulationResult.total_processed
        • PopulationResult.success
        • PopulationResult.__init__()
      • BoundaryPopulationService
        • BoundaryPopulationService.GEOGRAPHY_MODELS
        • BoundaryPopulationService.TIGER_TYPES
        • BoundaryPopulationService.__init__()
        • BoundaryPopulationService.populate()
        • BoundaryPopulationService.populate_states()
        • BoundaryPopulationService.populate_counties()
        • BoundaryPopulationService.populate_tracts()
        • BoundaryPopulationService.populate_block_groups()
        • BoundaryPopulationService.populate_blocks()
        • BoundaryPopulationService.populate_places()
        • BoundaryPopulationService.populate_zctas()
        • BoundaryPopulationService.populate_congressional_districts()
        • BoundaryPopulationService.link_parent_relationships()
      • RDHLoadResult
        • RDHLoadResult.operation
        • RDHLoadResult.records_created
        • RDHLoadResult.records_updated
        • RDHLoadResult.records_skipped
        • RDHLoadResult.errors
        • RDHLoadResult.total_processed
        • RDHLoadResult.success
        • RDHLoadResult.__init__()
      • RDHLoaderService
        • RDHLoaderService.__init__()
        • RDHLoaderService.load_enacted_plan()
        • RDHLoaderService.load_precinct_results()
        • RDHLoaderService.load_cvap_for_plan()
        • RDHLoaderService.load_demographics_for_plan()
        • RDHLoaderService.compute_plan_compactness()
      • RollupResult
        • RollupResult.source_level
        • RollupResult.target_level
        • RollupResult.variable_code
        • RollupResult.records_created
        • RollupResult.records_skipped
        • RollupResult.coverage_ratio
        • RollupResult.errors
        • RollupResult.success
        • RollupResult.__init__()
      • DemographicRollupService
        • DemographicRollupService.__init__()
        • DemographicRollupService.GEOID_PREFIX_LENGTHS
        • DemographicRollupService.rollup()
      • TimeseriesResult
        • TimeseriesResult.variable_code
        • TimeseriesResult.geography_level
        • TimeseriesResult.records_created
        • TimeseriesResult.records_updated
        • TimeseriesResult.records_skipped
        • TimeseriesResult.errors
        • TimeseriesResult.total_processed
        • TimeseriesResult.success
        • TimeseriesResult.__init__()
      • TimeseriesService
        • TimeseriesService.__init__()
        • TimeseriesService.populate_timeseries()
      • TimezonePopulationResult
        • TimezonePopulationResult.records_created
        • TimezonePopulationResult.records_updated
        • TimezonePopulationResult.records_skipped
        • TimezonePopulationResult.errors
        • TimezonePopulationResult.success
        • TimezonePopulationResult.__init__()
      • TimezonePopulationService
        • TimezonePopulationService.populate_from_geojson()
      • ClassificationResult
        • ClassificationResult.classified
        • ClassificationResult.skipped_no_population
        • ClassificationResult.skipped_no_urban_area
        • ClassificationResult.skipped_no_point
        • ClassificationResult.errors
        • ClassificationResult.total_processed
        • ClassificationResult.__init__()
      • UrbanicityClassificationService
        • UrbanicityClassificationService.classify()
    • Serializers
    • Management Commands
    • App Configuration
      • SiegeGeoConfig
        • SiegeGeoConfig.name
        • SiegeGeoConfig.label
        • SiegeGeoConfig.verbose_name
        • SiegeGeoConfig.default_auto_field
        • SiegeGeoConfig.ready()

Domain Packages

  • Political
    • schema_migrations_dir()
    • Submodules
      • seats()
      • office_terms()
      • congressional_terms()
      • redistricting_plans()
      • plan_district_assignments()
      • state_election_calendars()
  • Economic
    • Submodules
      • QCEWFiles
        • QCEWFiles.__init__()
        • QCEWFiles.download()
        • QCEWFiles.parse()
        • QCEWFiles.load()
      • QCEWFiles
        • QCEWFiles.__init__()
        • QCEWFiles.download()
        • QCEWFiles.parse()
        • QCEWFiles.load()
  • Education
    • Submodules
      • NCESFiles
        • NCESFiles.__init__()
        • NCESFiles.load_ccd_directory()
        • NCESFiles.load_ccd_nonfiscal()
        • NCESFiles.load_ccd_finance()
        • NCESFiles.load_ccd_school_directory()
        • NCESFiles.load_ccd_school_nonfiscal()
        • NCESFiles.load_edge_district_demographics()
      • NCESFiles
        • NCESFiles.__init__()
        • NCESFiles.load_ccd_directory()
        • NCESFiles.load_ccd_nonfiscal()
        • NCESFiles.load_ccd_finance()
        • NCESFiles.load_ccd_school_directory()
        • NCESFiles.load_ccd_school_nonfiscal()
        • NCESFiles.load_edge_district_demographics()
  • Survey
    • Submodules
      • CrosstabInputError
      • build_chain()
      • Chain
        • Chain.row_var
        • Chain.break_vars
        • Chain.views
        • Chain.table_type
        • Chain.base_note
        • Chain.geo_column
        • Chain.delta_column
        • Chain.chi_square_significant
        • Chain.chi_square_p
        • Chain.to_dataframe()
        • Chain.__init__()
      • Cluster
        • Cluster.name
        • Cluster.chains
        • Cluster.add_chain()
        • Cluster.__init__()
      • Stack
        • Stack.name
        • Stack.clusters
        • Stack.weight_scheme
        • Stack.add_cluster()
        • Stack.all_chains
        • Stack.__init__()
      • View
        • View.metric
        • View.base
        • View.count
        • View.pct
        • View.sig_flag
        • View.ci
        • View.__init__()
      • Wave
        • Wave.id
        • Wave.date
        • Wave.df
        • Wave.stack
        • Wave.weight_scheme
        • Wave.__init__()
      • WaveSet
        • WaveSet.name
        • WaveSet.waves
        • WaveSet.client_id
        • WaveSet.add_wave()
        • WaveSet.ordered
        • WaveSet.compare_chain()
        • WaveSet.__init__()
      • WeightScheme
        • WeightScheme.targets
        • WeightScheme.weight_col
        • WeightScheme.max_iterations
        • WeightScheme.convergence
        • WeightScheme.validate()
        • WeightScheme.__init__()
      • ClientSurveyError
      • ClientSurveyRegistry
        • ClientSurveyRegistry.register()
        • ClientSurveyRegistry.register_for()
        • ClientSurveyRegistry.unregister()
        • ClientSurveyRegistry.clients()
        • ClientSurveyRegistry.surveys_for()
        • ClientSurveyRegistry.get_survey()
        • ClientSurveyRegistry.require_survey()
        • ClientSurveyRegistry.client_of()
        • ClientSurveyRegistry.__init__()
      • RenderError
      • ArgumentCluster
        • ArgumentCluster.name
        • ArgumentCluster.arguments
        • ArgumentCluster.__init__()
      • chain_to_argument()
      • stack_to_arguments()
      • SignificanceError
      • column_proportion_test()
      • chi_square_flag()
      • WavesError
      • compare_waves()
      • WeightingConvergenceError
      • apply_rim_weights()
  • Analytics
    • GoogleAnalyticsConnector
      • GoogleAnalyticsConnector.__init__()
      • GoogleAnalyticsConnector.authenticate()
      • GoogleAnalyticsConnector.authenticate_service_account()
      • GoogleAnalyticsConnector.get_ga4_data()
      • GoogleAnalyticsConnector.get_ua_data()
      • GoogleAnalyticsConnector.save_as_pandas()
      • GoogleAnalyticsConnector.save_as_spark()
    • create_ga_account_profile()
    • save_ga_account_profile()
    • load_ga_account_profile()
    • list_ga_accounts_for_client()
    • batch_retrieve_ga_data()
    • create_ga_connector_with_service_account()
    • FacebookBusinessConnector
      • FacebookBusinessConnector.__init__()
      • FacebookBusinessConnector.get_ad_accounts()
      • FacebookBusinessConnector.get_ad_insights()
      • FacebookBusinessConnector.get_page_insights()
      • FacebookBusinessConnector.get_business_insights()
      • FacebookBusinessConnector.save_as_pandas()
      • FacebookBusinessConnector.save_as_spark()
    • create_facebook_account_profile()
    • save_facebook_account_profile()
    • load_facebook_account_profile()
    • list_facebook_accounts_for_client()
    • batch_retrieve_facebook_data()
    • SnowflakeConnector
      • SnowflakeConnector.__init__()
      • SnowflakeConnector.connect()
      • SnowflakeConnector.disconnect()
      • SnowflakeConnector.execute_query()
      • SnowflakeConnector.execute_ddl()
      • SnowflakeConnector.upload_dataframe()
      • SnowflakeConnector.download_dataframe()
      • SnowflakeConnector.get_table_info()
      • SnowflakeConnector.list_tables()
    • get_snowflake_connector()
    • upload_to_snowflake()
    • download_from_snowflake()
    • execute_snowflake_query()
    • DataDotWorldConnector
      • DataDotWorldConnector.__init__()
      • DataDotWorldConnector.search_datasets()
      • DataDotWorldConnector.get_dataset_info()
      • DataDotWorldConnector.list_dataset_files()
      • DataDotWorldConnector.download_file()
      • DataDotWorldConnector.load_dataset_as_dataframe()
      • DataDotWorldConnector.query_dataset()
      • DataDotWorldConnector.get_dataset_schema()
      • DataDotWorldConnector.create_dataset()
      • DataDotWorldConnector.upload_file()
      • DataDotWorldConnector.update_dataset()
      • DataDotWorldConnector.delete_dataset()
    • get_datadotworld_connector()
    • search_datasets()
    • list_datasets()
    • search_datadotworld_datasets()
    • load_datadotworld_dataset()
    • query_datadotworld_dataset()
    • GoogleWorkspaceClient
      • GoogleWorkspaceClient.__init__()
      • GoogleWorkspaceClient.from_oauth()
      • GoogleWorkspaceClient.from_1password()
      • GoogleWorkspaceClient.from_service_account()
      • GoogleWorkspaceClient.from_credentials()
      • GoogleWorkspaceClient.from_account()
      • GoogleWorkspaceClient.from_registry()
      • GoogleWorkspaceClient.sheets_service()
      • GoogleWorkspaceClient.docs_service()
      • GoogleWorkspaceClient.slides_service()
      • GoogleWorkspaceClient.drive_service()
      • GoogleWorkspaceClient.credentials
      • GoogleWorkspaceClient.batch_update_spreadsheet()
      • GoogleWorkspaceClient.batch_update_document()
      • GoogleWorkspaceClient.batch_update_presentation()
      • GoogleWorkspaceClient.spreadsheet_url()
      • GoogleWorkspaceClient.document_url()
      • GoogleWorkspaceClient.presentation_url()
      • GoogleWorkspaceClient.file_url()
      • GoogleWorkspaceClient.copy_file()
      • GoogleWorkspaceClient.share_file()
      • GoogleWorkspaceClient.move_to_folder()
    • create_spreadsheet()
    • write_values()
    • append_rows()
    • read_values()
    • write_dataframe()
    • read_dataframe()
    • add_sheet()
    • get_spreadsheet_metadata()
    • copy_spreadsheet()
    • create_presentation()
    • get_presentation()
    • copy_presentation()
    • add_blank_slide()
    • create_textbox()
    • create_document()
    • get_document()
    • copy_document()
    • read_document_text()
    • insert_paragraph()
    • insert_table()
    • replace_text()
    • VistaSocialConnector
      • VistaSocialConnector.__init__()
      • VistaSocialConnector.close()
      • VistaSocialConnector.list_accounts()
      • VistaSocialConnector.list_profiles()
      • VistaSocialConnector.get_account_analytics()
      • VistaSocialConnector.list_posts()
    • VistaSocialResponse
      • VistaSocialResponse.status_code
      • VistaSocialResponse.data
      • VistaSocialResponse.headers
      • VistaSocialResponse.url
      • VistaSocialResponse.status_code
      • VistaSocialResponse.data
      • VistaSocialResponse.headers
      • VistaSocialResponse.url
      • VistaSocialResponse.__init__()
    • VistaSocialError
    • VistaSocialAuthError
    • VistaSocialRateLimitError
    • Dimension
      • Dimension.name
      • Dimension.weight
      • Dimension.__init__()
    • ThresholdConfig
      • ThresholdConfig.green_min
      • ThresholdConfig.yellow_min
      • ThresholdConfig.classify()
      • ThresholdConfig.__init__()
    • EntityScore
      • EntityScore.entity_id
      • EntityScore.composite_score
      • EntityScore.tier
      • EntityScore.dimension_scores
      • EntityScore.segment
      • EntityScore.trend
      • EntityScore.trend_direction
      • EntityScore.__init__()
    • HealthScorer
      • HealthScorer.__init__()
      • HealthScorer.dimension_names
      • HealthScorer.score()
      • HealthScorer.score_batch()
    • SignalType
      • SignalType.DECLINE
      • SignalType.THRESHOLD
      • SignalType.ABSENCE
      • SignalType.ANOMALY
    • RiskTier
      • RiskTier.CRITICAL
      • RiskTier.HIGH
      • RiskTier.MEDIUM
      • RiskTier.LOW
    • RiskSignal
      • RiskSignal.name
      • RiskSignal.signal_type
      • RiskSignal.weight
      • RiskSignal.__init__()
    • RiskTierConfig
      • RiskTierConfig.critical_min
      • RiskTierConfig.high_min
      • RiskTierConfig.medium_min
      • RiskTierConfig.classify()
      • RiskTierConfig.__init__()
    • RiskAssessment
      • RiskAssessment.entity_id
      • RiskAssessment.composite_score
      • RiskAssessment.tier
      • RiskAssessment.signal_scores
      • RiskAssessment.signal_types
      • RiskAssessment.intervention
      • RiskAssessment.__init__()
    • RiskAnalyzer
      • RiskAnalyzer.__init__()
      • RiskAnalyzer.signal_names
      • RiskAnalyzer.assess()
      • RiskAnalyzer.assess_batch()
    • DimensionScore
      • DimensionScore.score
      • DimensionScore.evidence
      • DimensionScore.__init__()
    • ComparisonResult
      • ComparisonResult.dimensions
      • ComparisonResult.entities
      • ComparisonResult.scores
      • ComparisonResult.weighted_totals
      • ComparisonResult.gap_analysis
      • ComparisonResult.__init__()
    • FeatureMatrix
      • FeatureMatrix.entities
      • FeatureMatrix.features
      • FeatureMatrix.matrix
      • FeatureMatrix.coverage
      • FeatureMatrix.__init__()
    • ComparativeAnalyzer
      • ComparativeAnalyzer.__init__()
      • ComparativeAnalyzer.compare()
      • ComparativeAnalyzer.build_feature_matrix()
    • ForecastAccuracy
      • ForecastAccuracy.mape
      • ForecastAccuracy.bias
      • ForecastAccuracy.bias_direction
      • ForecastAccuracy.grade
      • ForecastAccuracy.n_observations
      • ForecastAccuracy.n_excluded
      • ForecastAccuracy.__init__()
    • CategoryBreakdown
      • CategoryBreakdown.category
      • CategoryBreakdown.accuracy
      • CategoryBreakdown.__init__()
    • TrendPoint
      • TrendPoint.period
      • TrendPoint.mape
      • TrendPoint.bias
      • TrendPoint.__init__()
    • ForecastReport
      • ForecastReport.overall
      • ForecastReport.by_category
      • ForecastReport.trend
      • ForecastReport.trend_direction
      • ForecastReport.__init__()
    • ForecastAnalyzer
      • ForecastAnalyzer.__init__()
      • ForecastAnalyzer.analyze()
    • PipelineItem
      • PipelineItem.item_id
      • PipelineItem.stage
      • PipelineItem.value
      • PipelineItem.entered_stage
      • PipelineItem.__init__()
    • StageMetrics
      • StageMetrics.stage
      • StageMetrics.count
      • StageMetrics.total_value
      • StageMetrics.avg_value
      • StageMetrics.__init__()
    • ConversionRate
      • ConversionRate.from_stage
      • ConversionRate.to_stage
      • ConversionRate.rate
      • ConversionRate.from_count
      • ConversionRate.to_count
      • ConversionRate.__init__()
    • VelocityMetrics
      • VelocityMetrics.stage
      • VelocityMetrics.avg_days
      • VelocityMetrics.max_days
      • VelocityMetrics.aging_items
      • VelocityMetrics.__init__()
    • ConcentrationAlert
      • ConcentrationAlert.item_id
      • ConcentrationAlert.share
      • ConcentrationAlert.stage
      • ConcentrationAlert.value
      • ConcentrationAlert.__init__()
    • PipelineReport
      • PipelineReport.coverage_ratio
      • PipelineReport.stage_metrics
      • PipelineReport.conversions
      • PipelineReport.velocity
      • PipelineReport.concentration_alerts
      • PipelineReport.total_value
      • PipelineReport.target
      • PipelineReport.__init__()
    • PipelineAnalyzer
      • PipelineAnalyzer.__init__()
      • PipelineAnalyzer.analyze()
    • MappingRule
      • MappingRule.signal
      • MappingRule.action
      • MappingRule.priority
      • MappingRule.__init__()
    • Outcome
      • Outcome.signal
      • Outcome.action
      • Outcome.success
      • Outcome.overridden
      • Outcome.override_reason
      • Outcome.__init__()
    • EffectivenessReport
      • EffectivenessReport.action
      • EffectivenessReport.total
      • EffectivenessReport.successes
      • EffectivenessReport.success_rate
      • EffectivenessReport.__init__()
    • InterventionMapper
      • InterventionMapper.__init__()
      • InterventionMapper.signals
      • InterventionMapper.map()
      • InterventionMapper.record_outcome()
      • InterventionMapper.effectiveness()
    • Submodules
      • GoogleAnalyticsConnector
        • GoogleAnalyticsConnector.__init__()
        • GoogleAnalyticsConnector.authenticate()
        • GoogleAnalyticsConnector.authenticate_service_account()
        • GoogleAnalyticsConnector.get_ga4_data()
        • GoogleAnalyticsConnector.get_ua_data()
        • GoogleAnalyticsConnector.save_as_pandas()
        • GoogleAnalyticsConnector.save_as_spark()
      • batch_retrieve_ga_data()
      • create_ga_account_profile()
      • create_ga_connector_from_1password()
      • create_ga_connector_with_oauth2()
      • create_ga_connector_with_service_account()
      • list_ga_accounts_for_client()
      • load_ga_account_profile()
      • save_ga_account_profile()
      • batch_update()
      • copy_document()
      • create_document()
      • get_document()
      • insert_image()
      • insert_paragraph()
      • insert_table()
      • insert_text()
      • read_document_text()
      • replace_text()
      • add_sheet()
      • append_rows()
      • batch_update()
      • copy_spreadsheet()
      • create_spreadsheet()
      • get_spreadsheet_metadata()
      • read_dataframe()
      • read_values()
      • write_dataframe()
      • write_values()
      • add_blank_slide()
      • batch_update()
      • copy_presentation()
      • create_argument_slide()
      • create_presentation()
      • create_report_from_arguments()
      • create_textbox()
      • get_presentation()
      • insert_image()
      • insert_text()
      • upload_figure_to_drive()
      • GoogleWorkspaceClient
        • GoogleWorkspaceClient.__init__()
        • GoogleWorkspaceClient.from_oauth()
        • GoogleWorkspaceClient.from_1password()
        • GoogleWorkspaceClient.from_service_account()
        • GoogleWorkspaceClient.from_credentials()
        • GoogleWorkspaceClient.from_account()
        • GoogleWorkspaceClient.from_registry()
        • GoogleWorkspaceClient.sheets_service()
        • GoogleWorkspaceClient.docs_service()
        • GoogleWorkspaceClient.slides_service()
        • GoogleWorkspaceClient.drive_service()
        • GoogleWorkspaceClient.credentials
        • GoogleWorkspaceClient.batch_update_spreadsheet()
        • GoogleWorkspaceClient.batch_update_document()
        • GoogleWorkspaceClient.batch_update_presentation()
        • GoogleWorkspaceClient.spreadsheet_url()
        • GoogleWorkspaceClient.document_url()
        • GoogleWorkspaceClient.presentation_url()
        • GoogleWorkspaceClient.file_url()
        • GoogleWorkspaceClient.copy_file()
        • GoogleWorkspaceClient.share_file()
        • GoogleWorkspaceClient.move_to_folder()
      • SnowflakeConnector
        • SnowflakeConnector.__init__()
        • SnowflakeConnector.connect()
        • SnowflakeConnector.disconnect()
        • SnowflakeConnector.execute_query()
        • SnowflakeConnector.execute_ddl()
        • SnowflakeConnector.upload_dataframe()
        • SnowflakeConnector.download_dataframe()
        • SnowflakeConnector.get_table_info()
        • SnowflakeConnector.list_tables()
      • get_snowflake_connector()
      • upload_to_snowflake()
      • download_from_snowflake()
      • execute_snowflake_query()
      • DataDotWorldConnector
        • DataDotWorldConnector.__init__()
        • DataDotWorldConnector.search_datasets()
        • DataDotWorldConnector.get_dataset_info()
        • DataDotWorldConnector.list_dataset_files()
        • DataDotWorldConnector.download_file()
        • DataDotWorldConnector.load_dataset_as_dataframe()
        • DataDotWorldConnector.query_dataset()
        • DataDotWorldConnector.get_dataset_schema()
        • DataDotWorldConnector.create_dataset()
        • DataDotWorldConnector.upload_file()
        • DataDotWorldConnector.update_dataset()
        • DataDotWorldConnector.delete_dataset()
      • get_datadotworld_connector()
      • list_datasets()
      • search_datasets()
      • search_datadotworld_datasets()
      • load_datadotworld_dataset()
      • query_datadotworld_dataset()
      • FacebookBusinessConnector
        • FacebookBusinessConnector.__init__()
        • FacebookBusinessConnector.get_ad_accounts()
        • FacebookBusinessConnector.get_ad_insights()
        • FacebookBusinessConnector.get_page_insights()
        • FacebookBusinessConnector.get_business_insights()
        • FacebookBusinessConnector.save_as_pandas()
        • FacebookBusinessConnector.save_as_spark()
      • batch_retrieve_facebook_data()
      • create_facebook_account_profile()
      • list_facebook_accounts_for_client()
      • load_facebook_account_profile()
      • save_facebook_account_profile()
      • Why “thin”
      • VistaSocialError
      • VistaSocialAuthError
      • VistaSocialRateLimitError
      • VistaSocialResponse
        • VistaSocialResponse.status_code
        • VistaSocialResponse.data
        • VistaSocialResponse.headers
        • VistaSocialResponse.url
        • VistaSocialResponse.status_code
        • VistaSocialResponse.data
        • VistaSocialResponse.headers
        • VistaSocialResponse.url
        • VistaSocialResponse.__init__()
      • VistaSocialConnector
        • VistaSocialConnector.__init__()
        • VistaSocialConnector.close()
        • VistaSocialConnector.list_accounts()
        • VistaSocialConnector.list_profiles()
        • VistaSocialConnector.get_account_analytics()
        • VistaSocialConnector.list_posts()

Engines & Infrastructure

  • Engines
    • Engine
      • Engine.PANDAS
      • Engine.DUCKDB
      • Engine.SPARK
      • Engine.POSTGIS
    • DataFrameEngine
      • DataFrameEngine.name
      • DataFrameEngine.read_csv()
      • DataFrameEngine.read_parquet()
      • DataFrameEngine.query()
      • DataFrameEngine.to_pandas()
      • DataFrameEngine.groupby_agg()
      • DataFrameEngine.filter()
      • DataFrameEngine.join()
      • DataFrameEngine.read_spatial()
      • DataFrameEngine.spatial_join()
      • DataFrameEngine.buffer()
      • DataFrameEngine.distance()
      • DataFrameEngine.to_geodataframe()
      • DataFrameEngine.from_geodataframe()
      • DataFrameEngine.index_points()
      • DataFrameEngine.index_polygon()
      • DataFrameEngine.point_in_polygon()
      • DataFrameEngine.dissolve()
      • DataFrameEngine.load_polygons()
      • DataFrameEngine.load_points()
      • DataFrameEngine.load_lines()
      • DataFrameEngine.assign_boundaries()
      • DataFrameEngine.intersect_boundaries()
      • DataFrameEngine.apportion()
      • DataFrameEngine.nearest()
      • DataFrameEngine.multi_assign()
    • PandasEngine
      • PandasEngine.name
      • PandasEngine.read_csv()
      • PandasEngine.read_parquet()
      • PandasEngine.query()
      • PandasEngine.to_pandas()
      • PandasEngine.groupby_agg()
      • PandasEngine.filter()
      • PandasEngine.join()
      • PandasEngine.read_spatial()
      • PandasEngine.spatial_join()
      • PandasEngine.buffer()
      • PandasEngine.distance()
      • PandasEngine.to_geodataframe()
    • DuckDBEngine
      • DuckDBEngine.__init__()
      • DuckDBEngine.name
      • DuckDBEngine.read_csv()
      • DuckDBEngine.read_parquet()
      • DuckDBEngine.query()
      • DuckDBEngine.to_pandas()
      • DuckDBEngine.groupby_agg()
      • DuckDBEngine.filter()
      • DuckDBEngine.join()
      • DuckDBEngine.read_spatial()
      • DuckDBEngine.spatial_join()
      • DuckDBEngine.buffer()
      • DuckDBEngine.distance()
      • DuckDBEngine.to_geodataframe()
      • DuckDBEngine.from_geodataframe()
    • SparkEngine
      • SparkEngine.__init__()
      • SparkEngine.name
      • SparkEngine.read_csv()
      • SparkEngine.read_parquet()
      • SparkEngine.query()
      • SparkEngine.to_pandas()
      • SparkEngine.groupby_agg()
      • SparkEngine.filter()
      • SparkEngine.join()
      • SparkEngine.read_spatial()
      • SparkEngine.spatial_join()
      • SparkEngine.buffer()
      • SparkEngine.distance()
      • SparkEngine.to_geodataframe()
      • SparkEngine.load_polygons()
      • SparkEngine.load_points()
      • SparkEngine.assign_boundaries()
      • SparkEngine.nearest()
    • PostGISEngine
      • PostGISEngine.__init__()
      • PostGISEngine.name
      • PostGISEngine.index_points()
      • PostGISEngine.read_csv()
      • PostGISEngine.read_parquet()
      • PostGISEngine.query()
      • PostGISEngine.to_pandas()
      • PostGISEngine.groupby_agg()
      • PostGISEngine.filter()
      • PostGISEngine.join()
      • PostGISEngine.read_spatial()
      • PostGISEngine.spatial_join()
      • PostGISEngine.buffer()
      • PostGISEngine.distance()
      • PostGISEngine.to_geodataframe()
    • get_engine()
    • Submodules
      • Why one abstraction
      • Engine
        • Engine.PANDAS
        • Engine.DUCKDB
        • Engine.SPARK
        • Engine.POSTGIS
      • DataFrameEngine
        • DataFrameEngine.name
        • DataFrameEngine.read_csv()
        • DataFrameEngine.read_parquet()
        • DataFrameEngine.query()
        • DataFrameEngine.to_pandas()
        • DataFrameEngine.groupby_agg()
        • DataFrameEngine.filter()
        • DataFrameEngine.join()
        • DataFrameEngine.read_spatial()
        • DataFrameEngine.spatial_join()
        • DataFrameEngine.buffer()
        • DataFrameEngine.distance()
        • DataFrameEngine.to_geodataframe()
        • DataFrameEngine.from_geodataframe()
        • DataFrameEngine.index_points()
        • DataFrameEngine.index_polygon()
        • DataFrameEngine.point_in_polygon()
        • DataFrameEngine.dissolve()
        • DataFrameEngine.load_polygons()
        • DataFrameEngine.load_points()
        • DataFrameEngine.load_lines()
        • DataFrameEngine.assign_boundaries()
        • DataFrameEngine.intersect_boundaries()
        • DataFrameEngine.apportion()
        • DataFrameEngine.nearest()
        • DataFrameEngine.multi_assign()
      • PandasEngine
        • PandasEngine.name
        • PandasEngine.read_csv()
        • PandasEngine.read_parquet()
        • PandasEngine.query()
        • PandasEngine.to_pandas()
        • PandasEngine.groupby_agg()
        • PandasEngine.filter()
        • PandasEngine.join()
        • PandasEngine.read_spatial()
        • PandasEngine.spatial_join()
        • PandasEngine.buffer()
        • PandasEngine.distance()
        • PandasEngine.to_geodataframe()
      • DuckDBEngine
        • DuckDBEngine.__init__()
        • DuckDBEngine.name
        • DuckDBEngine.read_csv()
        • DuckDBEngine.read_parquet()
        • DuckDBEngine.query()
        • DuckDBEngine.to_pandas()
        • DuckDBEngine.groupby_agg()
        • DuckDBEngine.filter()
        • DuckDBEngine.join()
        • DuckDBEngine.read_spatial()
        • DuckDBEngine.spatial_join()
        • DuckDBEngine.buffer()
        • DuckDBEngine.distance()
        • DuckDBEngine.to_geodataframe()
        • DuckDBEngine.from_geodataframe()
      • SparkEngine
        • SparkEngine.__init__()
        • SparkEngine.name
        • SparkEngine.read_csv()
        • SparkEngine.read_parquet()
        • SparkEngine.query()
        • SparkEngine.to_pandas()
        • SparkEngine.groupby_agg()
        • SparkEngine.filter()
        • SparkEngine.join()
        • SparkEngine.read_spatial()
        • SparkEngine.spatial_join()
        • SparkEngine.buffer()
        • SparkEngine.distance()
        • SparkEngine.to_geodataframe()
        • SparkEngine.load_polygons()
        • SparkEngine.load_points()
        • SparkEngine.assign_boundaries()
        • SparkEngine.nearest()
      • PostGISEngine
        • PostGISEngine.__init__()
        • PostGISEngine.name
        • PostGISEngine.index_points()
        • PostGISEngine.read_csv()
        • PostGISEngine.read_parquet()
        • PostGISEngine.query()
        • PostGISEngine.to_pandas()
        • PostGISEngine.groupby_agg()
        • PostGISEngine.filter()
        • PostGISEngine.join()
        • PostGISEngine.read_spatial()
        • PostGISEngine.spatial_join()
        • PostGISEngine.buffer()
        • PostGISEngine.distance()
        • PostGISEngine.to_geodataframe()
      • get_engine()
  • Distributed
    • sanitise_dataframe_column_names()
    • tabulate_null_vs_not_null()
    • get_row_count()
    • repartition_and_cache()
    • register_temp_table()
    • move_column_to_front_of_dataframe()
    • write_df_to_parquet()
    • read_parquet_to_df()
    • flatten_json_column_and_join_back_to_df()
    • validate_geocode_data()
    • mark_valid_geocode_data()
    • clean_and_reorder_bbox()
    • ensure_literal()
    • reproject_geom_columns()
    • prepare_dataframe_for_export()
    • prepare_summary_dataframe()
    • export_pyspark_df_to_excel()
    • pivot_summary_table_for_bools()
    • pivot_summary_with_metrics()
    • export_prepared_df_as_csv_to_path_using_delimiter()
    • print_debug_table()
    • compute_walkability()
    • validate_geometry()
    • backup_full_dataframe()
    • atomic_write_with_staging()
    • create_unique_staging_directory()
    • py_round()
    • HDFSConfig
      • HDFSConfig.master
      • HDFSConfig.deploy_mode
      • HDFSConfig.yarn_queue
      • HDFSConfig.driver_memory
      • HDFSConfig.data_path
      • HDFSConfig.hdfs_base_directory
      • HDFSConfig.cache_directory
      • HDFSConfig.app_name
      • HDFSConfig.spark_log_level
      • HDFSConfig.master
      • HDFSConfig.deploy_mode
      • HDFSConfig.yarn_queue
      • HDFSConfig.enable_sedona
      • HDFSConfig.sedona_global_index_type
      • HDFSConfig.sedona_join_broadcast_threshold
      • HDFSConfig.num_executors
      • HDFSConfig.executor_cores
      • HDFSConfig.executor_memory
      • HDFSConfig.driver_memory
      • HDFSConfig.driver_cores
      • HDFSConfig.network_timeout
      • HDFSConfig.heartbeat_interval
      • HDFSConfig.hdfs_timeout
      • HDFSConfig.hdfs_copy_timeout
      • HDFSConfig.force_sync
      • HDFSConfig.log_info_func
      • HDFSConfig.log_error_func
      • HDFSConfig.hash_func
      • HDFSConfig.quick_signature_func
      • HDFSConfig.get_cache_path()
      • HDFSConfig.get_optimal_partitions()
      • HDFSConfig.is_yarn
      • HDFSConfig.is_local
      • HDFSConfig.log_info()
      • HDFSConfig.log_error()
      • HDFSConfig.__init__()
    • create_hdfs_config()
    • create_local_config()
    • create_cluster_config()
    • create_geocoding_config()
    • create_yarn_config()
    • create_census_analysis_config()
    • AbstractHDFSOperations
      • AbstractHDFSOperations.__init__()
      • AbstractHDFSOperations.check_hdfs_status()
      • AbstractHDFSOperations.create_spark_session()
      • AbstractHDFSOperations.sync_directory_to_hdfs()
      • AbstractHDFSOperations.setup_distributed_environment()
    • setup_distributed_environment()
    • create_hdfs_operations()
    • Submodules
      • sanitise_dataframe_column_names()
      • tabulate_null_vs_not_null()
      • get_row_count()
      • repartition_and_cache()
      • register_temp_table()
      • move_column_to_front_of_dataframe()
      • write_df_to_parquet()
      • read_parquet_to_df()
      • flatten_json_column_and_join_back_to_df()
      • validate_geocode_data()
      • mark_valid_geocode_data()
      • clean_and_reorder_bbox()
      • ensure_literal()
      • reproject_geom_columns()
      • prepare_dataframe_for_export()
      • prepare_summary_dataframe()
      • export_pyspark_df_to_excel()
      • pivot_summary_table_for_bools()
      • pivot_summary_with_metrics()
      • export_prepared_df_as_csv_to_path_using_delimiter()
      • print_debug_table()
      • compute_walkability()
      • validate_geometry()
      • backup_full_dataframe()
      • atomic_write_with_staging()
      • create_unique_staging_directory()
      • AbstractHDFSOperations
        • AbstractHDFSOperations.__init__()
        • AbstractHDFSOperations.check_hdfs_status()
        • AbstractHDFSOperations.create_spark_session()
        • AbstractHDFSOperations.sync_directory_to_hdfs()
        • AbstractHDFSOperations.setup_distributed_environment()
      • create_hdfs_operations()
      • setup_distributed_environment()
      • HDFSConfig
        • HDFSConfig.master
        • HDFSConfig.deploy_mode
        • HDFSConfig.yarn_queue
        • HDFSConfig.driver_memory
        • HDFSConfig.data_path
        • HDFSConfig.hdfs_base_directory
        • HDFSConfig.cache_directory
        • HDFSConfig.app_name
        • HDFSConfig.spark_log_level
        • HDFSConfig.master
        • HDFSConfig.deploy_mode
        • HDFSConfig.yarn_queue
        • HDFSConfig.enable_sedona
        • HDFSConfig.sedona_global_index_type
        • HDFSConfig.sedona_join_broadcast_threshold
        • HDFSConfig.num_executors
        • HDFSConfig.executor_cores
        • HDFSConfig.executor_memory
        • HDFSConfig.driver_memory
        • HDFSConfig.driver_cores
        • HDFSConfig.network_timeout
        • HDFSConfig.heartbeat_interval
        • HDFSConfig.hdfs_timeout
        • HDFSConfig.hdfs_copy_timeout
        • HDFSConfig.force_sync
        • HDFSConfig.log_info_func
        • HDFSConfig.log_error_func
        • HDFSConfig.hash_func
        • HDFSConfig.quick_signature_func
        • HDFSConfig.get_cache_path()
        • HDFSConfig.get_optimal_partitions()
        • HDFSConfig.is_yarn
        • HDFSConfig.is_local
        • HDFSConfig.log_info()
        • HDFSConfig.log_error()
        • HDFSConfig.__init__()
      • create_census_analysis_config()
      • create_cluster_config()
      • create_geocoding_config()
      • create_hdfs_config()
      • create_local_config()
      • create_yarn_config()
  • Databricks
    • build_databricks_run_url()
    • build_foreign_table_sql()
    • build_jdbc_url()
    • build_lakebase_psql_command()
    • build_pgpass_entry()
    • build_schema_and_table_sync_sql()
    • ensure_secret_scope()
    • geopandas_to_spark()
    • get_active_spark_session()
    • get_dbutils()
    • get_runtime_secret()
    • get_workspace_client()
    • pandas_to_spark()
    • parse_conninfo()
    • put_secret()
    • runtime_secret_exists()
    • spark_to_geopandas()
    • spark_to_pandas()
    • Submodules
      • geopandas_to_spark()
      • pandas_to_spark()
      • spark_to_geopandas()
      • spark_to_pandas()
      • get_workspace_client()
      • ensure_secret_scope()
      • get_runtime_secret()
      • put_secret()
      • runtime_secret_exists()
      • get_active_spark_session()
      • get_dbutils()
      • build_databricks_run_url()
      • build_foreign_table_sql()
      • build_schema_and_table_sync_sql()
      • quote_ident()
      • build_jdbc_url()
      • build_lakebase_psql_command()
      • build_pgpass_entry()
      • parse_conninfo()
      • build_foreign_table_sql()
      • build_schema_and_table_sync_sql()
      • quote_ident()
  • Trino
    • build_trino_federation_view_sql()
    • build_trino_schema_and_view_sync_sql()
    • quote_ident()
    • Submodules
      • build_trino_federation_view_sql()
      • build_trino_schema_and_view_sync_sql()
      • quote_ident()
  • Connectors
    • Protocol
      • ConnectorProtocol
        • ConnectorProtocol.provider_name
        • ConnectorProtocol.authenticate()
        • ConnectorProtocol.is_connected()
        • ConnectorProtocol.list_object_types()
        • ConnectorProtocol.get_objects()
        • ConnectorProtocol.create_record()
        • ConnectorProtocol.update_record()
        • ConnectorProtocol.upsert_records()
        • ConnectorProtocol.__init__()
      • UpsertResult
        • UpsertResult.success_count
        • UpsertResult.failure_count
        • UpsertResult.created_ids
        • UpsertResult.updated_ids
        • UpsertResult.errors
        • UpsertResult.total
        • UpsertResult.ok
        • UpsertResult.__init__()
      • UpsertError
        • UpsertError.record_index
        • UpsertError.message
        • UpsertError.field
        • UpsertError.code
        • UpsertError.__init__()
      • ConnectorError
      • ConnectorAuthError
      • ConnectorRateLimitError
        • ConnectorRateLimitError.__init__()
      • ConnectorNotFoundError
  • Config
    • get_service_timeout()
    • normalize_state_identifier()
    • get_fips_info()
    • Submodules
      • CredentialNotFoundError
        • CredentialNotFoundError.__init__()
      • CredentialManager
        • CredentialManager.__init__()
        • CredentialManager.get_credential()
        • CredentialManager.store_credential()
        • CredentialManager.store_google_analytics_credentials()
        • CredentialManager.get_google_analytics_credentials()
        • CredentialManager.list_stored_credentials()
        • CredentialManager.backend_status()
      • get_credential()
      • store_credential()
      • store_ga_credentials_from_file()
      • get_ga_credentials()
      • credential_status()
      • store_ga_service_account_from_file()
      • get_ga_service_account_credentials()
      • get_google_service_account_from_1password()
      • get_google_oauth_from_1password()
      • get_google_oauth_document_from_1password()
      • create_temporary_service_account_file()
      • create_connection_profile()
      • save_connection_profile()
      • load_connection_profile()
      • find_connection_by_name()
      • list_connection_profiles()
      • update_connection_profile()
      • verify_connection_profile()
      • get_connection_status()
      • cleanup_old_connections()
      • create_database_config()
      • save_database_config()
      • load_database_config()
      • get_spark_database_options()
      • test_database_connection()
      • list_database_configs()
      • create_spark_session_with_databases()
      • create_client_profile()
      • save_client_profile()
      • load_client_profile()
      • update_client_profile()
      • list_client_profiles()
      • search_client_profiles()
      • associate_client_with_project()
      • get_client_project_associations()
      • validate_client_profile()
      • create_project_config()
      • save_project_config()
      • load_project_config()
      • setup_project_directories()
      • get_project_path()
      • list_projects()
      • update_project_config()
      • UserProfile
        • UserProfile.username
        • UserProfile.email
        • UserProfile.full_name
        • UserProfile.github_login
        • UserProfile.organization
        • UserProfile.preferred_download_directory
        • UserProfile.default_output_format
        • UserProfile.preferred_map_style
        • UserProfile.default_color_scheme
        • UserProfile.default_dpi
        • UserProfile.default_figure_size
        • UserProfile.enable_logging
        • UserProfile.log_level
        • UserProfile.google_analytics_key
        • UserProfile.facebook_business_key
        • UserProfile.census_api_key
        • UserProfile.default_database
        • UserProfile.postgresql_connection
        • UserProfile.duckdb_path
        • UserProfile.__init__()
      • UserConfigManager
        • UserConfigManager.__init__()
        • UserConfigManager.get_user_profile()
        • UserConfigManager.update_user_profile()
        • UserConfigManager.get_download_directory()
        • UserConfigManager.setup_initial_profile()
        • UserConfigManager.get_api_key()
        • UserConfigManager.set_api_key()
        • UserConfigManager.get_database_connection()
        • UserConfigManager.set_database_connection()
        • UserConfigManager.export_config()
        • UserConfigManager.import_config()
      • get_user_config()
      • get_download_directory()
      • ConfigurationMigrator
        • ConfigurationMigrator.__init__()
        • ConfigurationMigrator.migrate_user_profile()
        • ConfigurationMigrator.migrate_client_profile()
        • ConfigurationMigrator.migrate_all_configurations()
        • ConfigurationMigrator.backup_legacy_configurations()
      • SiegeConfig
        • SiegeConfig.__init__()
        • SiegeConfig.get_user_profile()
        • SiegeConfig.get_client_profile()
        • SiegeConfig.save_user_profile()
        • SiegeConfig.save_client_profile()
      • migrate_configurations()
      • backup_and_migrate()
      • load_user_profile()
      • save_user_profile()
      • get_download_directory()
      • load_client_profile()
      • save_client_profile()
      • list_client_profiles()
      • export_config_yaml()
      • import_config_yaml()
      • ensure_directory_exists()
      • get_project_path()
      • get_cache_path()
      • get_output_path()
      • get_data_path()
      • setup_standard_directories()
      • get_file_type()
      • get_relative_to_home()
      • initialize_siege_directories()
      • create_directory_structure()
      • create_standard_project_structure()
      • save_directory_config()
      • load_directory_config()
      • ensure_directories_exist()
      • get_directory_info()
      • clean_empty_directories()
      • list_directory_configs()
      • get_timeout()
      • get_chart_dimensions()
      • get_file_path()
      • get_service_timeout()
      • get_service_row_limit()
      • SurveyType
        • SurveyType.DECENNIAL
        • SurveyType.ACS_1YR
        • SurveyType.ACS_3YR
        • SurveyType.ACS_5YR
        • SurveyType.CENSUS_BUSINESS
        • SurveyType.POPULATION_ESTIMATES
        • SurveyType.HOUSING_ESTIMATES
      • DataReliability
        • DataReliability.HIGH
        • DataReliability.MEDIUM
        • DataReliability.LOW
        • DataReliability.ESTIMATED
      • GeographyLevel
        • GeographyLevel.NATION
        • GeographyLevel.REGION
        • GeographyLevel.DIVISION
        • GeographyLevel.STATE
        • GeographyLevel.COUNTY
        • GeographyLevel.COUSUB
        • GeographyLevel.PLACE
        • GeographyLevel.CD
        • GeographyLevel.SLDU
        • GeographyLevel.SLDL
        • GeographyLevel.TRACT
        • GeographyLevel.BLOCK_GROUP
        • GeographyLevel.BLOCK
        • GeographyLevel.ZCTA
        • GeographyLevel.CBSA
        • GeographyLevel.PUMA
        • GeographyLevel.VTD
        • GeographyLevel.VTD20
        • GeographyLevel.TABBLOCK20
        • GeographyLevel.TABBLOCK10
        • GeographyLevel.COUNTY_SUBDIVISION
        • GeographyLevel.CONGRESSIONAL_DISTRICT
        • GeographyLevel.STATE_LEGISLATIVE_DISTRICT
        • GeographyLevel.ZIP_CODE
        • GeographyLevel.VOTING_DISTRICT
      • resolve_geographic_level()
      • normalize_state_identifier()
      • get_tiger_url()
      • validate_geographic_level()
      • get_fips_info()
      • SurveyType
        • SurveyType.DECENNIAL
        • SurveyType.ACS_1YR
        • SurveyType.ACS_3YR
        • SurveyType.ACS_5YR
        • SurveyType.CENSUS_BUSINESS
        • SurveyType.POPULATION_ESTIMATES
        • SurveyType.HOUSING_ESTIMATES
      • DataReliability
        • DataReliability.HIGH
        • DataReliability.MEDIUM
        • DataReliability.LOW
        • DataReliability.ESTIMATED
      • GeographyLevel
        • GeographyLevel.NATION
        • GeographyLevel.REGION
        • GeographyLevel.DIVISION
        • GeographyLevel.STATE
        • GeographyLevel.COUNTY
        • GeographyLevel.COUSUB
        • GeographyLevel.PLACE
        • GeographyLevel.CD
        • GeographyLevel.SLDU
        • GeographyLevel.SLDL
        • GeographyLevel.TRACT
        • GeographyLevel.BLOCK_GROUP
        • GeographyLevel.BLOCK
        • GeographyLevel.ZCTA
        • GeographyLevel.CBSA
        • GeographyLevel.PUMA
        • GeographyLevel.VTD
        • GeographyLevel.VTD20
        • GeographyLevel.TABBLOCK20
        • GeographyLevel.TABBLOCK10
        • GeographyLevel.COUNTY_SUBDIVISION
        • GeographyLevel.CONGRESSIONAL_DISTRICT
        • GeographyLevel.STATE_LEGISLATIVE_DISTRICT
        • GeographyLevel.ZIP_CODE
        • GeographyLevel.VOTING_DISTRICT
      • resolve_geographic_level()
      • normalize_state_identifier()
      • get_tiger_url()
      • validate_geographic_level()
      • get_fips_info()
      • get_locale_category()
      • get_locale_subcategory()
      • classify_urbanicity()
      • get_nces_download_url()
      • validate_locale_code()
      • get_urbanicity_info()
      • DataSourceRegistry
        • DataSourceRegistry.__init__()
        • DataSourceRegistry.register_source()
        • DataSourceRegistry.get_source()
        • DataSourceRegistry.list_sources()
        • DataSourceRegistry.list_by_type()
        • DataSourceRegistry.list_by_jurisdiction()
        • DataSourceRegistry.list_active()
        • DataSourceRegistry.register_credential()
        • DataSourceRegistry.get_credential()
        • DataSourceRegistry.load_from_yaml()
        • DataSourceRegistry.save_to_yaml()
      • GoogleAccountRegistry
        • GoogleAccountRegistry.__init__()
        • GoogleAccountRegistry.register()
        • GoogleAccountRegistry.remove()
        • GoogleAccountRegistry.get()
        • GoogleAccountRegistry.get_by_email()
        • GoogleAccountRegistry.get_default()
        • GoogleAccountRegistry.set_default()
        • GoogleAccountRegistry.list_accounts()
        • GoogleAccountRegistry.list_active()
        • GoogleAccountRegistry.list_by_type()
        • GoogleAccountRegistry.load()
        • GoogleAccountRegistry.save()
      • list_google_accounts_for_owner()
      • save_google_account_profile()
      • load_google_account_profile()
      • migrate_single_account()
      • HydraConfigManager
        • HydraConfigManager.__init__()
        • HydraConfigManager.load_config()
        • HydraConfigManager.load_user_profile()
        • HydraConfigManager.load_client_profile()
        • HydraConfigManager.load_database_connections()
        • HydraConfigManager.load_social_media_accounts()
        • HydraConfigManager.load_branding_config()
        • HydraConfigManager.load_user()
        • HydraConfigManager.load_client()
        • HydraConfigManager.save_user()
        • HydraConfigManager.save_client()
        • HydraConfigManager.cleanup()
      • ConfigurationMigrator
        • ConfigurationMigrator.__init__()
        • ConfigurationMigrator.migrate_user_profile()
        • ConfigurationMigrator.migrate_client_profile()
        • ConfigurationMigrator.migrate_all_configurations()
        • ConfigurationMigrator.backup_legacy_configurations()
      • migrate_configurations()
      • backup_and_migrate()
    • Models
      • UserProfile
        • UserProfile.validate_figure_size()
        • UserProfile.validate_username()
        • UserProfile.validate_email()
        • UserProfile.validate_github_login()
        • UserProfile.validate_api_key()
        • UserProfile.validate_download_directory()
        • UserProfile.model_config
      • ClientProfile
        • ClientProfile.contact_info
        • ClientProfile.branding_config
        • ClientProfile.report_preferences
        • ClientProfile.notes
        • ClientProfile.validate_client_code()
        • ClientProfile.validate_database_connections()
        • ClientProfile.validate_social_media_accounts()
        • ClientProfile.get_active_database_connections()
        • ClientProfile.get_active_social_media_accounts()
        • ClientProfile.get_database_connection_by_name()
        • ClientProfile.get_social_media_account_by_platform()
        • ClientProfile.add_database_connection()
        • ClientProfile.add_social_media_account()
        • ClientProfile.update_branding_config()
        • ClientProfile.update_report_preferences()
        • ClientProfile.get_summary()
        • ClientProfile.model_config
      • ContactInfo
        • ContactInfo.phone
        • ContactInfo.address
        • ContactInfo.website
        • ContactInfo.linkedin
        • ContactInfo.validate_email()
        • ContactInfo.validate_phone()
        • ContactInfo.validate_website()
        • ContactInfo.validate_linkedin()
        • ContactInfo.model_config
      • DatabaseConnection
        • DatabaseConnection.validate_host()
        • DatabaseConnection.validate_password()
        • DatabaseConnection.validate_port()
        • DatabaseConnection.validate_database_name()
        • DatabaseConnection.get_connection_string()
      • SocialMediaAccount
        • SocialMediaAccount.refresh_token
        • SocialMediaAccount.api_version
        • SocialMediaAccount.rate_limit_remaining
        • SocialMediaAccount.last_updated
        • SocialMediaAccount.validate_access_token()
        • SocialMediaAccount.validate_account_id()
        • SocialMediaAccount.validate_api_version()
        • SocialMediaAccount.get_api_base_url()
        • SocialMediaAccount.get_auth_headers()
        • SocialMediaAccount.model_config
      • BrandingConfig
        • BrandingConfig.logo_path
        • BrandingConfig.logo_width
        • BrandingConfig.logo_height
        • BrandingConfig.validate_color_contrast()
        • BrandingConfig.validate_font_name()
        • BrandingConfig.validate_logo_path()
        • BrandingConfig.validate_logo_dimensions()
        • BrandingConfig.get_color_scheme()
        • BrandingConfig.get_typography_scheme()
        • BrandingConfig.get_layout_scheme()
        • BrandingConfig.model_config
      • ReportPreferences
        • ReportPreferences.watermark_text
        • ReportPreferences.validate_sections()
        • ReportPreferences.validate_watermark()
        • ReportPreferences.validate_chart_dpi()
        • ReportPreferences.get_export_settings()
        • ReportPreferences.get_chart_settings()
        • ReportPreferences.get_layout_settings()
        • ReportPreferences.model_config
      • JurisdictionLevel
        • JurisdictionLevel.FEDERAL
        • JurisdictionLevel.STATE
        • JurisdictionLevel.COUNTY
        • JurisdictionLevel.MUNICIPAL
        • JurisdictionLevel.TRIBAL
        • JurisdictionLevel.__new__()
      • Jurisdiction
        • Jurisdiction.level
        • Jurisdiction.validate_state_fips_format()
        • Jurisdiction.validate_county_fips_format()
        • Jurisdiction.validate_jurisdiction_consistency()
      • DataSourceType
        • DataSourceType.CAMPAIGN_FINANCE
        • DataSourceType.VOTER_FILE
        • DataSourceType.BOUNDARY
        • DataSourceType.DEMOGRAPHIC
        • DataSourceType.EDUCATION
        • DataSourceType.LABOR
        • DataSourceType.ELECTION_ADMIN
        • DataSourceType.__new__()
      • DataSourceStatus
        • DataSourceStatus.ACTIVE
        • DataSourceStatus.PLANNED
        • DataSourceStatus.DEPRECATED
        • DataSourceStatus.UNAVAILABLE
        • DataSourceStatus.__new__()
      • DataSource
        • DataSource.source_type
        • DataSource.jurisdiction
        • DataSource.status
        • DataSource.auth_required
        • DataSource.notes
        • DataSource.validate_auth_type()
      • SourceCredential
        • SourceCredential.last_verified
      • GoogleAccount
        • GoogleAccount.validate_email()
        • GoogleAccount.validate_google_account_id()
        • GoogleAccount.validate_credential_refs()
        • GoogleAccount.is_active()
        • GoogleAccount.update_last_used()
        • GoogleAccount.get_info()
      • GoogleAccountType
        • GoogleAccountType.OAUTH
        • GoogleAccountType.SERVICE_ACCOUNT
        • GoogleAccountType.__new__()
      • GoogleAccountStatus
        • GoogleAccountStatus.ACTIVE
        • GoogleAccountStatus.REVOKED
        • GoogleAccountStatus.EXPIRED
        • GoogleAccountStatus.PENDING
        • GoogleAccountStatus.__new__()
      • User
        • User.validate_username()
        • User.validate_github_login()
        • User.validate_role()
        • User.validate_permissions()
        • User.has_permission()
        • User.add_permission()
        • User.remove_permission()
        • User.get_source_credential()
        • User.set_source_credential()
        • User.has_jurisdiction_access()
        • User.assign_client()
        • User.unassign_client()
        • User.set_primary_client()
        • User.get_assigned_clients()
        • User.has_client()
        • User.validate_assigned_clients()
        • User.validate_primary_client()
      • Client
        • Client.coerce_branding_config()
        • Client.coerce_report_preferences()
        • Client.validate_client_code()
        • Client.increment_project_count()
        • Client.decrement_project_count()
        • Client.is_active_client()
        • Client.operates_in_jurisdiction()
        • Client.has_source_enabled()
        • Client.assign_user()
        • Client.unassign_user()
        • Client.set_primary_user()
        • Client.get_assigned_users()
        • Client.has_user()
        • Client.validate_assigned_users()
        • Client.validate_primary_user()
      • Collaborator
        • Collaborator.validate_external_organization()
        • Collaborator.validate_access_expires()
        • Collaborator.validate_allowed_services()
        • Collaborator.validate_restricted_credentials()
        • Collaborator.is_access_expired()
        • Collaborator.is_collaboration_active()
        • Collaborator.can_access_service()
        • Collaborator.can_access_credential()
        • Collaborator.accept_invitation()
        • Collaborator.extend_access()
      • Organization
        • Organization.validate_primary_email()
        • Organization.validate_members()
        • Organization.add_member()
        • Organization.remove_member()
        • Organization.set_primary_contact()
        • Organization.get_summary()
        • Organization.to_dict()
        • Organization.to_yaml()
        • Organization.from_yaml()
      • Collaboration
        • Collaboration.validate_participants()
        • Collaboration.validate_end_date()
        • Collaboration.add_organization()
        • Collaboration.add_client()
        • Collaboration.add_participant()
        • Collaboration.is_active()
        • Collaboration.get_summary()
        • Collaboration.to_dict()
        • Collaboration.to_yaml()
        • Collaboration.from_yaml()
      • BrandingConfig
        • BrandingConfig.logo_path
        • BrandingConfig.logo_width
        • BrandingConfig.logo_height
        • BrandingConfig.validate_color_contrast()
        • BrandingConfig.validate_font_name()
        • BrandingConfig.validate_logo_path()
        • BrandingConfig.validate_logo_dimensions()
        • BrandingConfig.get_color_scheme()
        • BrandingConfig.get_typography_scheme()
        • BrandingConfig.get_layout_scheme()
        • BrandingConfig.model_config
      • ContactInfo
        • ContactInfo.phone
        • ContactInfo.address
        • ContactInfo.website
        • ContactInfo.linkedin
        • ContactInfo.validate_email()
        • ContactInfo.validate_phone()
        • ContactInfo.validate_website()
        • ContactInfo.validate_linkedin()
        • ContactInfo.model_config
      • ClientProfile
        • ClientProfile.contact_info
        • ClientProfile.branding_config
        • ClientProfile.report_preferences
        • ClientProfile.notes
        • ClientProfile.validate_client_code()
        • ClientProfile.validate_database_connections()
        • ClientProfile.validate_social_media_accounts()
        • ClientProfile.get_active_database_connections()
        • ClientProfile.get_active_social_media_accounts()
        • ClientProfile.get_database_connection_by_name()
        • ClientProfile.get_social_media_account_by_platform()
        • ClientProfile.add_database_connection()
        • ClientProfile.add_social_media_account()
        • ClientProfile.update_branding_config()
        • ClientProfile.update_report_preferences()
        • ClientProfile.get_summary()
        • ClientProfile.model_config
      • CredentialType
        • CredentialType.API_KEY
        • CredentialType.OAUTH_TOKEN
        • CredentialType.USERNAME_PASSWORD
        • CredentialType.SSH_KEY
        • CredentialType.CERTIFICATE
        • CredentialType.SECRET
        • CredentialType.__new__()
      • CredentialStatus
        • CredentialStatus.ACTIVE
        • CredentialStatus.EXPIRED
        • CredentialStatus.REVOKED
        • CredentialStatus.PENDING
        • CredentialStatus.__new__()
      • Credential
        • Credential.validate_name()
        • Credential.validate_service()
        • Credential.validate_password()
        • Credential.validate_api_key()
        • Credential.validate_expires_at()
        • Credential.is_expired()
        • Credential.is_valid()
        • Credential.update_last_used()
        • Credential.get_credential_data()
        • Credential.get_connection_info()
        • Credential.model_config
      • OnePasswordCredential
        • OnePasswordCredential.validate_1password_id()
        • OnePasswordCredential.get_1password_reference()
        • OnePasswordCredential.model_config
      • JurisdictionLevel
        • JurisdictionLevel.FEDERAL
        • JurisdictionLevel.STATE
        • JurisdictionLevel.COUNTY
        • JurisdictionLevel.MUNICIPAL
        • JurisdictionLevel.TRIBAL
        • JurisdictionLevel.__new__()
      • DataSourceType
        • DataSourceType.CAMPAIGN_FINANCE
        • DataSourceType.VOTER_FILE
        • DataSourceType.BOUNDARY
        • DataSourceType.DEMOGRAPHIC
        • DataSourceType.EDUCATION
        • DataSourceType.LABOR
        • DataSourceType.ELECTION_ADMIN
        • DataSourceType.__new__()
      • DataSourceStatus
        • DataSourceStatus.ACTIVE
        • DataSourceStatus.PLANNED
        • DataSourceStatus.DEPRECATED
        • DataSourceStatus.UNAVAILABLE
        • DataSourceStatus.__new__()
      • Jurisdiction
        • Jurisdiction.level
        • Jurisdiction.validate_state_fips_format()
        • Jurisdiction.validate_county_fips_format()
        • Jurisdiction.validate_jurisdiction_consistency()
      • DataSource
        • DataSource.source_type
        • DataSource.jurisdiction
        • DataSource.status
        • DataSource.auth_required
        • DataSource.notes
        • DataSource.validate_auth_type()
      • SourceCredential
        • SourceCredential.last_verified
      • DatabaseConnection
        • DatabaseConnection.validate_host()
        • DatabaseConnection.validate_password()
        • DatabaseConnection.validate_port()
        • DatabaseConnection.validate_database_name()
        • DatabaseConnection.get_connection_string()
      • export_entities()
      • import_entities()
      • GoogleAccountType
        • GoogleAccountType.OAUTH
        • GoogleAccountType.SERVICE_ACCOUNT
        • GoogleAccountType.__new__()
      • GoogleAccountStatus
        • GoogleAccountStatus.ACTIVE
        • GoogleAccountStatus.REVOKED
        • GoogleAccountStatus.EXPIRED
        • GoogleAccountStatus.PENDING
        • GoogleAccountStatus.__new__()
      • GoogleAccount
        • GoogleAccount.validate_email()
        • GoogleAccount.validate_google_account_id()
        • GoogleAccount.validate_credential_refs()
        • GoogleAccount.is_active()
        • GoogleAccount.update_last_used()
        • GoogleAccount.get_info()
      • OAuthProvider
        • OAuthProvider.GOOGLE
        • OAuthProvider.MICROSOFT
        • OAuthProvider.GITHUB
        • OAuthProvider.LINKEDIN
        • OAuthProvider.FACEBOOK
        • OAuthProvider.TWITTER
        • OAuthProvider.SALESFORCE
        • OAuthProvider.SLACK
        • OAuthProvider.ZOOM
        • OAuthProvider.HUBSPOT
        • OAuthProvider.ZOHO
        • OAuthProvider.DYNAMICS
        • OAuthProvider.CUSTOM
        • OAuthProvider.__new__()
      • OAuthScope
        • OAuthScope.READ
        • OAuthScope.WRITE
        • OAuthScope.ADMIN
        • OAuthScope.PROFILE
        • OAuthScope.EMAIL
        • OAuthScope.ANALYTICS
        • OAuthScope.FILES
        • OAuthScope.CALENDAR
        • OAuthScope.CONTACTS
        • OAuthScope.__new__()
      • OAuthIntegration
        • OAuthIntegration.validate_name()
        • OAuthIntegration.validate_service()
        • OAuthIntegration.validate_redirect_uri()
        • OAuthIntegration.validate_oauth_credentials()
        • OAuthIntegration.validate_expires_at()
        • OAuthIntegration.is_token_expired()
        • OAuthIntegration.needs_refresh()
        • OAuthIntegration.is_valid()
        • OAuthIntegration.update_last_used()
        • OAuthIntegration.update_tokens()
        • OAuthIntegration.get_authorization_url()
        • OAuthIntegration.get_integration_info()
        • OAuthIntegration.model_config
      • Person
        • Person.validate_email()
        • Person.validate_phone()
        • Person.validate_website()
        • Person.validate_linkedin()
        • Person.validate_organizations()
        • Person.validate_collaborations()
        • Person.add_credential()
        • Person.remove_credential()
        • Person.get_credential()
        • Person.get_credentials_for_service()
        • Person.get_valid_credentials()
        • Person.add_oauth_integration()
        • Person.remove_oauth_integration()
        • Person.get_oauth_integration()
        • Person.get_valid_oauth_integrations()
        • Person.add_database_connection()
        • Person.remove_database_connection()
        • Person.get_database_connection()
        • Person.add_onepassword_credential()
        • Person.remove_onepassword_credential()
        • Person.add_google_account()
        • Person.remove_google_account()
        • Person.get_google_account()
        • Person.get_google_account_by_email()
        • Person.get_default_google_account()
        • Person.set_default_google_account()
        • Person.list_google_accounts()
        • Person.add_organization()
        • Person.remove_organization()
        • Person.set_primary_organization()
        • Person.add_collaboration()
        • Person.remove_collaboration()
        • Person.get_summary()
        • Person.is_active()
        • Person.has_organization()
        • Person.has_collaboration()
        • Person.get_onepassword_credential()
        • Person.get_onepassword_credentials_for_service()
        • Person.get_onepassword_credentials_for_vault()
        • Person.has_onepassword_credential()
        • Person.has_onepassword_credentials_for_service()
        • Person.get_onepassword_services()
        • Person.get_onepassword_vaults()
        • Person.get_credential_coverage()
        • Person.get_security_recommendations()
        • Person.to_dict()
        • Person.to_yaml()
        • Person.from_yaml()
        • Person.model_config
      • PageOrientation
        • PageOrientation.PORTRAIT
        • PageOrientation.LANDSCAPE
        • PageOrientation.__new__()
      • ReportFormat
        • ReportFormat.PDF
        • ReportFormat.PPTX
        • ReportFormat.HTML
        • ReportFormat.DOCX
        • ReportFormat.__new__()
      • ReportPreferences
        • ReportPreferences.watermark_text
        • ReportPreferences.validate_sections()
        • ReportPreferences.validate_watermark()
        • ReportPreferences.validate_chart_dpi()
        • ReportPreferences.get_export_settings()
        • ReportPreferences.get_chart_settings()
        • ReportPreferences.get_layout_settings()
        • ReportPreferences.model_config
      • SocialMediaAccount
        • SocialMediaAccount.refresh_token
        • SocialMediaAccount.api_version
        • SocialMediaAccount.rate_limit_remaining
        • SocialMediaAccount.last_updated
        • SocialMediaAccount.validate_access_token()
        • SocialMediaAccount.validate_account_id()
        • SocialMediaAccount.validate_api_version()
        • SocialMediaAccount.get_api_base_url()
        • SocialMediaAccount.get_auth_headers()
        • SocialMediaAccount.model_config
      • UserProfile
        • UserProfile.validate_figure_size()
        • UserProfile.validate_username()
        • UserProfile.validate_email()
        • UserProfile.validate_github_login()
        • UserProfile.validate_api_key()
        • UserProfile.validate_download_directory()
        • UserProfile.model_config
  • conf — Project Settings
    • contextmanager()
    • Path
      • Path.__new__()
      • Path.cwd()
      • Path.home()
      • Path.samefile()
      • Path.iterdir()
      • Path.glob()
      • Path.rglob()
      • Path.absolute()
      • Path.resolve()
      • Path.stat()
      • Path.owner()
      • Path.group()
      • Path.open()
      • Path.read_bytes()
      • Path.read_text()
      • Path.write_bytes()
      • Path.write_text()
      • Path.readlink()
      • Path.touch()
      • Path.mkdir()
      • Path.chmod()
      • Path.lchmod()
      • Path.unlink()
      • Path.rmdir()
      • Path.lstat()
      • Path.rename()
      • Path.replace()
      • Path.symlink_to()
      • Path.hardlink_to()
      • Path.link_to()
      • Path.exists()
      • Path.is_dir()
      • Path.is_file()
      • Path.is_mount()
      • Path.is_symlink()
      • Path.is_block_device()
      • Path.is_char_device()
      • Path.is_fifo()
      • Path.is_socket()
      • Path.expanduser()
    • Settings
      • Settings.__new__()
      • Settings.reload()
      • Settings.override()
  • oss_unity_catalog — Unity Catalog Registration
    • build_external_table_payload()
    • register_external_table()

Data & Reference

  • Data
    • RDHClient
      • RDHClient.__init__()
      • RDHClient.close()
      • RDHClient.credentials_present()
      • RDHClient.validate_credentials()
      • RDHClient.list_datasets()
      • RDHClient.download_dataset()
      • RDHClient.load_csv()
      • RDHClient.load_shapefile()
      • RDHClient.get_enacted_plans()
      • RDHClient.get_precinct_data()
      • RDHClient.get_cvap_data()
      • RDHClient.get_pl94171_data()
      • RDHClient.to_crosstab_input()
    • RDHDataset
      • RDHDataset.title
      • RDHDataset.url
      • RDHDataset.state
      • RDHDataset.format
      • RDHDataset.year
      • RDHDataset.geography
      • RDHDataset.dataset_type
      • RDHDataset.official
      • RDHDataset.file_size
      • RDHDataset.raw
      • RDHDataset.filename
      • RDHDataset.is_shapefile
      • RDHDataset.is_csv
      • RDHDataset.__init__()
    • RDHDataFormat
      • RDHDataFormat.CSV
      • RDHDataFormat.SHAPEFILE
      • RDHDataFormat.__new__()
    • RDHDatasetType
      • RDHDatasetType.PL94171
      • RDHDatasetType.CVAP
      • RDHDatasetType.ACS5
      • RDHDatasetType.ELECTION
      • RDHDatasetType.LEGISLATIVE
      • RDHDatasetType.PRECINCT
      • RDHDatasetType.VOTER_FILE
      • RDHDatasetType.PROJECTION
      • RDHDatasetType.__new__()
    • polsby_popper()
    • reock()
    • convex_hull_ratio()
    • schwartzberg()
    • compute_compactness()
    • compare_plans()
    • demographic_profile()
    • fetch_enacted_plan()
    • fetch_precinct_results()
    • fetch_cvap()
    • fetch_pl94171()
    • fetch_demographic_summary()
    • CompactnessScores
      • CompactnessScores.district_id
      • CompactnessScores.polsby_popper
      • CompactnessScores.reock
      • CompactnessScores.convex_hull_ratio
      • CompactnessScores.schwartzberg
      • CompactnessScores.__init__()
    • Engine
      • Engine.PANDAS
      • Engine.DUCKDB
      • Engine.SPARK
      • Engine.POSTGIS
    • DataFrameEngine
      • DataFrameEngine.name
      • DataFrameEngine.read_csv()
      • DataFrameEngine.read_parquet()
      • DataFrameEngine.query()
      • DataFrameEngine.to_pandas()
      • DataFrameEngine.groupby_agg()
      • DataFrameEngine.filter()
      • DataFrameEngine.join()
      • DataFrameEngine.read_spatial()
      • DataFrameEngine.spatial_join()
      • DataFrameEngine.buffer()
      • DataFrameEngine.distance()
      • DataFrameEngine.to_geodataframe()
      • DataFrameEngine.from_geodataframe()
      • DataFrameEngine.index_points()
      • DataFrameEngine.index_polygon()
      • DataFrameEngine.point_in_polygon()
      • DataFrameEngine.dissolve()
      • DataFrameEngine.load_polygons()
      • DataFrameEngine.load_points()
      • DataFrameEngine.load_lines()
      • DataFrameEngine.assign_boundaries()
      • DataFrameEngine.intersect_boundaries()
      • DataFrameEngine.apportion()
      • DataFrameEngine.nearest()
      • DataFrameEngine.multi_assign()
    • PandasEngine
      • PandasEngine.name
      • PandasEngine.read_csv()
      • PandasEngine.read_parquet()
      • PandasEngine.query()
      • PandasEngine.to_pandas()
      • PandasEngine.groupby_agg()
      • PandasEngine.filter()
      • PandasEngine.join()
      • PandasEngine.read_spatial()
      • PandasEngine.spatial_join()
      • PandasEngine.buffer()
      • PandasEngine.distance()
      • PandasEngine.to_geodataframe()
    • DuckDBEngine
      • DuckDBEngine.__init__()
      • DuckDBEngine.name
      • DuckDBEngine.read_csv()
      • DuckDBEngine.read_parquet()
      • DuckDBEngine.query()
      • DuckDBEngine.to_pandas()
      • DuckDBEngine.groupby_agg()
      • DuckDBEngine.filter()
      • DuckDBEngine.join()
      • DuckDBEngine.read_spatial()
      • DuckDBEngine.spatial_join()
      • DuckDBEngine.buffer()
      • DuckDBEngine.distance()
      • DuckDBEngine.to_geodataframe()
      • DuckDBEngine.from_geodataframe()
    • SparkEngine
      • SparkEngine.__init__()
      • SparkEngine.name
      • SparkEngine.read_csv()
      • SparkEngine.read_parquet()
      • SparkEngine.query()
      • SparkEngine.to_pandas()
      • SparkEngine.groupby_agg()
      • SparkEngine.filter()
      • SparkEngine.join()
      • SparkEngine.read_spatial()
      • SparkEngine.spatial_join()
      • SparkEngine.buffer()
      • SparkEngine.distance()
      • SparkEngine.to_geodataframe()
      • SparkEngine.load_polygons()
      • SparkEngine.load_points()
      • SparkEngine.assign_boundaries()
      • SparkEngine.nearest()
    • PostGISEngine
      • PostGISEngine.__init__()
      • PostGISEngine.name
      • PostGISEngine.index_points()
      • PostGISEngine.read_csv()
      • PostGISEngine.read_parquet()
      • PostGISEngine.query()
      • PostGISEngine.to_pandas()
      • PostGISEngine.groupby_agg()
      • PostGISEngine.filter()
      • PostGISEngine.join()
      • PostGISEngine.read_spatial()
      • PostGISEngine.spatial_join()
      • PostGISEngine.buffer()
      • PostGISEngine.distance()
      • PostGISEngine.to_geodataframe()
    • get_engine()
    • Submodules
      • ChiSquareResult
        • ChiSquareResult.statistic
        • ChiSquareResult.p_value
        • ChiSquareResult.dof
        • ChiSquareResult.expected_freq
        • ChiSquareResult.statistic
        • ChiSquareResult.p_value
        • ChiSquareResult.dof
        • ChiSquareResult.expected_freq
        • ChiSquareResult.__init__()
      • CrossTabSpec
        • CrossTabSpec.row_var
        • CrossTabSpec.col_var
        • CrossTabSpec.value_var
        • CrossTabSpec.weight_var
        • CrossTabSpec.aggfunc
        • CrossTabSpec.geography
        • CrossTabSpec.row_var
        • CrossTabSpec.col_var
        • CrossTabSpec.value_var
        • CrossTabSpec.weight_var
        • CrossTabSpec.aggfunc
        • CrossTabSpec.geography
        • CrossTabSpec.__init__()
      • chi_square_test()
      • contingency_table()
      • moe_cross_tab()
      • rate_table()
      • Estimate
        • Estimate.value
        • Estimate.moe
        • Estimate.se
        • Estimate.cv
        • Estimate.cv_pct
        • Estimate.is_reliable()
        • Estimate.confidence_interval()
        • Estimate.__init__()
      • flag_unreliable()
      • moe_difference()
      • moe_product()
      • moe_proportion()
      • moe_ratio()
      • moe_sum()
      • NAICSCode
        • NAICSCode.code
        • NAICSCode.title
        • NAICSCode.level
        • NAICSCode.parent_code
        • NAICSCode.sector
        • NAICSCode.__init__()
      • parse_naics()
      • naics_ancestors()
      • naics_to_sector()
      • crosswalk_naics()
      • SOCCode
        • SOCCode.code
        • SOCCode.title
        • SOCCode.level
        • SOCCode.major_group
        • SOCCode.__init__()
      • parse_soc()
      • soc_to_major_group()
      • fuzzy_match_naics()
      • get_naics_lookup()
      • get_soc_lookup()
      • naics_title()
      • soc_title()
      • filter_by_naics()
      • filter_by_naics_sector()
      • group_by_naics_sector()
      • RDHClient
        • RDHClient.__init__()
        • RDHClient.close()
        • RDHClient.credentials_present()
        • RDHClient.validate_credentials()
        • RDHClient.list_datasets()
        • RDHClient.download_dataset()
        • RDHClient.load_csv()
        • RDHClient.load_shapefile()
        • RDHClient.get_enacted_plans()
        • RDHClient.get_precinct_data()
        • RDHClient.get_cvap_data()
        • RDHClient.get_pl94171_data()
        • RDHClient.to_crosstab_input()
      • RDHDataset
        • RDHDataset.title
        • RDHDataset.url
        • RDHDataset.state
        • RDHDataset.format
        • RDHDataset.year
        • RDHDataset.geography
        • RDHDataset.dataset_type
        • RDHDataset.official
        • RDHDataset.file_size
        • RDHDataset.raw
        • RDHDataset.filename
        • RDHDataset.is_shapefile
        • RDHDataset.is_csv
        • RDHDataset.__init__()
      • RDHDataFormat
        • RDHDataFormat.CSV
        • RDHDataFormat.SHAPEFILE
        • RDHDataFormat.__new__()
      • RDHDatasetType
        • RDHDatasetType.PL94171
        • RDHDatasetType.CVAP
        • RDHDatasetType.ACS5
        • RDHDatasetType.ELECTION
        • RDHDatasetType.LEGISLATIVE
        • RDHDatasetType.PRECINCT
        • RDHDatasetType.VOTER_FILE
        • RDHDatasetType.PROJECTION
        • RDHDatasetType.__new__()
      • polsby_popper()
      • reock()
      • convex_hull_ratio()
      • schwartzberg()
      • compute_compactness()
      • CompactnessScores
        • CompactnessScores.district_id
        • CompactnessScores.polsby_popper
        • CompactnessScores.reock
        • CompactnessScores.convex_hull_ratio
        • CompactnessScores.schwartzberg
        • CompactnessScores.__init__()
      • compare_plans()
      • demographic_profile()
      • fetch_enacted_plan()
      • fetch_precinct_results()
      • fetch_cvap()
      • fetch_pl94171()
      • fetch_demographic_summary()
      • list_available_datasets()
      • get_dataset_info()
      • load_sample_data()
      • get_census_boundaries()
      • get_census_data()
      • join_boundaries_and_data()
      • create_sample_dataset()
      • get_census_county_sample()
      • get_metropolitan_sample()
      • generate_synthetic_population()
      • generate_synthetic_businesses()
      • generate_synthetic_housing()
    • Statistics
      • ChiSquareResult
        • ChiSquareResult.statistic
        • ChiSquareResult.p_value
        • ChiSquareResult.dof
        • ChiSquareResult.expected_freq
        • ChiSquareResult.statistic
        • ChiSquareResult.p_value
        • ChiSquareResult.dof
        • ChiSquareResult.expected_freq
        • ChiSquareResult.__init__()
      • CrossTabSpec
        • CrossTabSpec.row_var
        • CrossTabSpec.col_var
        • CrossTabSpec.value_var
        • CrossTabSpec.weight_var
        • CrossTabSpec.aggfunc
        • CrossTabSpec.geography
        • CrossTabSpec.row_var
        • CrossTabSpec.col_var
        • CrossTabSpec.value_var
        • CrossTabSpec.weight_var
        • CrossTabSpec.aggfunc
        • CrossTabSpec.geography
        • CrossTabSpec.__init__()
      • chi_square_test()
      • contingency_table()
      • moe_cross_tab()
      • rate_table()
      • Estimate
        • Estimate.value
        • Estimate.moe
        • Estimate.se
        • Estimate.cv
        • Estimate.cv_pct
        • Estimate.is_reliable()
        • Estimate.confidence_interval()
        • Estimate.__init__()
      • flag_unreliable()
      • moe_difference()
      • moe_product()
      • moe_proportion()
      • moe_ratio()
      • moe_sum()
      • ChiSquareResult
        • ChiSquareResult.statistic
        • ChiSquareResult.p_value
        • ChiSquareResult.dof
        • ChiSquareResult.expected_freq
        • ChiSquareResult.statistic
        • ChiSquareResult.p_value
        • ChiSquareResult.dof
        • ChiSquareResult.expected_freq
        • ChiSquareResult.__init__()
      • CrossTabSpec
        • CrossTabSpec.row_var
        • CrossTabSpec.col_var
        • CrossTabSpec.value_var
        • CrossTabSpec.weight_var
        • CrossTabSpec.aggfunc
        • CrossTabSpec.geography
        • CrossTabSpec.row_var
        • CrossTabSpec.col_var
        • CrossTabSpec.value_var
        • CrossTabSpec.weight_var
        • CrossTabSpec.aggfunc
        • CrossTabSpec.geography
        • CrossTabSpec.__init__()
      • chi_square_test()
      • contingency_table()
      • moe_cross_tab()
      • rate_table()
      • Estimate
        • Estimate.value
        • Estimate.moe
        • Estimate.se
        • Estimate.cv
        • Estimate.cv_pct
        • Estimate.is_reliable()
        • Estimate.confidence_interval()
        • Estimate.__init__()
      • flag_unreliable()
      • moe_difference()
      • moe_product()
      • moe_proportion()
      • moe_ratio()
      • moe_sum()
  • Reference
    • NAICSCode
      • NAICSCode.code
      • NAICSCode.title
      • NAICSCode.level
      • NAICSCode.parent_code
      • NAICSCode.sector
      • NAICSCode.__init__()
    • parse_naics()
    • naics_ancestors()
    • naics_to_sector()
    • crosswalk_naics()
    • SOCCode
      • SOCCode.code
      • SOCCode.title
      • SOCCode.level
      • SOCCode.major_group
      • SOCCode.__init__()
    • parse_soc()
    • soc_to_major_group()
    • fuzzy_match_naics()
    • get_naics_lookup()
    • get_soc_lookup()
    • naics_title()
    • soc_title()
    • filter_by_naics()
    • filter_by_naics_sector()
    • group_by_naics_sector()
    • list_available_datasets()
    • get_dataset_info()
    • load_sample_data()
    • get_census_boundaries()
    • get_census_data()
    • join_boundaries_and_data()
    • create_sample_dataset()
    • get_census_county_sample()
    • get_metropolitan_sample()
    • generate_synthetic_population()
    • generate_synthetic_businesses()
    • generate_synthetic_housing()
    • Submodules
      • NAICSCode
        • NAICSCode.code
        • NAICSCode.title
        • NAICSCode.level
        • NAICSCode.parent_code
        • NAICSCode.sector
        • NAICSCode.__init__()
      • parse_naics()
      • naics_ancestors()
      • naics_to_sector()
      • crosswalk_naics()
      • SOCCode
        • SOCCode.code
        • SOCCode.title
        • SOCCode.level
        • SOCCode.major_group
        • SOCCode.__init__()
      • parse_soc()
      • soc_to_major_group()
      • fuzzy_match_naics()
      • get_naics_lookup()
      • get_soc_lookup()
      • naics_title()
      • soc_title()
      • filter_by_naics()
      • filter_by_naics_sector()
      • group_by_naics_sector()
      • list_available_datasets()
      • get_dataset_info()
      • load_sample_data()
      • get_census_boundaries()
      • get_census_data()
      • join_boundaries_and_data()
      • create_sample_dataset()
      • get_census_county_sample()
      • get_metropolitan_sample()
      • generate_synthetic_population()
      • generate_synthetic_businesses()
      • generate_synthetic_housing()
  • Schema
    • MigrationRunner
      • MigrationRunner.__init__()
      • MigrationRunner.discover_migrations()
      • MigrationRunner.applied_migrations()
      • MigrationRunner.status()
      • MigrationRunner.pending_migrations()
      • MigrationRunner.verify_checksums()
      • MigrationRunner.apply_all()
      • MigrationRunner.apply_up_to()
    • MigrationFile
      • MigrationFile.version
      • MigrationFile.description
      • MigrationFile.path
      • MigrationFile.sql_text
      • MigrationFile.checksum
      • MigrationFile.from_path()
      • MigrationFile.__init__()
    • MigrationStatus
      • MigrationStatus.APPLIED
      • MigrationStatus.PENDING
    • AppliedMigration
      • AppliedMigration.version
      • AppliedMigration.description
      • AppliedMigration.checksum
      • AppliedMigration.applied_at
      • AppliedMigration.__init__()
    • PendingMigration
      • PendingMigration.version
      • PendingMigration.description
      • PendingMigration.checksum
      • PendingMigration.path
      • PendingMigration.__init__()
    • Submodules
      • AppliedMigration
        • AppliedMigration.version
        • AppliedMigration.description
        • AppliedMigration.checksum
        • AppliedMigration.applied_at
        • AppliedMigration.__init__()
      • MigrationFile
        • MigrationFile.version
        • MigrationFile.description
        • MigrationFile.path
        • MigrationFile.sql_text
        • MigrationFile.checksum
        • MigrationFile.from_path()
        • MigrationFile.__init__()
      • MigrationRunner
        • MigrationRunner.__init__()
        • MigrationRunner.discover_migrations()
        • MigrationRunner.applied_migrations()
        • MigrationRunner.status()
        • MigrationRunner.pending_migrations()
        • MigrationRunner.verify_checksums()
        • MigrationRunner.apply_all()
        • MigrationRunner.apply_up_to()
      • MigrationStatus
        • MigrationStatus.APPLIED
        • MigrationStatus.PENDING
      • PendingMigration
        • PendingMigration.version
        • PendingMigration.description
        • PendingMigration.checksum
        • PendingMigration.path
        • PendingMigration.__init__()
  • Identifiers
    • attestation_uuid()
    • derive_root()
    • derive_sub_namespace()
    • normalize_name_v1()
    • uuid5_from_seed()
    • Submodules
      • derive_root()
      • derive_sub_namespace()
      • normalize_name_v1()
      • attestation_uuid()
      • uuid5_from_seed()
  • Hygiene
    • generate_docstrings()
    • Submodules
      • analyze_function_signature()
      • categorize_function()
      • generate_docstring_template()
      • DocstringAdder
        • DocstringAdder.__init__()
        • DocstringAdder.visit_FunctionDef()
      • process_python_file()
      • find_python_files()
      • main()
      • cli()

Output & Reporting

  • Reporting
    • TitlePageTemplate
      • TitlePageTemplate.__init__()
      • TitlePageTemplate.create_title_page()
    • create_title_page()
    • TableOfContentsTemplate
      • TableOfContentsTemplate.__init__()
      • TableOfContentsTemplate.create_table_of_contents()
    • create_table_of_contents()
    • generate_sections_from_report_structure()
    • ContentPageTemplate
      • ContentPageTemplate.__init__()
      • ContentPageTemplate.start_page()
      • ContentPageTemplate.add_section_title()
      • ContentPageTemplate.add_paragraph()
      • ContentPageTemplate.add_table()
      • ContentPageTemplate.add_bullet_list()
      • ContentPageTemplate.add_spacing()
      • ContentPageTemplate.get_remaining_space()
      • ContentPageTemplate.finish_page()
    • create_content_page()
    • ChartGenerator
    • ChartTypeRegistry
      • ChartTypeRegistry.__init__()
      • ChartTypeRegistry.register_chart_type()
      • ChartTypeRegistry.get_chart_type()
      • ChartTypeRegistry.list_chart_types()
      • ChartTypeRegistry.get_chart_categories()
      • ChartTypeRegistry.create_chart()
      • ChartTypeRegistry.add_chart_creator()
      • ChartTypeRegistry.validate_chart_parameters()
      • ChartTypeRegistry.get_chart_help()
      • ChartTypeRegistry.export_chart_type_config()
    • create_bar_chart()
    • create_line_chart()
    • create_scatter_plot()
    • create_pie_chart()
    • create_heatmap()
    • create_choropleth_map()
    • create_bivariate_choropleth()
    • create_marker_map()
    • create_flow_map()
    • create_convergence_diagram()
    • create_dashboard()
    • create_dataframe_summary_charts()
    • generate_chart_from_dataframe()
    • ClientBrandingManager
      • ClientBrandingManager.__init__()
      • ClientBrandingManager.create_client_branding()
      • ClientBrandingManager.get_client_branding()
      • ClientBrandingManager.update_client_branding()
      • ClientBrandingManager.list_clients()
      • ClientBrandingManager.delete_client_branding()
      • ClientBrandingManager.create_branding_from_template()
      • ClientBrandingManager.validate_branding_config()
      • ClientBrandingManager.export_branding_config()
      • ClientBrandingManager.import_branding_config()
      • ClientBrandingManager.get_branding_summary()
    • decode_rl_image()
    • show_rl_image()
    • save_rl_image()
    • Argument
      • Argument.headline
      • Argument.narrative
      • Argument.table
      • Argument.table_type
      • Argument.chart
      • Argument.map_figure
      • Argument.layout
      • Argument.base_note
      • Argument.source_note
      • Argument.tags
      • Argument.__init__()
    • TableType
      • TableType.SINGLE_RESPONSE
      • TableType.MULTIPLE_RESPONSE
      • TableType.CROSS_TAB
      • TableType.LONGITUDINAL
      • TableType.RANKING
      • TableType.MEAN_SCALE
      • TableType.BANNER
    • Algorithm
      • Algorithm.GREEDY
      • Algorithm.HUNGARIAN
      • Algorithm.ANNEALING
      • Algorithm.FORCE_DIRECTED
      • Algorithm.ILP
      • Algorithm.__new__()
    • Sizing
      • Sizing.EQUAL
      • Sizing.VALUE_PROPORTIONAL
      • Sizing.VALUE_SQRT
      • Sizing.__new__()
    • hex_tile_layout()
    • hex_tile_map()
    • register_layout()
    • IDMLExporter
      • IDMLExporter.__init__()
      • IDMLExporter.add_text_frame()
      • IDMLExporter.add_image_frame()
      • IDMLExporter.add_table()
      • IDMLExporter.replace_placeholder()
      • IDMLExporter.save()
    • export_report_idml()
    • ThreeDMapRenderer
      • ThreeDMapRenderer.__init__()
      • ThreeDMapRenderer.create_hexagon_layer()
      • ThreeDMapRenderer.create_column_layer()
      • ThreeDMapRenderer.create_choropleth_3d()
      • ThreeDMapRenderer.render_to_html()
      • ThreeDMapRenderer.render_in_notebook()
    • create_3d_hexbin()
    • create_3d_columns()
    • sort_table_data()
    • get_report_output_directory()
    • create_report_generator()
    • create_powerpoint_generator()
    • export_branding_config()
    • import_branding_config()
    • export_chart_type_config()
    • ReportingConfigError
    • Charts and Visualization
      • ChartGenerator
      • create_bar_chart()
      • create_bivariate_choropleth()
      • create_choropleth_map()
      • create_convergence_diagram()
      • create_dashboard()
      • create_dataframe_summary_charts()
      • create_flow_map()
      • create_heatmap()
      • create_line_chart()
      • create_marker_map()
      • create_pie_chart()
      • create_scatter_plot()
      • generate_chart_from_dataframe()
      • ChartCreationError
      • ChartParameterError
      • ChartType
        • ChartType.name
        • ChartType.category
        • ChartType.description
        • ChartType.required_parameters
        • ChartType.optional_parameters
        • ChartType.supports_interactive
        • ChartType.supports_3d
        • ChartType.supports_animation
        • ChartType.default_width
        • ChartType.default_height
        • ChartType.default_dpi
        • ChartType.custom_options
        • ChartType.create_function
        • ChartType.validate_function
        • ChartType.customize_function
        • ChartType.__init__()
      • ChartTypeRegistry
        • ChartTypeRegistry.__init__()
        • ChartTypeRegistry.chart_types
        • ChartTypeRegistry.register_chart_type()
        • ChartTypeRegistry.get_chart_type()
        • ChartTypeRegistry.list_chart_types()
        • ChartTypeRegistry.get_chart_categories()
        • ChartTypeRegistry.create_chart()
        • ChartTypeRegistry.add_chart_creator()
        • ChartTypeRegistry.validate_chart_parameters()
        • ChartTypeRegistry.get_chart_help()
        • ChartTypeRegistry.export_chart_type_config()
      • UnknownChartTypeError
      • create_chart()
      • get_chart_registry()
      • register_chart_type()
      • WaveChartError
      • heatmap()
      • trend_chart()
      • ColorScheme
        • ColorScheme.BLUE
        • ColorScheme.GREEN
        • ColorScheme.RED
        • ColorScheme.PURPLE
        • ColorScheme.ORANGE
        • ColorScheme.GRAY
      • LegendManager
        • LegendManager.__init__()
        • LegendManager.get_color_for_intensity()
        • LegendManager.create_heatmap_legend_table()
        • LegendManager.create_matplotlib_legend()
        • LegendManager.create_legend_for_series()
        • LegendManager.create_heatmap_legend_elements()
        • LegendManager.add_heatmap_legend_to_plot()
        • LegendManager.get_legend_position_for_chart_type()
        • LegendManager.should_show_legend()
      • LegendPosition
        • LegendPosition.BEST
        • LegendPosition.OUTSIDE
        • LegendPosition.BOTTOM
        • LegendPosition.TOP
        • LegendPosition.LEFT
        • LegendPosition.RIGHT
        • LegendPosition.CENTER
      • create_heatmap_legend_table()
      • get_optimal_legend_position()
      • decode_rl_image()
      • show_rl_image()
      • save_rl_image()
    • Chart Engines
      • BaseChartEngine
        • BaseChartEngine.__init__()
        • BaseChartEngine.save_figure_as_vector()
        • BaseChartEngine.create_chart_with_caption()
        • BaseChartEngine.create_chart_section()
        • BaseChartEngine.generate_chart_from_dataframe()
        • BaseChartEngine.create_custom_chart()
      • BarChartMixin
        • BarChartMixin.create_bar_chart()
        • BarChartMixin.create_line_chart()
        • BarChartMixin.create_pie_chart()
        • BarChartMixin.create_proportional_text_bar_chart()
      • MapChartMixin
        • MapChartMixin.create_choropleth_map()
        • MapChartMixin.create_bivariate_choropleth_matplotlib()
        • MapChartMixin.create_advanced_choropleth()
        • MapChartMixin.create_marker_map()
        • MapChartMixin.create_3d_map()
        • MapChartMixin.create_heatmap_map()
        • MapChartMixin.create_cluster_map()
        • MapChartMixin.create_flow_map()
        • MapChartMixin.create_bivariate_choropleth()
      • StatsChartMixin
        • StatsChartMixin.create_heatmap()
        • StatsChartMixin.create_scatter_plot()
        • StatsChartMixin.create_heatmap_text_chart()
      • CompositeChartMixin
        • CompositeChartMixin.create_convergence_diagram()
        • CompositeChartMixin.create_dashboard()
        • CompositeChartMixin.create_dataframe_summary_charts()
      • BaseChartEngine
        • BaseChartEngine.__init__()
        • BaseChartEngine.save_figure_as_vector()
        • BaseChartEngine.create_chart_with_caption()
        • BaseChartEngine.create_chart_section()
        • BaseChartEngine.generate_chart_from_dataframe()
        • BaseChartEngine.create_custom_chart()
      • BarChartMixin
        • BarChartMixin.create_bar_chart()
        • BarChartMixin.create_line_chart()
        • BarChartMixin.create_pie_chart()
        • BarChartMixin.create_proportional_text_bar_chart()
      • CompositeChartMixin
        • CompositeChartMixin.create_convergence_diagram()
        • CompositeChartMixin.create_dashboard()
        • CompositeChartMixin.create_dataframe_summary_charts()
      • MapChartMixin
        • MapChartMixin.create_choropleth_map()
        • MapChartMixin.create_bivariate_choropleth_matplotlib()
        • MapChartMixin.create_advanced_choropleth()
        • MapChartMixin.create_marker_map()
        • MapChartMixin.create_3d_map()
        • MapChartMixin.create_heatmap_map()
        • MapChartMixin.create_cluster_map()
        • MapChartMixin.create_flow_map()
        • MapChartMixin.create_bivariate_choropleth()
      • StatsChartMixin
        • StatsChartMixin.create_heatmap()
        • StatsChartMixin.create_scatter_plot()
        • StatsChartMixin.create_heatmap_text_chart()
    • Reports and Documents
      • ReportGenerator
        • ReportGenerator.__init__()
        • ReportGenerator.create_analytics_report()
        • ReportGenerator.create_comprehensive_report()
        • ReportGenerator.add_section()
        • ReportGenerator.add_table_section()
        • ReportGenerator.add_text_section()
        • ReportGenerator.add_chart_section()
        • ReportGenerator.add_map_section()
        • ReportGenerator.add_appendix()
        • ReportGenerator.generate_pdf_report()
      • AnalyticsReportGenerator
        • AnalyticsReportGenerator.__init__()
        • AnalyticsReportGenerator.create_google_analytics_report()
        • AnalyticsReportGenerator.create_website_performance_report()
        • AnalyticsReportGenerator.create_custom_analytics_report()
        • AnalyticsReportGenerator.create_monthly_analytics_report()
        • AnalyticsReportGenerator.create_quarterly_analytics_report()
        • AnalyticsReportGenerator.create_campaign_performance_report()
      • PowerPointGenerator
        • PowerPointGenerator.__init__()
        • PowerPointGenerator.create_analytics_presentation()
        • PowerPointGenerator.create_performance_presentation()
        • PowerPointGenerator.create_custom_presentation()
        • PowerPointGenerator.create_comprehensive_presentation()
        • PowerPointGenerator.add_slide_section()
        • PowerPointGenerator.add_text_slide()
        • PowerPointGenerator.add_chart_slide()
        • PowerPointGenerator.add_map_slide()
        • PowerPointGenerator.add_table_slide()
        • PowerPointGenerator.add_comparison_slide()
        • PowerPointGenerator.add_summary_slide()
        • PowerPointGenerator.generate_powerpoint_presentation()
        • PowerPointGenerator.create_presentation_from_dataframe()
      • IDMLExporter
        • IDMLExporter.__init__()
        • IDMLExporter.add_text_frame()
        • IDMLExporter.add_image_frame()
        • IDMLExporter.add_table()
        • IDMLExporter.replace_placeholder()
        • IDMLExporter.save()
      • export_report_idml()
      • ClientBrandingError
      • ClientBrandingManager
        • ClientBrandingManager.__init__()
        • ClientBrandingManager.create_client_branding()
        • ClientBrandingManager.get_client_branding()
        • ClientBrandingManager.update_client_branding()
        • ClientBrandingManager.list_clients()
        • ClientBrandingManager.delete_client_branding()
        • ClientBrandingManager.create_branding_from_template()
        • ClientBrandingManager.validate_branding_config()
        • ClientBrandingManager.export_branding_config()
        • ClientBrandingManager.import_branding_config()
        • ClientBrandingManager.get_branding_summary()
      • ClientBrandingNotFoundError
    • Analytics Reports
      • AnalyticsReportGenerator
        • AnalyticsReportGenerator.__init__()
        • AnalyticsReportGenerator.create_google_analytics_report()
        • AnalyticsReportGenerator.create_website_performance_report()
        • AnalyticsReportGenerator.create_custom_analytics_report()
        • AnalyticsReportGenerator.create_monthly_analytics_report()
        • AnalyticsReportGenerator.create_quarterly_analytics_report()
        • AnalyticsReportGenerator.create_campaign_performance_report()
      • PollingAnalysisError
      • PollingAnalyzer
        • PollingAnalyzer.__init__()
        • PollingAnalyzer.create_cross_tabulation_matrix()
        • PollingAnalyzer.create_longitudinal_analysis()
        • PollingAnalyzer.create_performance_rankings()
        • PollingAnalyzer.create_change_detection_data()
        • PollingAnalyzer.create_polling_summary()
        • PollingAnalyzer.create_heatmap_visualization()
        • PollingAnalyzer.create_trend_analysis_chart()
    • Hex Cartograms
      • Algorithm
        • Algorithm.GREEDY
        • Algorithm.HUNGARIAN
        • Algorithm.ANNEALING
        • Algorithm.FORCE_DIRECTED
        • Algorithm.ILP
        • Algorithm.__new__()
      • Sizing
        • Sizing.EQUAL
        • Sizing.VALUE_PROPORTIONAL
        • Sizing.VALUE_SQRT
        • Sizing.__new__()
      • hex_tile_layout()
      • hex_tile_map()
      • register_layout()
      • Algorithm
        • Algorithm.GREEDY
        • Algorithm.HUNGARIAN
        • Algorithm.ANNEALING
        • Algorithm.FORCE_DIRECTED
        • Algorithm.ILP
        • Algorithm.__new__()
      • place_polygons()
      • find_components()
      • offset_layout()
      • stitch_components()
      • Conventions
      • axial_distance()
      • axial_neighbors()
      • axial_to_cartesian()
      • bounding_grid()
      • hexagon_polygon()
      • BUILTIN_LAYOUTS
      • REGISTERED_LAYOUTS
      • hex_tile_layout()
      • register_layout()
      • Sizing
        • Sizing.EQUAL
        • Sizing.VALUE_PROPORTIONAL
        • Sizing.VALUE_SQRT
        • Sizing.__new__()
      • hex_tile_map()
    • 3D Maps
      • ThreeDMapRenderer
        • ThreeDMapRenderer.__init__()
        • ThreeDMapRenderer.create_hexagon_layer()
        • ThreeDMapRenderer.create_column_layer()
        • ThreeDMapRenderer.create_choropleth_3d()
        • ThreeDMapRenderer.render_to_html()
        • ThreeDMapRenderer.render_in_notebook()
      • create_3d_columns()
      • create_3d_hexbin()
    • Pages
      • Page
        • Page.__init__()
        • Page.build()
        • Page.add_spacer()
        • Page.add_paragraph()
        • Page.add_page_break()
        • Page.get_content()
      • TitlePage
        • TitlePage.__init__()
        • TitlePage.create_blue_bar_style()
        • TitlePage.create_title_style()
        • TitlePage.create_tagline_style()
        • TitlePage.create_details_style()
        • TitlePage.build()
      • TableOfContentsPage
        • TableOfContentsPage.__init__()
        • TableOfContentsPage.create_header_style()
        • TableOfContentsPage.create_section_style()
        • TableOfContentsPage.create_item_style()
        • TableOfContentsPage.build()
      • ContentPage
        • ContentPage.__init__()
        • ContentPage.create_section_header_style()
        • ContentPage.create_subsection_header_style()
      • TableType
        • TableType.SINGLE_RESPONSE
        • TableType.MULTIPLE_RESPONSE
        • TableType.CROSS_TAB
        • TableType.LONGITUDINAL
        • TableType.RANKING
        • TableType.MEAN_SCALE
        • TableType.BANNER
      • Argument
        • Argument.headline
        • Argument.narrative
        • Argument.table
        • Argument.table_type
        • Argument.chart
        • Argument.map_figure
        • Argument.layout
        • Argument.base_note
        • Argument.source_note
        • Argument.tags
        • Argument.__init__()
      • Page
        • Page.__init__()
        • Page.build()
        • Page.add_spacer()
        • Page.add_paragraph()
        • Page.add_page_break()
        • Page.get_content()
      • TitlePage
        • TitlePage.__init__()
        • TitlePage.create_blue_bar_style()
        • TitlePage.create_title_style()
        • TitlePage.create_tagline_style()
        • TitlePage.create_details_style()
        • TitlePage.build()
      • TableOfContentsPage
        • TableOfContentsPage.__init__()
        • TableOfContentsPage.create_header_style()
        • TableOfContentsPage.create_section_style()
        • TableOfContentsPage.create_item_style()
        • TableOfContentsPage.build()
      • ContentPage
        • ContentPage.__init__()
        • ContentPage.create_section_header_style()
        • ContentPage.create_subsection_header_style()
  • Profiles

Utilities

  • Core
    • get_logger()
    • log_info()
    • log_warning()
    • log_error()
    • log_debug()
    • log_critical()
    • init_logger()
    • configure_shared_logging()
    • remove_wrapping_quotes_and_trim()
    • clean_string()
    • normalize_whitespace()
    • snake_case()
    • remove_non_alphanumeric()
    • validate_sql_identifier()
    • validate_sql_identifier_in()
    • escape_sql_string_literal()
    • validate_sql_fragment()
    • Submodules
      • LoggerName
      • LoggerManager
        • LoggerManager.__init__()
        • LoggerManager.configure_shared_logging()
        • LoggerManager.get_logger()
        • LoggerManager.cleanup_logger()
        • LoggerManager.cleanup_all_loggers()
        • LoggerManager.set_default_logger_name()
      • LoggingConfig
        • LoggingConfig.log_to_file
        • LoggingConfig.log_dir
        • LoggingConfig.max_bytes
        • LoggingConfig.backup_count
        • LoggingConfig.log_to_console
        • LoggingConfig.console_level
        • LoggingConfig.file_level
        • LoggingConfig.shared_log_file
        • LoggingConfig.shared_level
        • LoggingConfig.__init__()
      • configure_shared_logging()
      • get_logger()
      • init_logger()
      • cleanup_logger()
      • cleanup_all_loggers()
      • set_default_logger_name()
      • log_debug()
      • log_info()
      • log_warning()
      • log_error()
      • log_critical()
      • parse_log_level()
      • temporary_logging_config()
      • remove_wrapping_quotes_and_trim()
      • clean_string()
      • normalize_whitespace()
      • snake_case()
      • remove_non_alphanumeric()
      • validate_sql_identifier()
      • validate_sql_identifier_in()
      • escape_sql_string_literal()
      • validate_sql_fragment()
  • Files
    • ensure_path_exists()
    • unzip_file_to_directory()
    • get_file_extension()
    • get_file_name_without_extension()
    • is_hidden_file()
    • get_relative_path()
    • find_files_by_pattern()
    • create_backup_path()
    • normalize_path()
    • remove_tree()
    • file_exists()
    • touch_file()
    • count_lines()
    • copy_file()
    • move_file()
    • get_file_size()
    • list_directory()
    • run_command()
    • delete_existing_file_and_replace_it_with_an_empty_file()
    • ensure_directory_exists()
    • safe_file_write()
    • safe_file_read()
    • safe_json_write()
    • safe_json_read()
    • get_file_size_mb()
    • list_files_recursive()
    • download_file()
    • generate_local_path_from_url()
    • download_file_with_retry()
    • get_file_info()
    • is_downloadable()
    • get_download_directory()
    • SpatialFormat
      • SpatialFormat.GEOPARQUET
      • SpatialFormat.PARQUET
      • SpatialFormat.GPKG
      • SpatialFormat.GEOJSON
      • SpatialFormat.TOPOJSON
      • SpatialFormat.CSV
      • SpatialFormat.SHAPEFILE
      • SpatialFormat.__new__()
    • TabularFormat
      • TabularFormat.PARQUET
      • TabularFormat.CSV
      • TabularFormat.EXCEL
      • TabularFormat.JSON
      • TabularFormat.__new__()
    • save_spatial()
    • save_tabular()
    • generate_sha256_hash_for_file()
    • get_file_hash()
    • calculate_file_hash()
    • get_quick_file_signature()
    • verify_file_integrity()
    • Submodules
      • sanitize_filename()
      • atomic_write_path()
      • atomic_write_shapefile()
      • remove_tree()
      • file_exists()
      • touch_file()
      • count_lines()
      • copy_file()
      • move_file()
      • get_file_size()
      • list_directory()
      • run_command()
      • ensure_directory_exists()
      • safe_file_write()
      • safe_file_read()
      • safe_json_write()
      • safe_json_read()
      • get_file_size_mb()
      • list_files_recursive()
      • rmtree()
      • check_if_file_exists_at_path()
      • delete_existing_file_and_replace_it_with_an_empty_file()
      • count_total_rows_in_file_pythonically()
      • calculate_file_hash()
      • generate_sha256_hash_for_file()
      • get_file_hash()
      • get_quick_file_signature()
      • verify_file_integrity()
      • ensure_path_exists()
      • unzip_file_to_directory()
      • get_file_extension()
      • get_file_name_without_extension()
      • is_hidden_file()
      • get_relative_path()
      • find_files_by_pattern()
      • create_backup_path()
      • normalize_path()
      • unzip_file_to_its_own_directory()
      • download_file()
      • generate_local_path_from_url()
      • download_file_with_retry()
      • get_file_info()
      • is_downloadable()
      • run_subprocess()
      • validate_command_safety()
      • SecurityError
      • SpatialFormat
        • SpatialFormat.GEOPARQUET
        • SpatialFormat.PARQUET
        • SpatialFormat.GPKG
        • SpatialFormat.GEOJSON
        • SpatialFormat.TOPOJSON
        • SpatialFormat.CSV
        • SpatialFormat.SHAPEFILE
        • SpatialFormat.__new__()
      • TabularFormat
        • TabularFormat.PARQUET
        • TabularFormat.CSV
        • TabularFormat.EXCEL
        • TabularFormat.JSON
        • TabularFormat.__new__()
      • save_spatial()
      • save_tabular()
      • PathSecurityError
      • is_path_traversal_attempt()
      • is_sensitive_path()
      • validate_safe_path()
      • validate_file_path()
      • validate_directory_path()
      • safe_join_paths()
  • Git
    • GitError
    • analyze_branch_status()
    • generate_branch_report()
    • get_commit_history()
    • categorize_commits()
    • get_file_changes()
    • create_feature_branch()
    • switch_branch()
    • merge_branch()
    • rebase_branch()
    • stash_changes()
    • apply_stash()
    • clean_working_directory()
    • reset_to_commit()
    • cherry_pick_commit()
    • create_tag()
    • push_branch()
    • pull_branch()
    • get_repository_status()
    • get_branch_info()
    • get_remote_info()
    • get_stash_list()
    • get_tag_list()
    • get_log_summary()
    • start_feature_workflow()
    • complete_feature_workflow()
    • hotfix_workflow()
    • release_workflow()
    • validate_branch_naming()
    • enforce_commit_conventions()
    • Submodules
      • analyze_branch_status()
      • get_commit_history()
      • categorize_commits()
      • get_file_changes()
      • get_file_stats()
      • generate_branch_report()
      • create_feature_branch()
      • switch_branch()
      • merge_branch()
      • rebase_branch()
      • stash_changes()
      • apply_stash()
      • clean_working_directory()
      • reset_to_commit()
      • cherry_pick_commit()
      • create_tag()
      • push_branch()
      • pull_branch()
      • get_repository_status()
      • get_branch_info()
      • get_remote_info()
      • get_stash_list()
      • get_tag_list()
      • get_log_summary()
      • get_file_status()
      • get_repository_size()
      • validate_branch_naming()
      • enforce_commit_conventions()
      • start_feature_workflow()
      • complete_feature_workflow()
      • hotfix_workflow()
      • release_workflow()
      • get_workflow_status()
      • GitSecurityError
      • validate_branch_name()
      • validate_tag_name()
      • validate_commit_message()
      • validate_commit_hash()
      • validate_remote_name()
      • validate_repo_path()
      • validate_git_ref_name()
      • has_dangerous_characters()
      • run_git_command()
  • Admin
    • get_default_profile_location()
    • set_profile_location()
    • get_profile_location()
    • list_profile_locations()
    • migrate_profiles()
    • create_default_profiles()
    • validate_profile_location()
    • Submodules
      • create_default_profiles()
      • get_default_profile_location()
      • get_profile_location()
      • get_profile_summary()
      • list_profile_locations()
      • migrate_profiles()
      • set_profile_location()
      • validate_profile_location()
  • Cache
    • SampleDatasetError
    • ensure_sample_dataset()
  • Testing
    • setup_spark_environment()
    • get_system_info()
    • ensure_env_vars()
    • check_java_version()
    • diagnose_environment()
    • quick_environment_setup()
    • run_test_suite()
    • get_test_report()
    • run_comprehensive_test()
    • quick_smoke_test()
    • build_pytest_command()
    • Submodules
      • ensure_env_vars()
      • check_java_version()
      • setup_spark_environment()
      • get_system_info()
      • diagnose_environment()
      • quick_environment_setup()
      • run_command()
      • quick_smoke_test()
      • build_pytest_command()
      • run_test_suite()
      • get_test_report()
      • run_comprehensive_test()
  • development — Internal Development Tooling
    • generate_architecture_diagram()
    • analyze_package_structure()
  • Exception Hierarchy
    • Design principles
    • Reporting
      • Top-level config export / import
        • ReportingConfigError
      • Chart type registry
        • UnknownChartTypeError
        • ChartParameterError
        • ChartCreationError
      • Client branding
        • ClientBrandingNotFoundError
        • ClientBrandingError
    • Geographic
      • Census Bureau geocoder
        • CensusGeocodeError
      • Spatial data sources
        • SpatialDataError
      • Boundary retrieval
        • BoundaryRetrievalError
        • BoundaryInputError
        • BoundaryDiscoveryError
        • BoundaryUrlValidationError
        • BoundaryDownloadError
        • BoundaryParseError
        • BoundaryConfigurationError
    • Migration guidance
    • Further reading

Examples & Notebooks

  • Jupyter Notebooks
    • Foundations
    • Engines
    • Spatial
    • Analytics
    • Reports
    • Economic
    • Git
    • Config

Development

  • Contributor Governance
  • Coding Style
  • PR Review Rubric
  • Testing Guide
    • Overview
    • Test Structure
    • Running Tests
      • Basic Test Execution
      • Test Runner Script
      • Coverage and Reporting
      • Parallel Execution
    • Test Markers
    • Writing New Tests
      • Test File Structure
      • Test Naming Conventions
      • Example Test Patterns
    • Test Fixtures
    • Test Configuration
      • Pytest Configuration
      • Coverage Configuration
    • Continuous Integration
      • CI Pipeline
    • Debugging Tests
      • Verbose Output
      • Debug Mode
      • Single Test Execution
      • Test Isolation
    • Performance Testing
      • Benchmark Tests
      • Load Testing
    • Test Data Management
      • Test Data Generation
      • Data Cleanup
    • Best Practices
      • Test Organization
      • Test Independence
      • Test Coverage
      • Performance Considerations
    • Common Patterns
      • Configuration Testing
      • File Operation Testing
      • API Testing
    • Troubleshooting
      • Common Issues
    • Getting Help
  • Change Classification and Release Policy
  • Repository Hygiene
    • Policy goals
    • Tracked vs ignored artifacts
    • Special exception: notebooks output
    • Scripts policy
  • License Model
Siege Utilities
  • Search

© Copyright 2025-2026, Dheeraj Chand.

Built with Sphinx using a theme provided by Read the Docs.