## Version 4.8

- Several functions have been vectorized using
`numpy.vectorize()`

. These include:`spharm_lm()`

,`legendre_lm()`

,`MakeGridPoint()`

,`MakeGridPointC()`

,`DownContFilterMA()`

,`DownContFilterMC()`

,`NormalGravity()`

,`SHConfidence()`

, and`PlmIndex()`

. - A new Fortran routine
`MakeGradientDH`

was added to compute the horizontal gradient of a real scalar function. The method`.gradient()`

was added to the`SHCoeffs`

class, and a new class`SHGradient`

was created to store and plot the two horizontal components of the gradient. - Added new Fortran functions
`MakeGravGridPoint`

and`MakeMagGridPoint`

to compute the gravity and magnetic field vector at a single point. - Added the option to compute the gravity and magnetic field vectors at a single point using the python class methods
`SHGravCoeffs.expand()`

and`SHMagCoeffs.expand()`

. - The
`plot_spectrum2d()`

routines have been updated to include more plotting options, including placement of the origin, tick intervals, and colormaps. Most optional parameters are the same as in the`SHGrid.plot()`

method. - Added the option to including intensity shading in the
`SHGrid.plotgmt()`

routine. The shading can be derived from the gradient of the input grid (by setting`shading=True`

) or from a different map by supplying an`SHGrid`

class instance. Optional parameters include the azimuth of the shading (`shading_azimuth`

), as well as the maximum amplitude of the intensity (`shading_amplitude`

). - Modified all the Fortran routines to use a slightly more efficient way to compute the radius of an ellipsoid as a function of geocentric latitude.
- Fixed a bug in
`SHCoeffs.expand()`

when`colat`

was specified in radians. - All declarations of integers in the Fortran code are now made using the types defined in the module
`iso_fortran_env`

. Furthermore, the python wrapper and signature files have been updated to be explicit when defining the Fortran variables. - Fixed a bug where the old module name
`constant`

needed to be updated to`constants`

in the method`SHCoeffs.centroid()`

. - Corrected the parameterization used when generating ellipsoids in
`SHGrid.from_ellipsoid()`

. Though this method was introduced in v4.7, it was not mentioned in the release notes. - Changed the default behavior of
`SHCoeffs.to_array()`

so that the default value is not to return the errors by setting`errors=False`

. - Added the optional attribute
`name`

to the coefficient classes`SHGrid`

,`SHGravCoeffs`

,`SHMagCoeffs`

and`SlepianCoeffs`

. All datasets now explicity set`name`

to the function call of the dataset. - Moved the file
`shtools.h`

from`src/`

to`include/`

and updated the Makefiles accordingly.

M. A. Wieczorek, M. Meschede, E. Sales de Andrade, A. Corbin, I. Oshchepkov, B. Xu, and A. Walker, A. Hattori, S. Schröder, K. Leinweber, A. Vasishta (2021). SHTOOLS: Version 4.8, Zenodo, doi:10.5281/zenodo.592762

## Version 4.7.1

- Minor modifications were made to the Makefiles in order to submit shtools to the homebrew-core and macports package managers. Relative paths were removed in a few cases by explicitly passing variables such as
`$(MODPATH)$`

to all dependent sub-makefiles. Default variables are no longer set in the sub-makefiles, as these are not intended to be used independently: All variables are passed directly from the main Makefile. Renamed the directory`modules`

to`include`

to be consistent with macports and homebrew installations. The`F95FLAGS`

are set by searching if the compiler name contains the “short” compiler name. This allows recognizing “gfortran-10” as being “gfortran”. - Added a
`.github`

folder with templates for issues and releases checklists. - Converted matplotlib relative font sizes (such as ‘large’) to points when passing font sizes to the Cartopy and pygmt plotting routines.
- Minor changes to the Travis configuration file, the conda
`environment.yml`

file, and fortran documentation and man pages. - Added initial experimental support for C-binded SHTOOLS wrapper functions. This includes replacing assumed-size arrays with fixed-size arrays with additional arguments for each dimension. Though this is not yet documented, a working example can be found in the folder
`examples/cpp`

