SHTOOLS/SHTOOLS: Version 4.7
Creators
- 1. Laboratoire Lagrange - Observatoire de la Côte d'Azur
- 2. Center of Geodesy, Cartography and SDI (TsNIIGAiK)
- 3. Universität Bonn
- 4. University of Tokyo
- 5. @gitlabhq
Description
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()
andwrite_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
andSHGravCoeffs
methodsto_file()
andfrom_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()
, andread_icgem_gfc()
- Fixed a minor bug where netcdf files would not accept boolean attributes.
- Added the methods
admittance()
,correlation()
andadmitcorr()
for the classesSHCoeffs
,SHGravCoeffs
, andSHMagCoeffs
to compute the admittance and/or correlation with another function. - Added the methods
plot_admittance()
,plot_correlation()
andplot_admitcorr()
to easily plot these functions.
- 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
andcb_triangles
.
- Added the option to include error coefficients in the class
SHCoeffs
. - Added the boolean option
errors
to the methodto_array()
in order to control whether the error coefficients are returned with the function spherical harmonic coefficients. - Added the option
legend_error
to theSHCoeffs
,SHMagCoeffs
andSHGravCoeffs
methodplot_spectrum()
to provide a customized legend entry for the error spectrum.
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
toSHGravCoeffs
,SHGravGrid
,SHGeoid
andSHTensor
. - Added the attribute
year
toSHMagCoeffs
,SHMagGrid
, andSHTensor
.
- 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 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- Add option
empty
to return an empty gird when initializing anSHgrid
withfrom_zeros()
. - Add method
from_ellipsoid()
toSHGrid
to initial a class instance with a triaxial ellipsoid. - Added error checks to the pyshtools function
YilmIndexVector
. - Renamed the
constant
module toconstants
, and reogranized the constants in a more logical way (i.e.,constants.Mars.r
instead ofconstants.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 setISREALESED
to True or False). Versioneer gets the version number automatically from git tags. - Update fortran 95 source files to be consistent with the documentation and
SHTOOLS.f95
interface block. In particular, several variable names ofc
andsh
were renamed tocilm
.
Files
SHTOOLS/SHTOOLS-4.7.zip
Files
(36.0 MB)
Name | Size | Download all |
---|---|---|
md5:8a9fd85c59d064b452d6ad1054278748
|
36.0 MB | Preview Download |
Additional details
Related works
- Is supplement to
- https://github.com/SHTOOLS/SHTOOLS/tree/4.7 (URL)