v1.2.0

• Previous function deprecation warnings are now breaking changes
  • This is primarily argument order & optional argument naming
  • Check the relevant docstring for the updated function call information
• Added 2021 SGL flight data artifact, DataFrames, & readmes
• Updated all maps structs with info & mask fields
• Updated all flight data structs with info fields
• Updated XYZ0 struct with year, doy, diurnal, & igrf fields
• Updated XYZ20 & XYZ21 structs with aux_1, aux_2, & aux_3 fields (NaN default)
  • This is useful to store custom data
• Updated NNCompParams struct with loss function field
• Updated NNCompParams & NNCompParams structs with VersionNumber type version field
• Changed map interpolations to use f(lat, lon, alt) instead of f(lon, lat, alt)
• Refactored krr() into krr_fit() & krr_test()
• Updated plot_correlation() & plot_correlation_matrix() for reduced time to plot
• Added TempParams struct to hold WIP NN-based aeromagnetic compensation parameters
• Updated docstrings & unit tests for full code coverage

Full Changelog: v1.1.7...v1.2.0

v1.1.7

• Added artifact download information to readme
• Updated compat & tested on Julia v1.10

Full Changelog: v1.1.6...v1.1.7

v1.1.6

• Changed previously breaking changes to deprecation warnings (until v1.2.0)
• Added all Pluto examples to docs
• Added jupyter_end-to-end_ML.ipynb example
• Added CSV functionality to get_XYZ0(), get_XYZ1(), get_traj(), get_ins(), & get_flux()
• Added unit tests for new functionality in this & previous release

Full Changelog: v1.1.5...v1.1.6

v1.1.5

• Breaking change: made comp_params argument first & required in comp_train(), comp_test(), comp_m2bc_test(), comp_m3_test(), & comp_train_test()
• Updated example Pluto notebook pluto_maps.jl with 3D maps
• Updated docstrings with more details about DataFrames
• Added plot_correlation_matrix(), works with 2-5 features currently
• Added unit tests for models :m3w & :m3tf

Full Changelog: v1.1.4...v1.1.5

v1.1.4

• Minor breaking changes:
  • Renamed optional argument l_seq to l_window in get_x(), get_y(), get_Axy(), get_ind(), & nekf_train() for consistency with new temporal functions
  • Reordered list of arguments in gif_animation_m3()
• Added 2 new models, :m3w & :m3tf, both are WIP & subject to change
• Added 2 examples on linear models & feature selection
• Added more comments & details to examples
• Updated docstrings with details on expected argument dimensions
• Updated test files to correspond with src files

Full Changelog: v1.1.3...v1.1.4

v1.1.3

• Added MapS3D, Map_Cache, & EKF_RT structs to docs
• Renamed examples with jupyter_ & pluto_ instead of example_ prefixes for clarity
• Added Pluto notebook examples to Docker image
• Changed Docker image to use jupyter/julia-notebook instead of jupyter/minimal-notebook
• Implemented get_map_val() in examples where possible
• Improved use of silent optional argument in compensation & other functions
• Added get_TL_term_ind() to find indices that correspond to term in TL_coef
• Added return_vert_deriv capability to map_interpolate() for MapS3D
• Changed map_interpolate() to return an actual Function using map_itp_function()
• Made compensation reproducibility unit tests work with Julia v1.6, v1.7, v1.8, & v1.9
• Added missing unit tests for near complete code coverage

Full Changelog: v1.1.2...v1.1.3

v1.1.2

• Added Julia installation & usage information to readme
• Updated the Docker image to be public, use Julia v1.9.3, & only install required packages & files
• Updated example_sgl.jl & example_sim.jl to be Pluto notebooks
• Switched from UTMZ to UTM internally, allowing for map processing across multiple UTM zones
• Added optional argument file_units to get_map() & save_map() to clarify difference from map_units
• Implemented MapS3D in all relevant map functions with default of map at lowest altitude
• Added plot_map!() & plot_map() for MapV
• Added unit tests, especially for compensation reproducibility

Full Changelog: v1.1.1...v1.1.2

v1.1.1

• Added ottawa_area_maps_gxf artifact for an example usage of GXF map data extraction
• Updated ottawa_area_maps artifact with map files containing border & mask fields
• Changed required artifacts (EMM720_World, NAMAD_305, sgl_fields, & util_files) to not load lazily
• Added Pluto notebook examples example_maps.jl & example_model3.jl
• Added optional arguments map_mask & map_border to save_map()
• Implemented padding limit in upward_fft() for large upward continuation distances
• Implemented map_trim() in the small map version of map_get_gxf()
• Added missing unit tests for near complete code coverage

Full Changelog: v1.1.0...v1.1.1

v1.1.0

• Minor breaking changes: renamed optional argument file_name to plot_png in plot_activation(), plot_mag(), plot_mag_c(), plot_PSD(), plot_spectrogram(), & plot_frequency() for consistency with other file name arguments
• New structs:
  • MapS3D & functions upward_fft(mapS::MapS) to create MapS3D from MapS & (mapS3D::MapS3D)() to extract MapS from MapS3D
  • Map_Cache & functions get_cached_map(map_cache::Map_Cache) & (map_cache::Map_Cache)() to extract a cached map interpolation function
  • Implemented MapS3D & Map_Cache in navigation & plotting functions
  • EKF_RT & function (ekf_rt::EKF_RT)() for a real-time (RT) extended Kalman filter (EKF)
• New functions:
  • add_extension() & remove_extension() to add & remove file extensions as appropriate within functions
  • downsample() to downsample data, particularly for plotting maps
  • expand_range() to expand a unit range of data, particularly for expanding maps
  • filter_events!() & filter_events() to filter in-flight events by time & keyword
  • gif_animation_m3() to generate a GIF of compensation & navigation performance
  • get_autocor() to extract autocorrelation parameters directly
  • get_comp_params() & save_comp_params() to load & save compensation parameters more reliably from version to version of MagNav.jl
  • get_map_val() to retrieve map values & optionally a map interpolation function
  • get_step() to get the step size of a unit range of data
  • map_border() & support functions to create a map border
  • map_combine() & support functions to combine multiple maps, either at the same altitude (i.e., fallback map for outside primary map border) or stacked maps at multiple altitudes
  • nn_comp_1_fwd(), nn_comp_2_fwd(), nn_comp_3_fwd(), & linear_fwd() to evaluate the compensation models in forward mode only, simplifying the compensation functions internals
• Implemented LBFGS in nn_comp_3_train()
• Updated internal file name arguments
• Updated many docstrings
• Added unit tests for new functionality

Full Changelog: v1.0.4...v1.1.0

v1.0.4

• Minor bugfixes in docs, example_sim.jl, & map_check()

Full Changelog: v1.0.3...v1.0.4