.

M. A. Wieczorek, M. Meschede, E. Sales de Andrade, A. Corbin, I. Oshchepkov, B. Xu, and A. Walker, A. Hattori, S. Schröder, K. Leinweber, A. Vasishta (2020). SHTOOLS: Version 4.7.1, Zenodo, doi:10.5281/zenodo.592762

## Version 4.7

**Datasets**

The new datasets module allows users to easily download spherical harmonic coefficient datasets and return them as `SHCoeffs`

, `SHGravCoeffs`

or `SHMagCoeffs`

class instances.

To load a dataset, call the relevant method as in these examples:

```
hlm = pysh.datasets.Venus.VenusTopo719() # Venus shape
clm = pysh.datasets.Earth.EGM2008() # Earth gravity
glm = pysh.datasetes.Earth.WDMAM2_800() # Earth magnetic field
clm = pysh.datasets.Moon.GRGM1200B() # Gravity of the Moon
```

**Better IO routines**

- Added the functions (in the module
`shio`

)`shwrite()`

,`read_dov()`

`write_dov()`

,`read_bshc()`

,`write_bshc()`

and`write_igcem_gfc()`

to read and write ‘shtools’, ‘dov’, ‘bshc’, and ‘icgem’ files. - Added the function
`shio.read_igrf()`

for reading IGRF formatted files, and returning coefficients for a specified year. - The
`SHCoeffs`

,`SHMagCoeffs`

and`SHGravCoeffs`

methods`to_file()`

and`from_file()`

now accept all file formats. - Added support for reading gzip and zip files in
`shread`

,`SHCoeffs.from_file()`

,`SHGravCoeffs.from_file()`

,`SHMagCoeffs.from_file()`

, and`read_icgem_gfc()`

- Fixed a minor bug where netcdf files would not accept boolean attributes.

**Amittance and correlation methods**

- Added the methods
`admittance()`

,`correlation()`

and`admitcorr()`

for the classes`SHCoeffs`

,`SHGravCoeffs`

, and`SHMagCoeffs`

to compute the admittance and/or correlation with another function. - Added the methods
`plot_admittance()`

,`plot_correlation()`

and`plot_admitcorr()`

to easily plot these functions.

**Better plotting routines**

- Added the option
`legend_loc`

to most plotting routines to allow fine control over where the legend is placed. - Minor bug fixes concerning colorbar parameters
`cb_offset`

and`cb_triangles`

.

**Better treatmentment of uncertainties**

- Added the option to include error coefficients in the class
`SHCoeffs`

. - Added the boolean option
`errors`

to the method`to_array()`

in order to control whether the error coefficients are returned with the function spherical harmonic coefficients. - Added the option
`legend_error`

to the`SHCoeffs`

,`SHMagCoeffs`

and`SHGravCoeffs`

method`plot_spectrum()`

to provide a customized legend entry for the error spectrum.

**New attributes for SHCoeffs, SHGravCoeffs and SHMagCoeffs**

- Added the attribute
`error_kind`

to specify the type of errors. - Added the attribute
`units`

to all grid and coefficient classes. - Added the attribute
`epoch`

to`SHGravCoeffs`

,`SHGravGrid`

,`SHGeoid`

and`SHTensor`

. - Added the attribute
`year`

to`SHMagCoeffs`

,`SHMagGrid`

, and`SHTensor`

.

**Improved Documentation**

- The web documentation has been broken into two separate components: pyshtools (python) and SHTOOLS (Fortran 95).
- Reorganized the web documentation for clarity (re-organization of tutorials and guides, creation of a separate page for shtools grid formats, creation of separate pages for datasets, constants, and spherical harmonic coefficient file coeeficients).
- The python tutorial notebooks are now rendered by the jupyter nbviewer web page. From this viewer, the user can easily download the notebook, or run it in a binder session.
- Updated the documentation for installing pyshtools using Conda.

**Initial support for fpm**

