fatiando / harmonica

Forward modeling, inversion, and processing gravity and magnetic data
https://www.fatiando.org/harmonica
BSD 3-Clause "New" or "Revised" License
211 stars 69 forks source link

Clean API making some submodules private #362

Closed santisoler closed 1 year ago

santisoler commented 1 year ago

Make the forward, equivalent_sources, gravity_corrections, isostasy and transformations submodules as private ones. This will enforce the usage of public functions and classes allowing developers to refactor private ones without the risk of braking backward compatibility. It also cleans up the list of options available when using autocompletion in IDEs and JupyterLab, helping the discoverability of the functions and classes we have in Harmonica.

Relevant issues/PRs: Fixes #314

santisoler commented 1 year ago

The io module should also be private, but this is handled by #348. To avoid having to solve conflicts I'm leaving the io untouched here.