swxsoc_reach

A Python package to process and analyze data from the REACH dosimeters.

Table of Contents:

• Overview
  • Documentation
  • Acknowledgements
  • Authors
  • Project Lead
  • Development Lead
  • Contributors
  • Citing
  • CHANGELOG
  • Latest changes
• User’s Guide
  • Overview
  • Logging system
    • Overview
  • Customization and Global Configuration
    • The config.yml file
    • Using your own config.yml file
    • Customizing the Mission Configuration
    • Reconfiguring for Testing
  • Historical UDL Download CLI
    • Quick start
    • Resolving UDL credentials
    • Required arguments
    • Common options
    • AIMD rate-controller flags
    • Restart and resume semantics
    • Telemetry CSV schema
    • Exit codes
    • Running via Docker
    • Operator runbook: interrupted runs
  • Historical CSV → CDF Processing CLI
    • Quick start
    • CLI reference
      • Required arguments
      • Optional arguments
      • S3 upload arguments
    • Optional dependencies
    • Status lifecycle
    • Telemetry schema
    • Restart semantics
    • Operator runbook
    • Notes & caveats
• Developer’s Guide
  • Developer Environment
    • Conda Environment
    • Visual Studio Code
      • Setup
  • Coding Standards
    • Language Standard
    • Coding Style/Conventions
    • Private code
    • Documentation and Testing
    • Data and Configuration
    • Standard output and errors
    • Logging and all other messages
    • Including C Code
  • Testing Guidelines
    • Writing tests
      • Where to put tests
      • doctests
      • Bugs Testing
  • Documentation Rules
    • Overview
      • Referring to other code
      • Project-specific Rules
    • Sphinx
      • Usage and Building the documentation
        • HTML
        • Rebuilding from scratch
  • Workflow for Maintainers
    • Integrating changes via the web interface (recommended)
      • When to remove or combine/squash commits
      • When to rebase
      • A few commits
      • A long series of commits
      • Check the history
      • Push to open pull request
    • Issue Milestones and Labels
    • Updating and Maintaining the Changelog
    • Releases
• API Reference
  • swxsoc_reach
  • swxsoc_reach.calibration.calibration
    • process_file()
  • swxsoc_reach.calibration.transform
    • build_swxdata()
    • create_observation_array()
    • create_sensor_array()
    • deduplicate_records()
    • extract_sensor_metadata()
  • swxsoc_reach.historical.download_orchestrator
    • DownloadRunConfig
      • DownloadRunConfig.additive_increase
      • DownloadRunConfig.auth_token
      • DownloadRunConfig.descriptor
      • DownloadRunConfig.dry_run
      • DownloadRunConfig.end_date
      • DownloadRunConfig.initial_rate
      • DownloadRunConfig.limit_days
      • DownloadRunConfig.max_concurrent_requests
      • DownloadRunConfig.max_rate
      • DownloadRunConfig.min_rate
      • DownloadRunConfig.multiplicative_decrease
      • DownloadRunConfig.output_dir
      • DownloadRunConfig.output_format
      • DownloadRunConfig.retry_failed
      • DownloadRunConfig.sensor_id
      • DownloadRunConfig.start_date
      • DownloadRunConfig.telemetry_path
    • DownloadRunSummary
      • DownloadRunSummary.days_attempted
      • DownloadRunSummary.days_downloaded
      • DownloadRunSummary.days_failed
      • DownloadRunSummary.days_planned
      • DownloadRunSummary.days_skipped_existing
      • DownloadRunSummary.days_skipped_no_data
      • DownloadRunSummary.run_id
    • _count_records()
    • _day_window()
    • _decide_action()
    • _expected_records()
    • run_download()
  • swxsoc_reach.historical.process_orchestrator
    • ProcessRunConfig
      • ProcessRunConfig.descriptor
      • ProcessRunConfig.dry_run
      • ProcessRunConfig.end_date
      • ProcessRunConfig.input_dir
      • ProcessRunConfig.limit_days
      • ProcessRunConfig.output_dir
      • ProcessRunConfig.output_format
      • ProcessRunConfig.retry_failed
      • ProcessRunConfig.s3_bucket
      • ProcessRunConfig.sensor_id
      • ProcessRunConfig.start_date
      • ProcessRunConfig.telemetry_path
      • ProcessRunConfig.upload_to_s3
    • ProcessRunSummary
      • ProcessRunSummary.days_attempted
      • ProcessRunSummary.days_failed
      • ProcessRunSummary.days_planned
      • ProcessRunSummary.days_processed
      • ProcessRunSummary.days_skipped_existing
      • ProcessRunSummary.days_skipped_no_input
      • ProcessRunSummary.days_uploaded
      • ProcessRunSummary.run_id
    • _carry_forward()
    • _decide_process_action()
    • _match_csv_for_date()
    • _process_one_day()
    • _relocate_to_nested_layout()
    • run_process()
  • swxsoc_reach.historical.s3_upload
    • upload_cdf_to_s3()
  • swxsoc_reach.historical.telemetry
    • HistoricalTelemetry
      • HistoricalTelemetry.append_row()
      • HistoricalTelemetry.iter_rows()
      • HistoricalTelemetry.load_state()
    • TelemetryRow
      • TelemetryRow.availability_pct
      • TelemetryRow.cdf_path
      • TelemetryRow.cdf_size_mb
      • TelemetryRow.chunk_date_utc
      • TelemetryRow.csv_path
      • TelemetryRow.csv_size_mb
      • TelemetryRow.descriptor
      • TelemetryRow.download_seconds
      • TelemetryRow.error_message
      • TelemetryRow.error_type
      • TelemetryRow.expected_records
      • TelemetryRow.finished_at_utc
      • TelemetryRow.from_dict()
      • TelemetryRow.output_format
      • TelemetryRow.process_seconds
      • TelemetryRow.records_downloaded
      • TelemetryRow.run_id
      • TelemetryRow.s3_bucket
      • TelemetryRow.s3_key
      • TelemetryRow.sensor_id
      • TelemetryRow.started_at_utc
      • TelemetryRow.status
      • TelemetryRow.to_dict()
      • TelemetryRow.upload_seconds
      • TelemetryRow.window_end_utc
      • TelemetryRow.window_start_utc
    • utcnow_iso()
  • swxsoc_reach.io.aws_db
    • record_housekeeping()
  • swxsoc_reach.io.file_tools
    • read_file()
    • read_udl_csv()
    • read_udl_json()
  • swxsoc_reach.net.auth
    • resolve_udl_auth()
  • swxsoc_reach.net.udl
    • AdaptiveRateController
      • AdaptiveRateController.acquire()
      • AdaptiveRateController.record_rate_limit()
      • AdaptiveRateController.record_success()
    • _concatenate_chunk_files()
    • _fetch_and_spool_chunk()
    • _write_chunk_file()
    • build_reach_output_filename()
    • download_UDL_reach_to_file()
    • download_UDL_reach_window()
    • fetch_reach_chunk()
    • format_udl_timestamp()
    • get_reach_datetimelist()
    • get_reach_urllist()
    • write_reach_output()
  • swxsoc_reach.util.schema
    • REACHDataSchema
      • REACHDataSchema._get_logical_file_id()
      • REACHDataSchema._get_logical_source()
      • REACHDataSchema._get_reach_version()
  • swxsoc_reach.util.util
    • create_reach_filename()
    • parse_science_filename()