Initial experimental support is added for use with fpm: the fortran package manager.

To install as a stand-alone project, it is only necesssary to use the command

```
fpm build
```

This will place the necessary .mod and .a files in a subdirectory of `build`

.

To include shtools as a dependency in a project that compiles with fpm, you only need to add the following to the `fpm.toml`

file:

```
[dependencies]
SHTOOLS = {git="https://github.com/SHTOOLS/SHTOOLS.git"}
```

In the current state of fpm (which is undergoing active development), it is not possible to link to system wide libraries, such as fftw and lapack, which are required by shtools.

**Other changes**

- Added error checks to the pyshtools function
`YilmIndexVector`

. - Renamed the
`constant`

module to`constants`

, and reogranized the constants in a more logical way (i.e.,`constants.Mars.r`

instead of`constants.Mars.r_mars`

). - Added a gmt xarray accessor for use with pygmt.
- Fixed a bug in
`Curve2Mask`

python wrapper when using extended grids, and fixed a bug in the fortran code when the input file contained points at exactly 0 or 360 degree. - pyshtools versioning is now done using
`versioneer`

, instead of the homemade system that was in the setup.py (which was somewhat complicated and needed to set`ISREALESED`

to True or False). Versioneer gets the version number automatically from git tags.

M. A. Wieczorek, M. Meschede, E. Sales de Andrade, I. Oshchepkov, B. Xu, and A. Walker, A. Hattori, S. Schröder, K. Leinweber, A. Vasishta (2020). SHTOOLS: Version 4.7, Zenodo, doi:10.5281/zenodo.592762

## Version 4.6

**New extended grids**

All grid formats now allow to compute the redundant values at 360 E longitude (GLQ and DH), as well as at 90 S (DH only). These *extended* grids are now the default in pyshtools, but remain optional in the Fortran 95 routines. The use of extended grids is controlled by the optional argument `extend`

. The purpose of these extended grids is to better integrate with the plotting routines that require these points (i.e.., Cartopy and pygmt).

**Improved plotting and map projections**

The plotting routine `SHGrid.plot()`

has been refactored to allow support for projections using `Cartopy`

and `pygmt`

.

- An incorrect 0.5 pixel offset was fixed when plotting grids via matplotlib, and grids now correctly plot both 0 and 360 degrees using the new “extended” grids of
`SHGrid`

. - Support was added for Cartopy projections, by specifying:
`SHGrid.plot(projection=ccrs.ProjectionName())`

. - The argument
`colorbar`

now takes the options ‘top’, ‘bottom’, ‘left’ or ‘right’. - Improved plotting and placement of colorbars. New optional arguments include
`cb_label`

for labels,`cb_ylabel`

for a label on the y axis of the colorbar,`cb_tick_interval`

for specifying the major tick interval,`cb_minor_tick_interval`

for specifying minor tick intervals,`cb_triangles`

for plotting upper/lower limit triangles at the ends of the colorbar,`cb_width`

to specify the colorbar width, and`cb_offset`

to override the default spacing between the map and colorbar. - Improved colormap handling: New optional arguments include
`cmap_limits`

to specify the lower and upper bounds of the data, as well as an interval for constant color intervals, and`cmap_reverse`

to reverse the colormap. - Improved handling of ticks and annotations: The optional argument
`ticks`

specifies which ticks and annotations to show, using a syntax from the generic mapping tools (i.e.,`'WSen'`

). - Experimental support for pygmt using the routine
`SHGrid.plotgmt()`

. This function takes nearly the same arguments as`plot()`

