Siege Utilities

Getting Started:

  • Getting Started
    • Quick Start
    • Core Capabilities
      • 🔧 Core Utilities (16 functions)
      • 📁 File Operations (22 functions)
      • 🚀 Distributed Computing (503+ functions)
      • 🌍 Geospatial (2 functions)
      • ⚙️ Configuration Management (15 functions)
      • 📊 Analytics Integration (6 functions)
      • 🧹 Code Hygiene (2 functions)
      • 🧪 Testing & Development (2 functions)
    • Real-World Workflow Examples
    • Installation and Dependencies
    • Performance and Scalability
    • Next Steps
  • Installation Troubleshooting
    • System Dependencies for Geospatial
      • Ubuntu / Debian
      • macOS (Homebrew)
      • Windows
    • Choosing the Right Extras
    • Common Errors
  • Library Architecture
    • Overview
    • Core Architecture
    • Function Distribution
    • Key Features
    • Integration Points
    • Usage Patterns
  • Enhanced Auto-Discovery System
    • How It Works
    • The Five-Phase Discovery Process
    • Benefits
    • Monitoring Your Package
    • Adding New Functions

Core Utilities:

  • Core Utilities
    • Package Discovery
    • Functions
      • __init__()
    • Usage Examples
    • Unit Tests
  • String Utilities
    • Module Overview
    • Functions
    • Usage Examples
    • Unit Tests
  • Logging Utilities
    • Module Overview
    • Functions
    • Usage Examples
    • Unit Tests

Distributed Computing:

  • Distributed Computing
    • Module Overview
    • HDFS Configuration
    • Functions
    • Usage Examples
    • HDFS Operations
    • Functions
    • Usage Examples
    • Unit Tests
  • HDFS Operations
    • Module Overview
    • Functions
    • Usage Examples
    • Unit Tests
  • Spark Utilities
    • Module Overview
    • Functions by Category
      • Mathematical Functions
      • Array Functions
      • Aggregation Functions
      • Cryptographic Functions
    • Usage Examples
    • Unit Tests

File Operations:

  • File Operations
    • Module Overview
    • Functions
    • Usage Examples
    • Unit Tests
  • File Hashing
    • Module Overview
    • Functions
    • Usage Examples
    • Unit Tests
  • Remote Operations
    • Module Overview
    • Functions
    • Usage Examples
    • Unit Tests
  • Shell Operations
    • Module Overview
    • Functions
    • Usage Examples
    • Unit Tests

Geographic & Analytics:

  • Geographic Utilities
    • Geocoding
      • Module Overview
      • Functions
      • Usage Examples
      • Unit Tests
    • Enhanced Census Utilities and Spatial Data
      • Census Directory Discovery
      • Census Data Source
        • State Information Methods
      • Spatial Data Source
      • Government Data Source
      • OpenStreetMap Data Source
      • Convenience Functions
      • Global Instances
        • census_source
        • government_source
        • osm_source
      • Usage Examples
        • Basic Census Data Access
        • State Information Lookup
        • Dynamic Discovery
        • Error Handling
        • Performance Optimization
        • Integration with Other Tools
    • Census Dataset Mapper
      • Classes
        • CensusDatasetMapper
        • CensusDataset
        • DatasetRelationship
      • Enums
        • SurveyType
        • GeographyLevel
        • DataReliability
      • Functions
        • get_census_dataset_mapper
        • get_best_dataset_for_analysis
        • compare_census_datasets
      • Usage Examples
        • Basic Dataset Information
        • Dataset Comparison
        • Data Selection Guide
        • Export Dataset Catalog
    • Census Data Selector
      • Classes
        • CensusDataSelector
      • Functions
        • get_census_data_selector
        • select_census_datasets
        • get_analysis_approach
      • Usage Examples
        • Basic Dataset Selection
        • Analysis Approach Recommendations
        • Compatibility Matrix
        • Quick Selection
      • Advanced Usage
        • Custom Reliability Requirements
        • Time-Sensitive Analysis
        • Variable-Specific Selection
      • Analysis Types Supported
      • Geography Levels Supported
      • Reliability Levels
      • Output Format
    • Tiered Installation
    • Isochrones and CRS
    • Overview
    • Key Features
      • Census Data Intelligence
      • Enhanced Census Utilities
      • Spatial Data Processing
      • Geocoding Services
    • Installation
    • Quick Start
    • Analysis Types Supported
    • Geography Levels Supported
    • Census Survey Types
    • Data Quality and Reliability
    • Best Practices
    • Examples
  • Google Workspace Write APIs
    • Installation
    • Authentication
      • 1Password Integration (Recommended)
      • Direct Authentication
    • Google Sheets
    • Google Slides
    • Google Docs
    • Drive Utilities
    • Multi-Account Management
    • Notebook
    • API Reference
  • Analytics
    • Module Overview
    • Facebook Business Analytics
    • Functions
    • Usage Examples
    • Google Analytics
    • Functions
    • Usage Examples
    • Unit Tests
  • Mapping and Reporting System
    • Overview
    • Key Features
    • Installation
    • Quick Start
      • Basic Bivariate Choropleth Map
      • Marker Map with Geographic Data
      • 3D Elevation Visualization
    • Comprehensive Report Generation
      • Creating Professional PDF Reports
      • PowerPoint Presentation Creation
    • Map Types Reference
      • Bivariate Choropleth Maps
      • Marker Maps
      • 3D Maps
      • Heatmap Maps
      • Cluster Maps
      • Flow Maps
      • Advanced Choropleth Maps
    • Report Structure
      • PDF Report Components
      • PowerPoint Structure
      • Section Types
    • Integration Examples
      • Google Analytics Integration
      • Database Integration
      • Custom API Integration
    • Best Practices
      • Data Preparation
      • Map Design
      • Report Organization
      • Performance Optimization
    • Troubleshooting
      • Common Issues
      • Performance Issues
      • Error Handling
    • Examples and Recipes
    • Additional Resources

Notebooks & Examples:

  • Jupyter Notebooks
    • Configuration & Profiles
    • Geospatial & Census
    • Political & Redistricting
    • Data Engines
    • Reporting
    • Analytics & Integrations
    • Data & Development
    • Dependency Groups

Development & Testing:

  • Contributor Governance
  • Coding Style
  • PR Review Rubric
  • Lint Ratchet Plan
  • Change Classification and Release Policy
  • Repository Hygiene
    • Policy goals
    • Tracked vs ignored artifacts
    • Special exception: notebooks output
    • Scripts policy
  • CodeRabbit Workflow
    • Required status
    • Review focus
    • Merge readiness
  • License Model
  • 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
Siege Utilities
  • Search

© Copyright 2025-2026, Dheeraj Chand.

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