netcdf3 0.6.1

A pure Rust library for reading and writing NetCDF-3 files
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

//! # Description
//!
//! A pure Rust library for reading and writing NetCDF-3 files.
//!
//! # Examples
//!
//! - Define the NetCDF-3 using the struct [`Dataset`](struct.DataSet.html) :
//!     - Define (create, get, rename and remove) global atributes (examples [here](struct.Attribute.html#global-attributes));
//!     - Define (create, get, rename and remove) dimensions (examples [here](struct.Dimension.html#examples));
//!     - Define (create, get, rename and remove) variables (examples [here](struct.Variables.html#examples));
//!     - Define (create, get, rename and remove) variable attributes (examples [here](struct.Attribute.html#variable-attributes));
//! - Read the NetCDF-3 files using the struct [`FileReader`](struct.FileReader.html).
//! - Write the NetCDF-3 files using the struct [`FileWriter`](struct.FileWriter.html).
//!
//! # Notes
//!
//! - If the number of records `numrecs` is greater than `std::i32::MAX` then this value is considered as indeterminate and the actually written value is `numrecs = 2^32 - 1`(see the [File Format Specifications][File_Format_Specs]).
//! - If the chunk size of a given variable `vsize` is greater the `std::i32::MAX` then its value is considered as indeterminate and the actually written value is `vsize = 2^32 - 1` (see the [File Format Specifications][File_Format_Specs]).
//! - To validate the implementation of the NetCDF-3 files writing, binary comparisons between the crate outcomes and files produced by the Python library [netCDF4](https://github.com/Unidata/netcdf4-python) are done while the test suite (see the Python script `pyscripts/create_test_nc3_files.py` and the Rust test file `tests/tests_write_nc3_files.rs`).
//!
//! ## Known limitations
//!
//! - Cannot read/write a subset of a variable data yet.
//! - Cannot rewrite a NetCDF-3 file.
//!
//! [File_Format_Specs]: https://www.unidata.ucar.edu/software/netcdf/docs/file_format_specifications.html
pub mod error;
pub use error::{InvalidDataSet, ReadError, WriteError};

mod name_string;
pub use name_string::is_valid_name;
pub use name_string::NC_MAX_NAME_SIZE;

mod data_type;
pub use data_type::DataType;

mod data_vector;
pub use data_vector::DataVector;

mod data_set;
pub use data_set::NC_FILL_F32;
pub use data_set::NC_FILL_F64;
pub use data_set::NC_FILL_I16;
pub use data_set::NC_FILL_I32;
pub use data_set::NC_FILL_I8;
pub use data_set::NC_FILL_U8;
pub use data_set::NC_MAX_DIM_SIZE;
pub use data_set::NC_MAX_VAR_DIMS;
pub use data_set::{Attribute, DataSet, Dimension, DimensionType, Variable};

mod io;
pub use io::{FileReader, FileWriter};

mod version;
pub use version::Version;