Skip to content

Commit

Permalink
Add changelog for 1.1.0 (#152)
Browse files Browse the repository at this point in the history
Created a changelog for the new 1.1.0 release with Zenodo DOI.
Updated the authors list and made it alphabetical by last name.
Updated install instructions to be clearer what numba and pykdtree do.
  • Loading branch information
leouieda authored Nov 6, 2018
1 parent 2bec134 commit fe250cc
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 13 deletions.
9 changes: 4 additions & 5 deletions AUTHORS.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
# Project Contributors

This project was initially created by
[Leonardo Uieda](http://www.leouieda.com/).
This project was started by [Leonardo Uieda](http://www.leouieda.com/). The following
people have made contributions to the project (in alphabetical order by last name):

The following people have made contributions to the project:

* [Leonardo Uieda](http://www.leouieda.com/)
* [David Hoese](https://github.com/djhoese)
* [Jesse Pisel](https://github.com/jessepisel)
* [Leonardo Uieda](https://github.com/leouieda)
1 change: 1 addition & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -162,5 +162,6 @@ Documentation for other versions
* `Development <http://www.fatiando.org/verde/dev>`__ (reflects the *master* branch on
Github)
* `Latest release <http://www.fatiando.org/verde/latest>`__
* `v1.1.0 <http://www.fatiando.org/verde/v1.1.0>`__
* `v1.0.1 <http://www.fatiando.org/verde/v1.0.1>`__
* `v1.0.0 <http://www.fatiando.org/verde/v1.0.0>`__
51 changes: 47 additions & 4 deletions doc/changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,49 @@
Changelog
=========

Version 1.0.1 (2018-10-10)
--------------------------

Version 1.1.0
-------------

*Released on: 2018/11/06*

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1478245.svg
:target: https://doi.org/10.5281/zenodo.1478245

New features:

* **New** ``verde.grid_to_table`` function that converts grids to xyz tables with the
coordinate and data values for each grid point
(`#148 <https://github.com/fatiando/verde/pull/148>`__)
* Add an ``extra_coords`` option to coordinate generators (``grid_coordinates``,
``scatter_points``, and ``profile_coordinates``) to specify a constant value to be
used as an extra coordinate (`#145 <https://github.com/fatiando/verde/pull/145>`__)
* Allow gridders to pass extra keyword arguments (``**kwargs``) for the coordinate
generator functions (`#144 <https://github.com/fatiando/verde/pull/144>`__)

Improvements:

* Don't use the Jacobian matrix for predictions to avoid memory overloads. Use dedicated
and numba wrapped functions instead. As a consequence, predictions are also a bit
faster when numba is installed (`#149 <https://github.com/fatiando/verde/pull/149>`__)
* Set the default ``n_splits=5`` when using ``KFold`` from scikit-learn
(`#143 <https://github.com/fatiando/verde/pull/143>`__)

Bug fixes:

* Use the xarray grid's pcolormesh method instead of matplotlib to plot grids in the
examples. The xarray method takes care of shifting the pixels by half a spacing when
grids are not pixel registered (`#151 <https://github.com/fatiando/verde/pull/151>`__)

New contributors to the project:

* Jesse Pisel


Version 1.0.1
-------------

*Released on: 2018/10/10*

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1421979.svg
:target: https://doi.org/10.5281/zenodo.1421979
Expand All @@ -16,8 +57,10 @@ Version 1.0.1 (2018-10-10)
* Fix typo in the weights tutorial (`#136 <https://github.com/fatiando/verde/pull/136>`__).


Version 1.0.0 (2018-09-13)
--------------------------
Version 1.0.0
-------------

*Released on: 2018/09/13*

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1415281.svg
:target: https://doi.org/10.5281/zenodo.1415281
Expand Down
9 changes: 5 additions & 4 deletions doc/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,12 @@ Dependencies
The following are optional dependencies that can make some parts of the code faster if
they are installed:

* `numba <https://numba.pydata.org/>`__: replaces numpy calculations of predictions and
Jacobian matrices in splines with faster and more memory efficient multi-threaded
versions.
* `pykdtree <https://github.com/storpipfugl/pykdtree>`__: replaces
:class:`scipy.spatial.cKDTree` in :class:`verde.BlockReduce` and
:func:`verde.distance_mask` for better performance.
* `numba <https://numba.pydata.org/>`__: replaces numpy calculations of Jacobian
matrices in splines with multi-threaded versions.
:class:`scipy.spatial.cKDTree` for better performance in near neighbor calculations
used in blocked operations, distance masking, etc.

Most of the examples in the :ref:`gallery` and :ref:`tutorials` also use:

Expand Down

0 comments on commit fe250cc

Please sign in to comment.