.. _changes: Changelog ========= Version 0.6.0 ------------- *Released on: 2023/03/01* .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.7690145.svg :alt: Digital Object Identifier for the Zenodo archive :target: https://doi.org/10.5281/zenodo.7690145 Deprecations: - Deprecate `EQLHarmonic` and `EQLHarmonicSpherical` classes (`#366 `__) - Deprecate ``isostasy_airy`` function (`#379 `__) - Deprecate the synthetic and dataset modules (`#380 `__) New features: - Add function to create a tesseroid layer, similar to the one for the prism layer (`#316 `__) - Add function to read Oasis Montaj© grd files as ``xarray.DataArray`` (`#348 `__) - Add option to discard thin prisms when forward modelling a prism layer (`#373 `__) - Add FFT-based transformations and filters for horizontal derivatives, upward continuation, reduction to the pole of magnetic grids, and low-pass and high-pass Gaussian filters (`#299 `__) - Make horizontal derivative functions to compute the derivatives using central finite differences (`#378 `__) Maintenance: - Minor optimization in prism forward modelling (`#349 `__) - Set lower bounds for supported dependency versions following NEP29 (`#356 `__) - Extend support for Python 3.10 (`#240 `__) - Bump versions of style checkers like Black and Flake8 (`#368 `__) - Replace ``setup.py`` with PyPA ``build`` (`#363 `__) - Clean Harmonica API: make the ``forward``, ``equivalent_sources``, ``gravity_corrections``, ``isostasy`` and ``transformations`` submodules private (`#362 `__) Documentation: - Replace Cartopy with PyGMT throughout the documentation (`#327 `__) - Fix typo in equivalent sources tutorial (`#351 `__) - Add tesseroid_layer to the API reference (`#354 `__) - Update README to match Verde and Boule (`#358 `__) - Fix contact link in the documentation side bar (`#357 `__) - Set v0.4.0 as the last with support for Python 3.6 (`#359 `__) - Add more papers to "Citing the methods" section in the docs (`#375 `__) - Add examples and a user guide page for grid transformations (`#377 `__) - Add examples on how to use horizontal derivative functions to the user guide (`#384 `__) This release contains contributions from: - Mariana Gomez - Lu Li - Agustina Pesce - Santiago Soler - Matt Tankersley - Leonardo Uieda Version 0.5.1 ------------- *Released on: 2022/08/26* .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.7026294.svg :alt: Digital Object Identifier for the Zenodo archive :target: https://doi.org/10.5281/zenodo.7026294 Bug fixes: - Fix test function for empty ICGEM gdf file (`#345 `__) - Add a function to ignore the tesseroid with zero density or volume (`#339 `__) - Fix equivalent sources figures in gallery examples (`#342 `__) - Replace PROJECT placeholder in changes.rst for "harmonica" (`#341 `__) This release contains contributions from: - Agustina Pesce - BenjMy - Santiago Soler Version 0.5.0 ------------- *Released on: 2022/08/12* .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.6987201.svg :alt: Digital Object Identifier for the Zenodo archive :target: https://doi.org/10.5281/zenodo.6987201 Deprecations: - Add ``FutureWarning`` to ``isostasy_airy`` function warning of deprecation after next release (`#307 `__) - Ditch soon-to-be deprecated args of equivalent sources grid method (`#311 `__) - Remove deprecated ``point_mass_gravity`` function (`#310 `__) - Drop support for Python 3.6 (`#309 `__) - Add deprecations to datasets and synthetic modules (`#304 `__) New features: - Discard prisms with no volume or zero density before running the forward model (`#334 `__) - Add a new ``isostatic_moho_airy`` function to compute Moho depth based on Airy isostasy hypothesis using the *rock equivalent topography* concept (`#307 `__) - Add progressbar to prism forward gravity calculations (`#315 `__) - Add computation of gravitational tensor components for point sources (`#288 `__) - Add function to compute upward derivative of a grid in the frequency domain (`#238 `__) - Add conversion of prisms or a prism layer to PyVista objects (`#291 `__) Maintenance: - Simplify tests for upward derivative (`#328 `__) - Avoid checking floats in tesseroid doctests (`#326 `__) - Update Black to its stable version (`#301 `__) - Move configuration from setup.py to setup.cfg (`#296 `__) - Pin style checkers and formatters (`#295 `__) Documentation: - Add impostor syndrome disclaimer to docs (`#333 `__) - Convert README to Markdown, since it's no longer used to build the docs (`#331 `__) - Replace sphinx-panels for sphinx-design and refactor the home page of the docs(`#329 `__) - Specify spherical latitude in point sources guide (`#325 `__) - Note that spherical and geodetic latitudes are equal in spherical ellipsoids (`#324 `__) - Specify "spherical latitude" when describing coordinates of point masses (`#321 `__) - Fix small format errors in the user guide (`#319 `__) - Update docs and create a proper user guide (`#305 `__) - Update Sphinx version to 4.5.0 (`#302 `__) - Link Code of Conduct and Authorship, Contributing, and Maintainers Guides back to the Fatiando-wide pages (`#294 `__) - Replace Google Analytics for Plausible (`#297 `__) This release contains contributions from: - Federico Esteban - Lu Li - Agustina Pesce - Santiago Soler - Matt Tankersley - Leonardo Uieda Version 0.4.0 ------------- *Released on: 2021/12/02* .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.5745400.svg :alt: Digital Object Identifier for the Zenodo archive :target: https://doi.org/10.5281/zenodo.5745400 New features: - Allow ``EquivalentSources`` to define block-averaged sources through a new ``block_size`` argument [Soler2021]_. (`#260 `__) - Add ``dtype`` argument to ``EquivalentSources``. Allows to select the data type used to allocate the Jacobian matrix. (`#278 `__) - Add a new ``EquivalentSourcesGB`` class that implements gradient-boosted equivalent sources. Provides a method to estimate the amount of computer memory needed to allocate the largest Jacobian matrix [Soler2021]_. (`#275 `__) - Allow ``tesseroid_gravity`` to compute gravitational fields of variable density tesseroids. Implements the density-based discretization algorithm and takes ``numba.njit`` decorated density functions as input [Soler2019]_. (`#269 `__) Breaking changes: - Rename ``point_mass_gravity`` to ``point_gravity``. Having mass and gravity in the same function name is redundant. The function name has the same structure as other forward modelling functions (``tesseroid_gravity`` and ``prism_gravity``). The old ``point_mass_gravity`` will be deprecated on the next release. (`#280 `__) Bug fixes: - Fix bug with the ``require_numba`` pytest mark and rename it to ``run_only_with_numba`` for improved readability. (`#273 `__) Documentation: - Fix typo on ``EquivalentSources`` docstring: replace ``bloc_size`` with ``block_size``. (`#276 `__) - Minor improvements to the docs: fix bad references and links, replace Equivalent Layer for Equivalent Sources on API Index, fix bad RST syntax. (`#274 `__) Maintenance: - Rename the default branch: from ``master`` to ``main`` (`#287 `__) - Replace ``pylint`` for ``flake8`` extensions. Add ``isort`` for autoformatting imports. (`#285 `__) - Replace conda for pip on GitHub Actions and split requirements files for each separate task. (`#282 `__) - Make GitHub Actions to check if license notice is present in source files. (`#277 `__) This release contains contributions from: - Santiago Soler Version 0.3.3 ------------- *Released on: 2021/10/22* .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.5593112.svg :alt: Digital Object Identifier for the Zenodo archive :target: https://doi.org/10.5281/zenodo.5593112 Bug fix: - Add ``EquivalentSources`` and ``EquivalentSourcesSph`` to API index. Replace the old equivalent layer classes. (`#270 `__) This release contains contributions from: - Santiago Soler Version 0.3.2 ------------- *Released on: 2021/10/21* .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.5589989.svg :alt: Digital Object Identifier for the Zenodo archive :target: https://doi.org/10.5281/zenodo.5589989 Bug fixes: - Fix import of Harmonica version on sample datasets: solves a problem whenbuilding docs for releases. Define the ``__version__`` variable inside a new ``version.py`` file. (`#264 `__) This release contains contributions from: - Santiago Soler Version 0.3.1 ------------- *Released on: 2021/10/20* .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.5585665.svg :alt: Digital Object Identifier for the Zenodo archive :target: https://doi.org/10.5281/zenodo.5585665 Bug fix: - Package ``requirements.txt`` and update the dependencies list: remove ``scipy`` and add ``scikit-learn``. Exclude ``license_notice.py`` and ``.flake8`` from the ``MANIFEST.in`` (`#261 `__) This release contains contributions from: - Santiago Soler Version 0.3.0 ------------- *Released on: 2021/10/20* .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.5579324.svg :alt: Digital Object Identifier for the Zenodo archive :target: https://doi.org/10.5281/zenodo.5579324 Deprecations: - Rename equivalent sources classes to ``EquivalentSources`` and ``EquivalentSourcesSph``. The old ``EQLHarmonic`` and ``EQLHarmonicSpherical`` will be removed on v0.5 (`#255 `__) - Rename the ``relative_depth`` parameters in ``EquivalentSources`` to ``depth``. The old ``relative_depth`` parameter will be deleted on v0.5 (`#236 `__) New features: - Enable parallelization on tesseroids forward modelling and refactor its code (`#244 `__) - Add option to set ``EquivalentSources`` points to constant depth (`#236 `__) - Allow ``prism_layer`` to take Xarray objects as arguments (`#243 `__) Maintenance: - Generate version string on ``_version.py`` on build (`#237 `__) - Run CIs only on the two ends of supported Python versions (`#256 `__) - Transform ``require_numba`` decorator into a global variable (`#245 `__) Documentation: - Fix typo: replace bellow for below across docstrings (`#253 `__) - Fix version display in the HTML title (`#249 `__) - Remove unneeded line in prism_gravity example (`#248 `__) - Update Fukushima2020 citation on References (`#246 `__) - Change order of dims in example of ``prism_layer`` (`#241 `__) - Fix class name on See also section in ``prism_layer`` (`#230 `__) - Use the Jupyter book Sphinx theme instead of RTD (`#227 `__) This release contains contributions from: - Santiago Soler - Leonardo Uieda Version 0.2.1 ------------- *Released on: 2021/04/14* .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4685960.svg :alt: Digital Object Identifier for the Zenodo archive :target: https://doi.org/10.5281/zenodo.4685960 Minor changes: - Rename prisms_layer to prism_layer (`#223 `__) Bug fixes: - Unpin Sphinx and fix documentation style (`#224 `__) This release contains contributions from: - Santiago Soler Version 0.2.0 ------------- *Released on: 2021/04/09* .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4672400.svg :alt: Digital Object Identifier for the Zenodo archive :target: https://doi.org/10.5281/zenodo.4672400 New features: - Add function to create a layer of prisms and add a new South Africa ETOPO1 dataset (`#186 `__) - Optimize forward models by parallelizing outer loops for prisms and point masses and refactor the tesseroids forward modelling (`#205 `__) - Add parallel flag to EQLs (`#207 `__) - Parallelize EQLs predictions and Jacobian build (`#203 `__) - Improve EQL harmonic classes by splitting classes and adding upward argument to prediction methods (`#190 `__) - Add function to compute the distance between points given in geodetic coordinates (`#172 `__) - Allow ``load_icgem_gdf`` to take open file objects (`#155 `__) - Add new ``EQLHarmonicSpherical`` class to interpolate data using EQL in spherical coordinates (`#136 `__) Maintenance: - Extend support for Python 3.9 (`#219 `__) - Separate the Actions jobs into categories (`#218 `__) - Automatically check for license notice when checking code style (`#211 `__) - Use the OSI version of item 3 in the license (`#206 `__) - Add license and copyright notice to every .py file (`#201 `__) - Replace ``versioneer`` with ``setuptools_scm`` (`#196 `__) - Remove configuration files for unused CI: Stickler, Codacy and CodeClimate (`#197 `__) - Replace TravisCI and Azure for GitHub Actions (`#189 `__) - Fetch a sample data before testing locate because Pooch creates cache directory only after the first fetch (`#193 `__) - Require Black>=20.8b1 (`#187 `__) - Add CI builds for Python 3.8 (`#150 `__) - Replace global Zenodo DOI on badges and citation (`#148 `__) - Remove the GitHub templates from the repository and use the shared ones in fatiando/.github (`#149 `__) Documentation: - Add example for ``EQLHarmonicSpherical`` (`#152 `__) - Replace Cartesian distance for Euclidean distance in docs (`#156 `__) Bug fixes: - Keep metadata of sample datasets in the Xarray objects (`#184 `__) - Fix infinite loop on CIs after Numba v0.5.0 (`#180 `__) This release contains contributions from: - Santiago Soler - Leonardo Uieda - Nicholas Shea - Rowan Cockett Version 0.1.0 ------------- *Released on: 2020/02/27* .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3628742.svg :alt: Digital Object Identifier for the Zenodo archive :target: https://doi.org/10.5281/zenodo.3628742 Fist release of Harmonica. Forward modeling, inversion, and processing gravity and magnetic data. Forward models: - Point masses in Cartesian coordinates. Gravitational potential with vertical (`#71 `__) and horizontal components of acceleration (`#119 `__). - Point masses in spherical coordinates. (`#60 `__) - Rectangular prisms. (`#86 `__) - Tesseroids. (`#60 `__) Available datasets: - Great Britain aeromagnetic dataset. (`#111 `__) - South Africa gravity station data. (`#99 `__) - Geoid grid from EIGEN-6C4. (`#34 `__) - Global topography from ETOPO1. (`#23 `__) - Global gravity data from EIGEN-6C4. (`#12 `__) Other features: - Synthetic ground and airborne surveys based on real world data. (`#120 `__) - Equivalent Layer for harmonic functions. (`#78 `__) - Planar Bouguer correction. (`#38 `__) - Airy Isostasy function. (`#17 `__) - Function to read ICGEM data files. (`#11 `__) This release contains contributions from: - Leonardo Uieda - Santiago Soler - Vanderlei C Oliveira Jr - Agustina Pesce - Nicholas Shea - ziebam