Changelog¶

0.4.10¶

Add cached-property as a dependency
Rename AtmosFlow to AtmoSim and create a base class AtmoSimBase
Add extract() method to AtmoSimBase
Add pressure coordinate to DimConstr
Refactor Run and prepare for its deprecation
Add load_data() to io
Move add_planet_conf_to_cubes() to the const module
Deprecate ScalarCube
Add new variable names to um
Refactor derived constants and add planet_rotation_rate to the recipes
Add an option not to broadcast the coordinate to the cube’s shape in coord_to_cube()
Make spatial(), time_mean() and vertical_mean() return the input cube in case of CoordinateCollapseError
Add abs_coord_mean() to average data over latitudes symmetric around the equator
Add functions to calculate meridional and zonal streamfunctions
Improve docstrings
Add an example notebook for working with model names

Move to conda-forge for building the package
Replace TravisCI with GitHub Actions
Restructure the package:
- the library is now in src/aeolus
- tests are now in tests/
Core classes:
- Add AtmosFlow
New calc functions:
- Add a decorator to update cube metadata, update_metadata()
- Add shortcut functions spatial_mean() and time_mean()
- Add air_potential_temperature()
- Add functions to rotate and regrid variables to “tidally-locked” coordinates
- Add wind_speed()
New coord functions:
- Add functions to interpolate cubes to pressure levels (depend on python-stratify package)
- Add a function to interpolate one cube to another along the time dimension (interp_to_cube_time)
- Add a container to store common coordinates
- Add check_coords(), get_xy_coords()
New subset functions:
- Add a function to filter out duplicated cubes from a cubelist: unique_cubes()
Other changes:
- Append names to model.um
- Add a function to load vertical levels data
- Improve interp_to_pres_lev()
- Add model keyword to plot.pv functions
- Rewrite DimConstr API

New calc functions:
- Add convenience functions to calculus for doing simple derivatives
- Add a function to calculate horizontal divergence in spherical coordinates
- Add air_density(), air_temperature(), dry_lapse_rate(), flux() and geopotential_height functions
- Add horiz_wind_cmpnts() helper function
- Add normalize_cube()
- Add superrotation_index()
New coord functions:
- Add a function to emulate xarray’s isel() method.
- Update get_cube_datetimes() and add a new function, get_cube_rel_days()
- Add a function to broadcast coordinate deltas to a cube.
- Add a function to calculate volume from a cube’s grid.
Other changes:
- Append names to model.um
- Refactor surface and TOA energy balance calculation, and do not apply spatial averaging to P-E
- Override __repr__ of model.base.Model

API changes:
- add model submodule for model-specific variable and coordinate names
- replace all UM_* variables with the model reference
- replace all DIM_CONSTR_* by a class DimConstr with each of the constraints as an attribute
- replace coord.add_binned_lon_lat() by a generic coord.add_binned_coord() function
Minor bug fixes and clean-up

Add Python 3.8 to build matrix
API changes: merge grid into coord; move misc flux calculations to calc submodule, remove util folder by moving text to plot.
Add a function to attach non-Earth auxiliary time coordinates to a cube
Add Titan constants (some orbital parameters are those for Saturn for simplicity)
Fix a typo in Earth constants
Add a new function for matplotlib plots: plot.add_custom_legend()
Minor fixes in the travis integration