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
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

/*!

Library to represent an atmospheric sounding with pressure as the vertical coordinate.
The base crate is meant to be a common base for other crates to build on. These crates may be for 
managing a data-store, displaying data, or saving and loading files.

The emphasis of this crate is data representation and a common type for systems using sounding
data to build on and use.

# Examples
```
extern crate chrono;
extern crate sounding_base;
extern crate optional;

use optional::{Optioned, some};

use sounding_base::{Sounding, StationInfo, Profile, Surface};

fn main() {

    // Create  pressure profile
    let pressure_profile: Vec<Optioned<f64>> = 
        vec![1000.0, 925.0, 850.0, 700.0, 500.0, 300.0, 250.0, 100.0]
            .iter()
            .map(|p| some(*p))
            .collect();

    // Create a temperature profile
    let temperature_profile: Vec<Optioned<f64>> = 
        vec![13.0, 7.0, 5.0, -4.5, -20.6, -44.0, -52.0, -56.5]
            .iter()
            .map(|t| some(*t))
            .collect();

    // Create some station info
    let stn = StationInfo::new_with_values(None, (45.6789, -115.6789), 992.0);

    // Create a valid time. This uses a `chrono::NaiveDateTime`, and you should always assume 
    // that valid times are in UTC.
    let vt = chrono::NaiveDate::from_ymd(2018,3,8).and_hms(12,0,0);

    // Use the builder pattern to construct a sounding.
    let snd = Sounding::new()
        .set_station_info(stn)
        .set_valid_time(vt)
        .set_lead_time(24)  // Lead time in hours for forecast soundings.
        .set_profile(Profile::Pressure, pressure_profile)
        .set_profile(Profile::Temperature, temperature_profile)
        // Surface values don't have to be `Optioned`
        .set_surface_value(Surface::StationPressure, 1013.25)
        // But they can be
        .set_surface_value(Surface::Temperature, some(15.0)); 

    // Top down and bottom up iterators are provided. If surface data is available, it is 
    // inserted into the profile.
    let mut iter = snd.top_down();

    let mut data_row = iter.next().unwrap();
    assert_eq!(data_row.pressure, some(100.0));
    assert_eq!(data_row.temperature, some(-56.5));

    data_row = iter.next().unwrap();
    assert_eq!(data_row.pressure, some(250.0));
    assert_eq!(data_row.temperature, some(-52.0));

    data_row = iter.next().unwrap();
    assert_eq!(data_row.pressure, some(300.0));
    assert_eq!(data_row.temperature, some(-44.0));

    data_row = iter.next().unwrap();
    assert_eq!(data_row.pressure, some(500.0));
    assert_eq!(data_row.temperature, some(-20.6));

    data_row = iter.next().unwrap();
    assert_eq!(data_row.pressure, some(700.0));
    assert_eq!(data_row.temperature, some(-4.5));

    data_row = iter.next().unwrap();
    assert_eq!(data_row.pressure, some(850.0));
    assert_eq!(data_row.temperature, some(5.0));

    data_row = iter.next().unwrap();
    assert_eq!(data_row.pressure, some(925.0));
    assert_eq!(data_row.temperature, some(7.0));

    data_row = iter.next().unwrap();
    assert_eq!(data_row.pressure, some(1000.0));
    assert_eq!(data_row.temperature, some(13.0));

    // THIS ONE IS THE SURFACE DATA!
    data_row = iter.next().unwrap();
    assert_eq!(data_row.pressure, some(1013.25));
    assert_eq!(data_row.temperature, some(15.0));

    assert_eq!(iter.next(), None);

    // Profiles and surface values can also be accessed via getter methods. Read the docs!
}
```

You probably noticed a lot of `optional::Optioned`s in the example. Basically, anything can be 
missing, and missing values are common in upper air soundings. For example, at high altitude the 
dew point or humidity are often missing (if not totally inaccurate).

*/
#![deny(missing_docs)]

//
// API
//
pub use data_row::DataRow;
pub use enums::{Profile, Surface};
pub use sounding::Sounding;
pub use station_info::StationInfo;

//
// Internal use only
//

extern crate chrono;
extern crate optional;
extern crate smallvec;

extern crate metfor;

mod data_row;
mod enums;
mod sounding;
mod station_info;

#[doc(hidden)]
pub use sounding::doctest;