refactor: adjust format of logfiles - #187
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR modernizes packaging by removing setup.py and defining console entry points in pyproject.toml, while also reorganizing legacy top-level scripts into importable gravity_toolkit.* modules and updating API docs to match the new module paths.
Changes:
- Remove
setup.pyand migrate script installation to[project.scripts]entry points inpyproject.toml. - Move/introduce multiple CLI utilities under
gravity_toolkit/scripts,gravity_toolkit/datasets, andgravity_toolkit/mapping. - Update Sphinx API reference headings/links to reflect
gravity_toolkit.*module paths.
Reviewed changes
Copilot reviewed 103 out of 159 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| setup.py | Removed legacy setuptools build script. |
| pyproject.toml | Adds console script entry points for packaged CLIs. |
| gravity_toolkit/utilities.py | Updates log file creation to include parent filename. |
| gravity_toolkit/init.py | Exposes datasets, mapping, scripts as package submodules. |
| gravity_toolkit/scripts/init.py | Package marker for script modules. |
| gravity_toolkit/mapping/init.py | Package marker for mapping modules. |
| gravity_toolkit/datasets/init.py | Package marker for dataset sync modules. |
| gravity_toolkit/scripts/run_grace_date.py | Adds wrapper CLI for GRACE date/month utilities. |
| gravity_toolkit/scripts/quick_mascon_regress.py | Adds CLI regression summary generator for mascon series. |
| gravity_toolkit/scripts/quick_mascon_plot.py | Adds CLI plotting utility for mascon time series. |
| gravity_toolkit/scripts/make_grace_index.py | Adds CLI to build GRACE L2 index files. |
| gravity_toolkit/scripts/geocenter_processing_centers.py | Adds geocenter comparison plotting script. |
| gravity_toolkit/scripts/geocenter_ocean_models.py | Adds ocean model comparison plotting script. |
| gravity_toolkit/scripts/geocenter_monte_carlo.py | Adds geocenter Monte Carlo plotting script. |
| gravity_toolkit/scripts/geocenter_compare_tellus.py | Adds comparison plotting vs JPL Tellus product. |
| gravity_toolkit/scripts/convert_harmonics.py | Adds/relocates CLI for spatial→harmonic conversion. |
| gravity_toolkit/scripts/calc_harmonic_resolution.py | Adds/relocates harmonic resolution calculator script. |
| gravity_toolkit/scripts/aod1b_oblateness.py | Adds/relocates AOD1B C20 processing script. |
| gravity_toolkit/scripts/aod1b_geocenter.py | Adds/relocates AOD1B degree-1 processing script. |
| gravity_toolkit/datasets/itsg_graz_grace_sync.py | Adds/relocates ITSG GRAZ GRACE sync utility. |
| gravity_toolkit/datasets/gfz_isdc_dealiasing_sync.py | Adds/relocates GFZ ISDC AOD sync utility. |
| gravity_toolkit/datasets/gfz_icgem_costg_ftp.py | Adds/relocates COST-G FTP sync utility. |
| gravity_toolkit/datasets/esa_costg_swarm_sync.py | Adds/relocates ESA Swarm sync utility. |
| doc/source/api_reference/API-Reference.rst | Reorganizes API reference toctrees (datasets/mapping/scripts). |
| doc/source/api_reference/utilities.rst | Updates module heading to gravity_toolkit.utilities. |
| doc/source/api_reference/units.rst | Updates module heading to gravity_toolkit.units. |
| doc/source/api_reference/tools.rst | Updates module heading to gravity_toolkit.tools. |
| doc/source/api_reference/time.rst | Updates module heading to gravity_toolkit.time. |
| doc/source/api_reference/spatial.rst | Updates module heading to gravity_toolkit.spatial. |
| doc/source/api_reference/legendre.rst | Updates module heading to gravity_toolkit.legendre. |
| doc/source/api_reference/legendre_polynomials.rst | Updates module heading to gravity_toolkit.legendre_polynomials. |
| doc/source/api_reference/harmonics.rst | Updates module heading to gravity_toolkit.harmonics. |
| doc/source/api_reference/harmonic_summation.rst | Updates module heading to gravity_toolkit.harmonic_summation. |
| doc/source/api_reference/harmonic_gradients.rst | Updates module heading to gravity_toolkit.harmonic_gradients. |
| doc/source/api_reference/grace_date.rst | Updates module heading to gravity_toolkit.grace_date. |
| doc/source/api_reference/grace_find_months.rst | Updates module heading to gravity_toolkit.grace_find_months. |
| doc/source/api_reference/grace_input_months.rst | Updates module heading to gravity_toolkit.grace_input_months. |
| doc/source/api_reference/grace_months_index.rst | Updates module heading to gravity_toolkit.grace_months_index. |
| doc/source/api_reference/geocenter.rst | Updates module heading to gravity_toolkit.geocenter. |
| doc/source/api_reference/gen_stokes.rst | Updates module heading to gravity_toolkit.gen_stokes. |
| doc/source/api_reference/gen_harmonics.rst | Updates module heading to gravity_toolkit.gen_harmonics. |
| doc/source/api_reference/gen_point_load.rst | Updates module heading to gravity_toolkit.gen_point_load. |
| doc/source/api_reference/gen_disc_load.rst | Updates module heading to gravity_toolkit.gen_disc_load. |
| doc/source/api_reference/gen_spherical_cap.rst | Updates module heading to gravity_toolkit.gen_spherical_cap. |
| doc/source/api_reference/gen_averaging_kernel.rst | Updates module heading to gravity_toolkit.gen_averaging_kernel. |
| doc/source/api_reference/gauss_weights.rst | Updates module heading to gravity_toolkit.gauss_weights. |
| doc/source/api_reference/fourier_legendre.rst | Updates module heading to gravity_toolkit.fourier_legendre. |
| doc/source/api_reference/destripe_harmonics.rst | Updates module heading to gravity_toolkit.destripe_harmonics. |
| doc/source/api_reference/degree_amplitude.rst | Updates module heading to gravity_toolkit.degree_amplitude. |
| doc/source/api_reference/ocean_stokes.rst | Updates module heading to gravity_toolkit.ocean_stokes. |
| doc/source/api_reference/mascons.rst | Updates module heading to gravity_toolkit.mascons. |
| doc/source/api_reference/sea_level_equation.rst | Updates module heading to gravity_toolkit.sea_level_equation. |
| doc/source/api_reference/read_GRACE_harmonics.rst | Updates module heading to gravity_toolkit.read_GRACE_harmonics. |
| doc/source/api_reference/read_gfc_harmonics.rst | Updates module heading to gravity_toolkit.read_gfc_harmonics. |
| doc/source/api_reference/read_GIA_model.rst | Updates module heading to gravity_toolkit.read_GIA_model. |
| doc/source/api_reference/read_love_numbers.rst | Updates module heading to gravity_toolkit.read_love_numbers. |
| doc/source/api_reference/read_SLR_harmonics.rst | Updates module heading to gravity_toolkit.read_SLR_harmonics. |
| doc/source/api_reference/clenshaw_summation.rst | Updates module heading to gravity_toolkit.clenshaw_summation. |
| doc/source/api_reference/associated_legendre.rst | Updates module heading to gravity_toolkit.associated_legendre. |
| doc/source/api_reference/time_series/amplitude.rst | Updates module heading to gravity_toolkit.time_series.amplitude. |
| doc/source/api_reference/time_series/fit.rst | Updates module heading to gravity_toolkit.time_series.fit. |
| doc/source/api_reference/time_series/lomb_scargle.rst | Updates module heading to gravity_toolkit.time_series.lomb_scargle. |
| doc/source/api_reference/time_series/piecewise.rst | Updates module heading to gravity_toolkit.time_series.piecewise. |
| doc/source/api_reference/time_series/regress.rst | Updates module heading to gravity_toolkit.time_series.regress. |
| doc/source/api_reference/time_series/savitzky_golay.rst | Updates module heading to gravity_toolkit.time_series.savitzky_golay. |
| doc/source/api_reference/time_series/smooth.rst | Updates module heading to gravity_toolkit.time_series.smooth. |
| doc/source/api_reference/SLR/C20.rst | Updates module heading to gravity_toolkit.SLR.C20. |
| doc/source/api_reference/SLR/C30.rst | Updates module heading to gravity_toolkit.SLR.C30. |
| doc/source/api_reference/SLR/C40.rst | Updates module heading to gravity_toolkit.SLR.C40. |
| doc/source/api_reference/SLR/C50.rst | Updates module heading to gravity_toolkit.SLR.C50. |
| doc/source/api_reference/SLR/CS2.rst | Updates module heading to gravity_toolkit.SLR.CS2. |
| doc/source/api_reference/scripts/index.rst | New scripts API reference index. |
| doc/source/api_reference/mapping/index.rst | New mapping API reference index. |
| doc/source/api_reference/datasets/index.rst | New datasets API reference index. |
| doc/source/api_reference/scripts/aod1b_geocenter.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/scripts/aod1b_oblateness.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/scripts/calc_degree_one.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/scripts/calc_harmonic_resolution.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/scripts/calc_mascon.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/scripts/calc_sensitivity_kernel.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/scripts/combine_harmonics.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/scripts/convert_harmonics.rst | Switches argparse docs to :module:. |
| doc/source/api_reference/scripts/dealiasing_global_uplift.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/scripts/dealiasing_monthly_mean.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/scripts/grace_mean_harmonics.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/scripts/grace_raster_grids.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/scripts/grace_spatial_error.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/scripts/grace_spatial_maps.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/scripts/make_grace_index.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/scripts/mascon_reconstruct.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/scripts/monte_carlo_degree_one.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/scripts/piecewise_grace_maps.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/scripts/quick_mascon_plot.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/scripts/quick_mascon_regress.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/scripts/regress_grace_maps.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/scripts/run_grace_date.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/scripts/run_sea_level_equation.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/scripts/scale_grace_maps.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/mapping/plot_AIS_GrIS_maps.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/mapping/plot_AIS_grid_3maps.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/mapping/plot_AIS_grid_4maps.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/mapping/plot_AIS_grid_maps.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/mapping/plot_AIS_grid_movie.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/mapping/plot_AIS_regional_maps.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/mapping/plot_AIS_regional_movie.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/mapping/plot_GrIS_grid_3maps.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/mapping/plot_GrIS_grid_5maps.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/mapping/plot_GrIS_grid_maps.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/mapping/plot_GrIS_grid_movie.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/mapping/plot_global_grid_3maps.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/mapping/plot_global_grid_4maps.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/mapping/plot_global_grid_5maps.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/mapping/plot_global_grid_9maps.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/mapping/plot_global_grid_maps.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/mapping/plot_global_grid_movie.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/datasets/cnes_grace_sync.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/datasets/esa_costg_swarm_sync.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/datasets/gfz_icgem_costg_ftp.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/datasets/gfz_isdc_dealiasing_sync.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/datasets/gfz_isdc_grace_sync.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/datasets/itsg_graz_grace_sync.rst | Points docs to packaged module + argparse extraction. |
| doc/source/api_reference/datasets/podaac_cumulus.rst | Points docs to packaged module + argparse extraction. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
refactor: reorganize for modern
setuptoolsbuilds