@MarkWieczorek MarkWieczorek released this Aug 17, 2018

Assets 2

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.


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.1345510

@MarkWieczorek MarkWieczorek released this May 20, 2018 · 75 commits to master since this release

Assets 2

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 grids 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.

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

Dec 25, 2017
Version 4.1.3
Dec 4, 2017
Version 4.1.2
Nov 28, 2017
Version 4.1.1

@MarkWieczorek MarkWieczorek released this Nov 27, 2017 · 221 commits to master since this release

Assets 2

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 theSHWindow 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.

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

@MarkWieczorek MarkWieczorek released this Dec 16, 2016 · 259 commits to master since this release

Assets 2

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...

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

@MarkWieczorek MarkWieczorek released this Aug 30, 2016 · 404 commits to master since this release

Assets 2

This release adds missing functionality to the SHGrids, SHCoeffs, and SHWindow classes, and adds support for PyPI.

  • Add pyshtools to PyPI repository. Can now be installed using pip install pyshtools.
  • Add new function SHBiasKMask which is the arbitrary window counterpart to the spherical cap window SHBiasK.
  • Add get_biasedpowerspectrum() method to SHWindows for arbitrary windows.
  • Add copy() method to all classes, which returns a deep copy of the instance.
  • Add __sub__, __add__, __rsub__, __radd__, __mul__, __div__, __truediv__, and __pow__ operators for two sets of coefficient or grid classes, or one coefficient or grid class and a scalar.
  • Add nwinrot option when rotating spherical cap windows in SHWindow that will rotate only the first nwinrot windows.
  • Add degrees option to get_lats() and get_lons() methods.
  • Add the constructor from_file() to initialize an SHGrid with a numpy formatted data file. Add option to read coeffs and grids from a numpy formatted binary file. Addtofile() methods to output raw grid and coefficient data as either text or binary formatted files.
  • Update Intro 1 notebook and add example to Intro notebook 2 showing how to use arbitrary localization windows.
  • Convert notebooks to html and add links to web documentation.
  • Add option fixed_power to SHCoeffs.from_random() method to generate random coefficients that fit exactly the expected power spectrum.
  • Add Earth topography coefficients referenced to mean sea level to the example files, expanded to degree 300: srtmp300.msl.

M. A. Wieczorek, M. Meschede, I. Oshchepkov, E. Sales de Andrade (2016). SHTOOLS: Version 3.4. Zenodo. doi:10.5281/zenodo.61180

@MarkWieczorek MarkWieczorek released this Aug 11, 2016 · 462 commits to master since this release

Assets 2

This is a major upgrade to SHTOOLS. Full support for Python 3 has been added, a setup.py file has been added for easy installation, Python notebook tutorials have been created, and full support for three major Python classes has been provided (SHCoeffs, SHGrid and SHWindow). One bug in the Fortran code has been fixed, as well as several minor issues with the Python wrapper functions.

  • Added full support for Python 3.
  • Fixed a critical, but rare, bug in MakeGridDH, MakeGravGridDH, MakeMagGridDH, and MakeGravGradGridDH. In these routines, the rows of the output grid are calculated by inverse Fourier transmforming a vector that depends upon the spherical harmonic coefficients. This vector, when using the complex-to-real FFTW routines, includes one element that corresponds to the coefficients with m=lmax+1. This element of the array was not properly initialized to zero in the Fortran code, and if the Fortran compiler did not explicitly zero all new arrays, this could have resulted in incorrect output. Given that this term is 1 index above the Nyquist frequency (m=lmax), if this element were not zero, each column of the grid would contain a component that oscillates from -1 to +1 (scaled by the magnitude of the element). Even when this element was not initialized, a subsequent spherical harmonic expansion of the grid would usually give correct results.
  • Added a setup.py file for easy installation.
  • Makefiles were extensively modified to simplify the Fortran and Python builds: make all2 and make all3 were removed and replaced by flags that make use of the precompiler to resolve underscore problems; make install now places compiled module files in /usr/local/includes.
  • Makefiles were improved to minimize problems when installing both fortran and fortran-mp components. When making the latter, all object and module files in the directory src are first deleted.
  • The namespace of pyshtools was reorganized to list the routines by submodule name. A list of all routines is given in the submodule shtools.
  • Add full support for the Python classes SHCoeffs, SHGrid, and SHWindow.
  • Added an info() method to shtools constants that prints an info string.
  • Changed the Python wrapper so that the output arrays in the SHExpand routines correspond to the optional input variablelmax_calc. Modified the dimensions by 1 for the output power spectrum in the wrapper functions for SHBias and SHBiasK.
  • Changed the primary input parameter of SHMTCouplingMatrix to be a matrix of power spectra of the localization windows instead of a matrix of spherical-harmonic coefficients of spherical-cap localization windows. Furthermore, the output dimensions of the matrix have been switched.
  • Added two fortran routines for performing multitaper spectral analyses when using windows generated from a mask, SHMultiTaperMaskSE and SHMultiTaperCSE.
  • Minor modifications to the Python example scripts.
  • Minor bug fix to the scripts that create the unix man documentation.
  • Added Python notebook tutorials.
  • Created an SHTOOLS development fund, funded by bitcoin donations.

Mark Wieczorek et al. (2016). SHTOOLS: Version 3.3. Zenodo. doi:10.5281/zenodo.60010

@MarkWieczorek MarkWieczorek released this Jun 17, 2016 · 652 commits to master since this release

Assets 2

Version 3.2 release notes

This release contains the following improvements:

  • Added the optional argument centralmeridian to Curve2Mask that accounts for cases where the curve makes a complete circle in longitude about the planet.
  • Fixed in bug in the python implementation where the outputs error and corr of SHAdmitCorr were switched.
  • Added OpenMP support. When compiling with make fortran-mp,make fortran2-mp, or make fortran3-mp, saved variables in the subroutines are defined as being threadprivate.
  • Optimized performance of the routines SHMultiTaperSE, SHMultiTaperCSE, and SHLocalizedAdmitCorr.
  • Minor documentation fixes.

Mark Wieczorek et al.. (2016). SHTOOLS: Version 3.2. Zenodo. doi:10.5281/zenodo.55790