Skip to content

Commit cce1bfe

Browse files
castelaocastelao
authored
Validation dataset (#15)
* feat: New package to handle validation dataset * feat: Some values for development Hardcoded values for SA, CT, p, and specvol for development purposes only. * wip: Concept for postcard with validation data * feat: Moving to heapless objects This allows using postcard with no_std. Still a WIP. * feat: Vectorizing with postcard Still need to think about the 2D arrays * feat: Saving serialized dataset in a file * feat: DataRef structure * feat: Saving 1D and 2D variables This will be important to run some tests. * test: Testing specvol with validation data Proof of concept. * refactor: Renaming crate to gsw-validation This is intended to be an internal crate for support only, but just in case to avoid any confusion. The name validation was too generic, while gsw-validation should be clear enough. * fix: Missing dependencies for gsw-validation * fix: Missing dependencies for tests heapless & postcard * feat: Validation data from MatLab. Check values only. * refactor: Using chunks instead of hardcoded slices * Renaming support package validation -> convert_refdata * test: Validating more volume functions Just to create more cases before generalizing it. * feat: Extending more variables on reference values * refactoring: exact volume formulae moved to its own module * feat: Extending more variables on reference values * refactor: Easier to read constants * feat: Allowing more variables and longer varnames on validation data * test: Validating sound_speed() * fix: Typo on Luiz' email * doc: Explicit crate description * feat: volume::sound_speed() * feat: Upgrade to 0.0.3 * doc: Sound speed 75-term approximation * doc: Improving style of volume mod documentation * doc: Improving specvol title * doc: Improving module title * feat: Adding sigma[0|1|2|3|4]() Missing documentation and validation. * doc: title for sigma[0|1|2|3|4]() * refactor: Removing incomplete reference dataset * feat: Extending validation dataset with more variables * fix: Documentation syntax * feat: non_dimensional_pressure() to scale pressure It also handles the compatibility feature. * feat: non_dimensional_salinity() to scale salinity It also handles the compatibility feature. * refactor: Renaming support functions * feat: Changing license to Apache-2.0 or MIT * fix: Windows can't handle validation dataset in the stack * doc: Adding at least functions' titles * feat: Adding keywords to Crate's definition
1 parent edfb454 commit cce1bfe

11 files changed

Lines changed: 735 additions & 110 deletions

File tree

‎Cargo.toml‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,28 @@
11
[package]
22
name = "gsw"
3-
version = "0.0.2"
4-
authors = ["Guilherme Castelão <guilherme@castelao.net>", "Luiz Irber <luiz.irber@gmail.com >"]
3+
version = "0.0.3"
4+
authors = ["Guilherme Castelão <guilherme@castelao.net>", "Luiz Irber <luiz.irber@gmail.com>"]
55
edition = "2018"
6-
license = "BSD-3-Clause"
7-
description = "TEOS-10 v3.06.12 GSW Oceanographic Toolbox in Rust"
6+
license = "MIT OR Apache-2.0"
7+
description = "TEOS-10 v3.06.12 Gibbs Seawater Oceanographic Toolbox in Rust"
88
repository = "https://github.com/castelao/GSW-rs"
9+
keywords = ["oceanography", "seawater"]
910

1011
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
1112

1213
[workspace]
14+
members = ["convert_refdata"]
1315

1416
[dependencies]
1517
libm = "0.2.1"
1618
libc = { version = "0.2", optional = true }
1719
thiserror = { version = "1.0.24", optional = true }
1820

1921
[dev-dependencies]
22+
heapless = "0.7"
2023
inline-c = "0.1"
24+
postcard = "0.7.0"
25+
serde = "1.0.126"
2126

2227
[build-dependencies]
2328
cbindgen = { version = "0.18.0", optional = true }

‎LICENSE-APACHE‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2021 Guilherme Castelão and Luiz Irber
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.
202+

‎LICENSE-MIT‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
MIT License
2+
3+
Copyright (c) 2021 Guilherme Castelão and Luiz Irber
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.
22+

‎README.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,20 @@ GSW for microcontrollers.
55
## Minimum supported Rust version
66

77
Currently the minimum supported Rust version is 1.46.0
8+
9+
## License
10+
11+
Licensed under either of
12+
13+
* Apache License, Version 2.0
14+
([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
15+
* MIT license
16+
([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
17+
18+
at your option.
19+
20+
## Contribution
21+
22+
Unless you explicitly state otherwise, any contribution intentionally submitted
23+
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
24+
dual licensed as above, without any additional terms or conditions.

‎convert_refdata/Cargo.toml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
[package]
2+
name = "gsw-refdata"
3+
version = "0.0.1"
4+
authors = ["Guilherme Castelão <guilherme@castelao.net>", "Luiz Irber <luiz.irber@gmail.com >"]
5+
edition = "2018"
6+
license = "BSD-3-Clause"
7+
description = "Validation dataset for TEOS-10 v3.06.12 GSW Oceanographic Toolbox. Intended to be an internal auxiliary package."
8+
9+
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
10+
11+
[dependencies]
12+
heapless = "0.7"
13+
matfile = { version = "0.3", features = ["ndarray"] }
14+
ndarray = "0.15"
15+
postcard = "0.7.0"
16+
serde = "1.0.126"

‎convert_refdata/src/main.rs‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
// use core::ops::Deref;
2+
use heapless::{FnvIndexMap, String, Vec};
3+
use postcard::{from_bytes, to_vec};
4+
use serde::{Deserialize, Serialize};
5+
use std::fs::File;
6+
use std::io::{BufWriter, Write};
7+
use std::ops::Deref;
8+
9+
// Structure of the validation dataset
10+
#[derive(Serialize, Deserialize, Debug)]
11+
struct DataRef {
12+
version: String<8>,
13+
src: String<32>,
14+
src_md5: String<32>,
15+
data_x: FnvIndexMap<String<24>, Vec<f64, 3>, 4>,
16+
data2d: FnvIndexMap<String<24>, Vec<Vec<f64, 45>, 3>, 64>,
17+
}
18+
19+
fn main() {
20+
let file = std::fs::File::open("data/gsw_data_v3_0.chck_cast.mat").unwrap();
21+
let mat_file = matfile::MatFile::parse(file).unwrap();
22+
23+
let mut data_x = FnvIndexMap::<heapless::String<24>, _, 4>::new();
24+
let mut data2d = FnvIndexMap::<heapless::String<24>, _, 64>::new();
25+
26+
for variable in mat_file.arrays() {
27+
// dbg!(variable.name());
28+
// dbg!(variable.size());
29+
if let Some(array) = mat_file.find_by_name(variable.name()) {
30+
if let matfile::NumericData::Double { real, imag: _ } = array.data() {
31+
let varname: String<24> = String::from(variable.name());
32+
match array.size()[..] {
33+
[1, 3] => {
34+
// dbg!(array.name());
35+
let values: Vec<f64, 3> = Vec::from_slice(&real).unwrap();
36+
data_x.insert(varname, values).unwrap();
37+
}
38+
[45, 3] => {
39+
// dbg!(array.name());
40+
let values: Vec<_, 3> = real
41+
.chunks(45)
42+
.map(|x| Vec::<f64, 45>::from_slice(x).unwrap())
43+
.collect();
44+
45+
data2d.insert(varname, values).unwrap();
46+
}
47+
_ => {
48+
dbg!("MISSING");
49+
dbg!(varname);
50+
()
51+
}
52+
};
53+
};
54+
}
55+
}
56+
57+
let dataset = DataRef {
58+
version: String::from("3.06.12"),
59+
src: String::from("gsw_data_v3_0.mat"),
60+
src_md5: String::from("f9b65955407a8ed00246de4871ef0505"),
61+
data_x,
62+
data2d,
63+
};
64+
65+
// dbg!("{:?}", &dataset);
66+
67+
let stream: Vec<u8, 100_000> = to_vec(&dataset).expect("Failed to vectorize dataset");
68+
69+
let f = File::create("gsw_validation.bin").expect("Unable to create file");
70+
let mut f = BufWriter::new(f);
71+
f.write_all(stream.deref()).expect("Unable to write data");
72+
}

0 commit comments

Comments
 (0)