Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Create validations for input data using pydantic #87

Closed
lsetiawan opened this issue Jul 20, 2023 · 3 comments
Closed

feat: Create validations for input data using pydantic #87

lsetiawan opened this issue Jul 20, 2023 · 3 comments

Comments

@lsetiawan
Copy link
Member

Overview

There's currently movement to standardize the dataset to a unified format for the input to various software. As starting point, the standard follows closely with the garpos package. So, I think it would be great to create a pydantic model to ensure compliance: https://github.com/s-watanabe-jhod/garpos#index-list-of-obscsv-data

@lsetiawan
Copy link
Member Author

Development for this need to wait until we're using pydantic v2 as mentioned in #85

@lsetiawan
Copy link
Member Author

lsetiawan commented Aug 14, 2023

Pasting this table for direct view of the model:

Index list of obs.csv data

No. Index Description
00 SET Names of subset in each observation (typically S01, S02,...)
01 LN Names of survey lines in each observation (typically L01, L02,...)
02 MT ID of mirror transponder (should be consistent with Site-parameter file)
03 TT Observed travel time
04 ResiTT Residuals of travel time (observed - calculated)
05 TakeOff Takeoff angle of ray path (in degrees, Zenith direction = 180 deg.)
06 gamma Correction term setting in the observation equations
07 flag True: data of this acoustic shot is not used as data
08 ST Transmission time of acoustic signal
09 ant_e0 GNSS antenna position (eastward) at ST
10 ant_n0 GNSS antenna position (northward) at ST
11 ant_u0 GNSS antenna position (upward) at ST
12 head0 Heading at ST (in degree)
13 pitch0 Pitch at ST (in degree)
14 roll0 Roll at ST (in degree)
15 RT Reception time of acoustic signal
16 ant_e1 GNSS antenna position (eastward) at RT
17 ant_n1 GNSS antenna position (northward) at RT
18 ant_u1 GNSS antenna position (upward) at RT
19 head1 Heading at RT (in degree)
20 pitch1 Pitch at RT (in degree)
21 roll1 Roll at RT (in degree)
22 dV0 Sound speed variation (for dV0)
23 gradV1e Sound speed variation (for east component of grad(V1))
24 gradV1n Sound speed variation (for north component of grad(V1))
25 gradV2e Sound speed variation (for east component of grad(V2))
26 gradV2n Sound speed variation (for north component of grad(V2))
27 dV Correction term transformed into sound speed variation (gamma x V0)
28 LogResidual Actual residuals in estimation (log(TT) - log(calculated TT)

@lsetiawan lsetiawan changed the title Create validations for input data using pydantic feat: Create validations for input data using pydantic Dec 21, 2023
@lsetiawan
Copy link
Member Author

Refer to data standardization WG document: https://hal.science/hal-04319233/document

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant