seafloor-geodesy / gnatss

Community Seafloor Global Navigation Satellite Systems - Acoustic (GNSS-A) Transponder Surveying Software
https://gnatss.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
9 stars 13 forks source link

refactor: A large refactor of codebase to ensure more modularity and clarity #242

Closed lsetiawan closed 2 months ago

lsetiawan commented 2 months ago

Overview

This PR performs a large refactoring overhaul of the codebase so that it's more modular and clear. The posfilter and solver processes are now it's own module consisting of a couple files: run.py, <process>.py, and utilities.py. This is now a pretty consistent pattern within the package to allow for clarity:

Additionally, The end to end pipeline is now contained within a function called run_gnatss rather than a generic main function within the main.py file. There are many updates here, but I've gone over that with @madhavmk. In PRs following this one, there will be more documentations, comments, and updated tests.

Related issues