nexrad-data 1.0.0-rc.7

Data access for NEXRAD weather radar files and AWS integration.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

//!
//! # Real-time NEXRAD Data
//! Near real-time (within seconds) NEXRAD radar data is uploaded to an AWS S3 bucket by NOAA. This
//! data is organized into a series of "volumes", each containing ~55 "chunks". This module provides
//! functions for identifying the most recent volume with data for a specified radar site and
//! downloading the chunks within that volume.
//!
//! A fixed number (999) volumes exist in the S3 bucket which are rotated through in a round-robin
//! fashion. Chunks are added to each volume approximately every 4-12 seconds with little latency
//! from the data's collection time (usually approximately 15 seconds from collection time).
//!
//! There may be gaps in the volume data, as illustrated in the real example below from KDMX:
//! ```text
//! Volume 001: 2024-08-04 10:10:07 UTC
//! ...
//! Volume 085: 2024-08-04 17:10:49 UTC
//! Volume 086: No files found.
//! ...
//! Volume 670: No files found.
//! Volume 671: 2024-08-03 00:00:21 UTC
//! ...
//! Volume 999: 2024-08-04 10:06:37 UTC
//! ```
//! The [get_latest_volume()] function will find the volume with the most recent data using a binary
//! search approach to minimize the number of network calls made. Once the latest volume is found
//! for a session, a different routine should be used to poll new data for that volume and advance
//! to the next volume when the active one is filled.
//!

mod volume_index;
pub use volume_index::*;

mod chunk;
pub use chunk::*;

mod chunk_type;
pub use chunk_type::*;

mod chunk_identifier;
pub use chunk_identifier::*;

mod download_chunk;
pub use download_chunk::*;

mod get_latest_volume;
pub use get_latest_volume::*;

mod list_chunks_in_volume;
pub use list_chunks_in_volume::*;

mod estimate_next_chunk_time;
pub use estimate_next_chunk_time::*;

mod chunk_timing_model;
pub use chunk_timing_model::*;

mod chunk_timing_stats;
pub use chunk_timing_stats::*;

mod elevation_chunk_mapper;
pub use elevation_chunk_mapper::*;

mod scan_timing_projection;
pub use scan_timing_projection::*;

mod retry_policy;
pub use retry_policy::*;

mod chunk_iterator;
pub use chunk_iterator::*;

// Polling functionality requires tokio
#[cfg(all(feature = "aws-polling", not(target_arch = "wasm32")))]
mod poll_chunks;
#[cfg(all(feature = "aws-polling", not(target_arch = "wasm32")))]
pub use poll_chunks::*;

#[cfg(feature = "nexrad-model")]
mod assemble;
#[cfg(feature = "nexrad-model")]
pub use assemble::*;

mod search;

const REALTIME_BUCKET: &str = "unidata-nexrad-level2-chunks";