. As soon as pygmt implements projection classes (https://github.com/GenericMappingTools/pygmt/pull/379), this will be incorporated into the`plot`

function in the same manner as Cartopy was. - All gravity, magnetics, tensor, localization windows and slepian function plotting routines incorporate these changes.
- Added a new introductory notebook that shows how to use all features of the
`plot()`

function.

**Improved integration with xarray DataArrays, xarray DataSets, and netcdf files**

- Added the methods
`to_netcdf()`

and`from_netcdf()`

to the`SHCoeffs`

,`SHGravCoeffs`

and`SHMagCoeffs`

classes. - Added the method
`SHGrid.from_xarray()`

to initialize a grid from an xarray DataArray. - Added improved descriptive attributes for netcdf files that mirror these conventions.
- Added the method
`SHGeoid.to_xarray()`

to export an xarray DataArray and`to_netcdf()`

to export a netcdf object readable by the generic mapping tools. - Added the methods
`SHGravGrid.to_xarray()`

and`SHMagGrid.to_xarray()`

to export all gridded data (radial, theta, phi, total, and potential) as an xarray DataSet. - Added the methods
`SHGravTensor.to_xarray()`

and`SHMagTensor.to_xarray()`

to export all gridded data (Vxx, invariants, eigenvalues) as an xarray DataSet.

**Gravity routine improvements**

- Added the method
`SHGravCoeffs.center_of_mass`

to calculate the center of mass of a body. - Added the method
`SHGravCoeffs.inertia_tensor()`

to calculate the moment of inertia tensor. - Added the Earth dynamical flattening constant H (IERS Conventions 2010) to the
`constant`

module. - The
`read_icgem_gfc()`

function was extended with the option`encoding`

as some models in ICGEM are not in UTF-8. - Addded the method
`centroid()`

to the class`SHCoeffs`

. The centroid is computed as the center of mass of a homogeneous object.

**Other changes**

- New methods
`SHGrid.to_real()`

and`SHGrid.to_imag()`

return the real and imaginary components of a complex`SHGrid`

instance. - Added an optional argument
`copy`

to`SHCoeffs.pad()`

. - Fixed bugs in the Fortran code of
`PlBar_d1`

and`PlON_d1`

when calculating the Legendre polynomials at the north and south pole. - Spherical harmonic coefficients can be read remotely by specifying a URL as the filename. This functionality uses
`requests.get()`

, and has been implemented in the function`shread()`

and the`SHCoeffs`

method`from_file()`

. - Fixed a bug in the fortran code of
`Curve2Mask`

. As part of this fix, the optional parameter`centralmeridian`

has been removed as it is no longer required. The longitudes of the curve can possess values from -360 to 720 degrees, and the routine searches for discontinuities that may occur between two successive points as the longitudes pass from 360 to 0, or -180 to 180 degrees.

M. A. Wieczorek, M. Meschede, E. Sales de Andrade, I. Oshchepkov, B. Xu, and A. Walker, A. Hattori, S. Schröder, K. Leinweber, A. Vasishta (2020). SHTOOLS: Version 4.6, Zenodo, doi:10.5281/zenodo.3698050

## Version 4.5

**SHCoeffs**

- Added
`cross_spectrum()`

,`plot_cross_spectrum()`

and`plot_cross_spectrum2d()`

methods to the`SHCoeffs`

class. - Added
`from_cap()`

constructor to create coefficients of a spherical cap. - Fixed a small bug when rotating coefficients in the
`SHCoeffs`

,`SHMagCoeffs`

and`SHGravCoeffs`

classes when the input`csphase`

is different from the default value.

**SHGrid**

- Added the method
`from_zeros()`

to initialize a grid with zeros. - Added the method
`from_cap()`

to initial a grid with a spherical cap. - Added support for saving gridded data to netcdf and xarray formats.
`to_netcdf()`

exports data to netcdf format, and when saved to file can be used directly with GMT (generic mapping tools) where they are known as ‘grd’ files.`to_xarray()`

exports data to an xarray DataArray. - Fixed a type error when expanding complex coefficients at arbitrary points.

**Slepian functions**

- Added the fortran function
`SHSCouplingMatrix`

and`Slepain`

class method`coupling matrix()`

for computing the coupling matrix that relates the Slepian expansion power spectrum to the global power spectrum. - Added the fortran function
`SHSCouplingMatrixCap`

which is optimized for working with spherical cap Slepian functions. - Improved the plotting capabilities of the method
`plot_coupling_matrix`

, such as the addition of colorbars, and the option to normalize to maximum value to unity. - Added the option
`taper_degrees()`

and`slepian_degrees()`

to the`SHWindow`

and`Slepian`

classes, respectively, to allow for the construction of Slepian functions that exclude certain spherical harmonic degrees. - Added the fortran function
`SHMTVar`

and the`SHWindow`

class method`variance()`

to compute the variance of a multitaper spectral estimate (based on`SHMTVarOpt`

). - Added the fortran function
`SHSlepianVar`

and the`Slepian`

class method`variance()`

to compute the variance of a Slepian expansion spectral estimate. - Improved the handing of the optional parameter
`weights`

in all methods of`SHWindow`

. **Changed the name of the optional parameter**`nwin`

of`SHWindow.coupling_matrix`

to`k`

for consistency with the localized spectral analysis routines.

**Fortran 95**

- The Fortran code was modified to be strictly compliant with the f95 standard (
`-std=f95`

in the`gfortran`

compiler). Double precision, double complex, and long integers are defined as`real(dp)`

,`complex(dp)`

, and`integer(int8)`

, and the types are defined in a new module`ftypes.f95`

. - A few intrinsic function calls have been renamed to conform with the standards, and all double precision constants are now defined by appending
`_dp`

to them.

**FFTW**

- The syntax of the
`fftw`

routines has been updated. In particular, the old`call dfftw_execute(plan)`

statements now include all their dependent variables using the new syntax`call fftw_execute_dft(plan, grid, coef)`

. Importantly, the old syntax caused the GCC9 optimizer to break the spherical transform routines, generating meaningless output for large parts of the grids or coefficients. - The fortran routines now access the FFTW library using Fortran 2003 standards. Though most compilers do not yet support all features of F2003, the few features used here (such as the module
`iso_c_binding`

) are claimed to be supported by the majority of modern compilers. This allows us to access the FFTW routines without use of fortran bindings, which are not always included in compiled versions of FFTW. - All FFTW routines are explicitly defined in an interface block in
`FFTW3.f95`

. For simplicity, the use of the optional parameter`FFTW_UNDERSCORE`

used in the Makefile has been deprecated.

M. A. Wieczorek, M. Meschede, E. Sales de Andrade, I. Oshchepkov, B. Xu, and A. Walker (2019). SHTOOLS: Version 4.5, Zenodo, doi:10.5281/zenodo.2350781

## Version 4.4

**New Slepian expansion routines**

- Added the new Fortran 95 functions
`SHRotateTapers`

for rotating spherical cap Slepian functions,`SlepianCoeffs`

for expanding a function in a Slepian basis, and`SlepianCoeffsToSH`

to convert the Slepian coefficients into spherical harmonic coefficients. - Added two python classes
`Slepian`

and`SlepianCoeffs`

for managing Slepian basis functions and the Slepian expansion coefficients of a function.

**Legendre and spherical harmonic convenience functions**

- Added 4 python convenience functions for computing Legendre and spherical harmonic functions:
`legendre()`

to compute all the legendre functions,`legendre_lm()`

to compute the legendre function for a specified degree and order,`spharm()`

to compute all the spherical harmonic functions, and`spharm_lm()`

to compute the spherical harmonic functions for a specific degree and order.

**Other improvements**

- Added the option to perform a weighted least squares inversion in the fortran routine
`SHExpandLSQ`

, and added a python wrapped function`SHExpandWLSQ()`

. - Added
`min()`

and`max()`

methods to the`SHGrid`

class, to return the minimum and maximum value of the gridded data. - Added the property
`mass`

to the`SHGravCoeffs`

class, which is computed by the input GM and the codata value for`G`

. - Add the optional parameter
`omega`

to`SHGravCoeffs.geoid()`

to override the value provided in the class instance. - Fixed some minor typos and usability issues, and cleaned up the python wrapper and signature files.

M. A. Wieczorek, M. Meschede, E. Sales de Andrade, I. Oshchepkov, B. Xu, and A. Walker (2018). SHTOOLS: Version 4.4, Zenodo, doi:10.5281/zenodo.592762

## Version 4.3

**New Gravity and Magnetic field classes**

- Added gravity classes
`SHGravCoeffs`

,`SHGravGrid`

,`SHGravTensor`

and`SHGeoid`

. - Added magnetic field classes
`SHMagCoeffs`

,`SHMagGrid`

, and`SHMagTensor`

. - Added new fortran subroutine
`MakeMagGradGridDH`

, which is analogous to`MakeGravGradGridDH`

. - Reorded the arguments of
`CilmPlusRhoHDH`

to be consistent with`CilmPlusDH`

. - The python routine
`MakeMagGridDH`

now also outputs the magnetic potential as a grid.

**Better figures**

- Addition of the function
`pyshtools.utils.figstyle()`

, that sets several matplotlib parameters for better figures. This function takes as optional parmeters the maximum useable width of a journal page, the relative width of the figure with respect to this value, and the screen resolution in dpi. - Most plotting routines have optional parameters to set minor tick intervals, grids, label font size, and tick font size.
- Degree symbols are plotted on tick labels for maps.
`examples/python/Common/FigStyle.py`

was removed from the examples.- Added the options
`vmin`

and`vmax`

to the plotting methods`SHCoeffs.plot_spectrum2d()`

in order to specify the limits of the color scale. - Added the option to plot colorbars on
`SHGrid`

plots, along with the option to specify their orientation and a text label. - All notebooks have been updated.

**New constant subpackage**

- The
`constant`

subpackage has been completely rewritten and now makes use of the astropy`Constant`

class. This class has attributes`name`

,`value`

,`uncertainty`

,`unit`

, and`reference`

. The naming of the constants has changed in some cases for consistency. A few constants that are not necessary were removed. Many of the constants were updated with more recent values.`Constants`

can be used in arithmetic operations with either other`Constants`

or with objects of the astropy class`Quantity`

. - Constants are organized into modules for each of the planets (
`Mercury`

,`Venus`

,`Earth`

,`Moon`

, and`Mars`

), and for convenience, these are all added to the main namespace. The fundamental constants`G`

and`mu0`

from the astropy constants package were added (as taken from CODATA 2014).

**Other changes**

- Fixed a bug in how the random coeffcients were determined for unnormalized coeffcients in SHCoeffs.
- Optional parameter
`seed`

added to`SHCoeffs.from_random()`

to allow for reproducibility. - One can now specify colat instead of lat for the method SHCoeffs.expand().
- Added
`__repr__`

methods to all pyshtools classes. - Changed the mathematical operators of
`SHCoeffs`

such that addition and subtraction of a constant only affects the degree 0 term. - Added the optional parameter
`lmax`

to`SHCoeffs.plot_spectrum()`

and`SHCoeffs.plot_spectrum2d()`

. - Fixed a bug in
`SHCoeffs.pad()`

where the attribute`mask`

was not similarly padded. - For mathematical operations with
`SHCoeffs`

grids, it is now required that the two class instances have the same`lmax`

. - Clarified the documentation of
`SHRotateCoef`

to point out that this is only valid for intrinsically real functions that are expressed in complex harmonics. - Added the method
`volume()`

to the class SHCoeffs, that calculates the volume of the object. - Added the attributes
`area`

and`shannon`

to`SHWindow`

, which provides the area of the concentration domain and the shannon number. - Removed python installation support from Makefile: use pip instead.

**Citation:**

M. A. Wieczorek, M. Meschede, E. Sales de Andrade, I. Oshchepkov, B. Xu, and A. Walker (2018). SHTOOLS: Version 4.3, Zenodo, doi:10.5281/zenodo.1346663

## Version 4.2

**Change log:**

- Full support added for the use of unnormalized harmonics in the classes
`SHCoeffs`

and`SHGrid`

. To make use of this normalization, just specify`normalization='unnorm'`

. - Added a new python native routine
`mag_spectrum()`

in the subpackage`gravmag`

that replaces the original fortran wrapped routines. The old python wrapped functions have been removed from pyshtools. This new routine is nearly the same as`spectrum()`

, and further allows one to compute the spectrum of the potential or magnetic intensity. - The old fortran based
`SHRead`

function has been replaced with a python native version`shread()`

. The functionality is nearly identical as before, and combines the previous routines`SHRead`

,`SHReadError`

,`SHReadErrorH`

and`SHReadH`

into one. Differences include: (1) It is no longer necessary to specify the lmax of the file: This is determined automatically by reading the file from the end, (2) both real and complex coefficients are supported, (3) a header line can be output, but it is a simple list of type str that will need to be converted to the correct format by the user, and (4) “comment” lines are read and ignored: A valid line is one where there are 4 or more words, and where the first two words are integers. - A new python native function
`convert()`

was added in the subpackage`shio`

that converts between arrays of spherical harmonic coefficients with different normalizations. The class`SHCoeffs`

was then simplified by using this external function for all conversions involving`SHCoeffs`

class instances. - The optional parameter lmax was added to
`SHCoeffs.spectrum()`

. - When plotting grid from the class
`SHGrid`

, one can now specify the label to use for the x and y axes with`xlabel`

and`ylabel`

, as well as the interval to use when plotting ticks on both axes using`tick_interval`

. - The pyshtools rotation routines now allow you to specify the optional parameter
`convention`

to treat Euler angles in either the`x`

or`y`

conventions (i.e., which axes to use for the second rotation). Furthermore, the optional argument`body`

allows you to specify if you want to rotate the body (True), or coordinate system (False, default). The tutorial number 3 was updated to clear up some inconsistencies in how the angles were defined. - New optional parameters added to
`SHWindow.plot_windows()`

and`SHWindow.plot_spectra()`

that include`xlim`

and`ylim`

for the limits when plotting spectra,`maxcolumns`

for the number of columns to use when plotting several windows, and`lmax`

which controls the grid spacing when plotting the windows. - Added the optional argument
`lmax`

to`SHCoeffs.from_random()`

that allows you to create coefficients with maximum bandwidths that are either greater or less than the bandwidth of the input power spectrum. - Added a warning message when using
`SHCoeffs.rotate()`

with degrees greater than 1200, as the routine is not accurate beyond this value. - Added an optional argument
`legend`

to`SHWindow.plot_windows()`

to control whether the legend is plotted or not. - Fixed a minor bug in ClassExample.py file concerning the use of
`SHCoeffs.rotate()`

. - Added support for plotting to an already existing figure by allowing the user to specify an existing matplotlib axes.
- Removed some non-standard ascii dashes in the documentation files, and forced all doc files to be opened as
`utf-8`

. - HTML documentation was completely redone using Jekyll. The markdown source files are now located in
`pages/mydoc`

. A static html web site is built using`jekyll`

, whose files are located in`doc`

. Github will automatically create the static pages and serve them on shtools.github.io/SHTOOLS. To build the static pages yourself, it is only necessary to execute`bundle exec jekyll build`

in the directory`doc`

, which will build the site into`_site`

in the same directory. Alternatively,`make www`

in the main directory will create a static site in the top-level directory`www`

that could be used to deploy on a different web server. The site is based on the template Jekyll documentation theme by @tomjoht.

**Citation:**

M. A. Wieczorek, M. Meschede, E. Sales de Andrade, I. Oshchepkov, B. Xu, and A. Walker (2018). SHTOOLS: Version 4.2, Zenodo, doi:10.5281/zenodo.1250054

## Version 4.1

This version adds improved functionality to SHTOOLS and fixes a couple of minor bugs. In addition, this release will be the first where pre-built wheels for unix/macOS/windows will be distributed via PYPI.

**Change log:**

- Added an optional argument
`lmax`

to`SHCoeffs.from_array()`

. - Coefficients are zero-padded when
`lmax`

is greater than the maximum degree in`SHCoeffs.to_array()`

. - The method
`pad()`

was added to the`SHCoeffs`

class that zero pads or truncates the coefficients to a different`lmax`

. - Fixed the method
`SHCoeffs.from_file()`

such that the maximum spherical harmonic degree of the class is the maximum spherical harmonic degree of the coeffs (and not`lmaxin`

as before). - Fixed formatting issues with error messages in
`SHCoeffs`

. - Removed print statements from the fortran code in
`BAtoHilm`

and`BAtoHilmRohH`

that served no purpose. - Fixed a bug in the argument order of the python wrappers of
`CilmPlusRhoDH`

and`BAtoHilmRhoDH`

. - Fixed the makefile to remove the
`dist`

directory during clean. - Fixed a bug in the python routine
`cross_spectrum()`

, where the numpy arange function was incorrectly called. - Fixed the
`SHWindow`

plotting methods to work when the number of rows is equal to 1. - Conditional tests in the routine
`Wigner3j`

were reordered to avoid a division by zero. - Numpy’s auto-configuration is now used to detect the LAPACK libraries.
- Many minor updates to the python documentation and unix man pages.

**Citation:**

M. A. Wieczorek, M. Meschede, E. Sales de Andrade, I. Oshchepkov, B. Xu, and A. Walker (2017). SHTOOLS: Version 4.1, Zenodo, doi:10.5281/zenodo.1067108

## Version 4.0

This is a major update that fixes bugs, adds new functionality, and improves Python error handing. All users are requested to upgrade to 4.0.

**Change log:**

- Instead of executing a Fortran STOP, which kills the Python kernel, the Fortran subroutines now return an
`exitstatus`

that allows Python to raise an exception. This technique does not work with the few Fortran functions that pyshtools calls, but these functions are relatively benign, and will soon be phased out for Python native functions. - The Fortran
`powerspectrum`

routines have been removed from pyshtools, and have been replaced with Python native routines`spectrum`

and`cross_spectrum`

. The Python routines allow to specify the normalization, whether the output should be power, energy or l2norm, and whether the spectrum is per degree, per coefficient, or per log bandwidth. - The method
`plot_spectrum2d()`

was added to the class`SHCoeffs`

to plot the power as a function of degree and order. - All pyshtools modules have been converted into proper Python subpackages. The subpackage
`localizedpsectralanalysis`

has been merged into`spectralanalysis`

, and the subpackage`other`

has been renamed`utils`

. - The Python class method
`SHCoeffs.expand()`

now can evaluate the function either on an SHGrid or for a list of latitude and longitude points. As part of this change, a new fortran function`MakeGridPointC`

was created for complex coefficients. - The majority of the methods for the classes
`SHCoeffs`

,`SHGrid`

and`SHWindow`

have been rename for consistency (see documentation!). Also, the classes now give the option of reading or saving to files as numpy arrays. - Added new Python function
`read_icgen_gfc`

for reading ICGEM-format gravity coefficient files. - The operator
`pow`

was added to the class`SHCoeffs`

. - All methods in the pyshtools classes now return copies by default, which can be modified by the optional argument
`copy`

. - Added
`pot`

as a mandatory return argument for the Python routine`MakeGravGridDH`

. - Several minor modifications and bug fixes were made to the makefiles to improve compatibility and to allow the use of
`make -j`

. - The routines
`other.EigValSym`

,`other.EigValVecSym`

,`other.EigValVecSymTri`

,`other.RandomGaussian`

,`other.RandomN`

and`other.PreGLQ`

were removed from pyshtools, as these can be found in other scipy packages. - The SHTOOLS routine
`DHaj`

was added to the pyshtools subpackage`utils`

. - Python docstrings have been streamlined and standardized.
- …plus, many minor changes and optimizations…

**Citation:**

M. A. Wieczorek, M. Meschede, I. Oshchepkov, E. Sales de Andrade, and heroxbd (2016). SHTOOLS: Version 4.0. Zenodo. doi:10.5281/zenodo.206114

Edit me