Skip to content

0.1.0
Compare
Choose a tag to compare
@ThibHlln ThibHlln released this 07 Dec 16:36
· 47 commits to main since this release
v0.1.0
c4e235c
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

Released on 2021-12-07.

Functional changes

  • constrain temporal and spatial resolutions of components forming a model to be integer multiples of one another
    (#67)
  • enforce two-dimensional spatial domains for components
    (#69)
  • allow components to use/produce only parts of the standardised transfers through the framework interfaces
    (#76)

API changes

  • add units requirement for component parameters and constants
    (#21)
  • move Component and its subclasses from subpackage components to package root
    (#46)
  • rename component class attributes _flow_direction and _land_sea_mask in component definition to _requires_flow_direction and _requires_land_sea_mask, respectively
    (#46)
  • remove science components (Artemis and RFM) from framework
    (#45)
  • remove vertical dimension (i.e. altitude) in LatLonGrid,
    RotatedLatLonGrid, and BritishNationalGrid
    (#69)
  • replace State dunder methods __getitem__ and __setitem__ with get_timestep and set_timestep methods
    (#71)
  • include component inputs as arguments given to initialise method
    (#75)
  • revise/refine component inward and outward transfers
    (#76)

Bug fixes

  • fix dump file update bug due to missing 'divisions' dimension
    (#32)
  • fix model identifier renaming not propagating to its components' identifiers
    (#48)
  • fix impossibility to run Model using a Component on the BritishNationalGrid
    (#51)
  • fix failed aggregation of fields with no standard name in DataSet
    (#52)
  • apply land_sea_mask to underlying field of Grid to be used in remapping
    (#59)

Enhancements

  • add support for arrays for component parameters
    (#21)
  • add support for multiple divisions for component states
    (#39)
  • add support for customisable divisions for component states
    (#31)
  • add time slice for I/O operations (user customisable)
    (#42)
  • cache remapping weights at initialisation
    (#44)
  • add cell_area property to SpaceDomain that can be provided by the user or else automatically computed for Grid
    (#61)
  • add initialised_states property to Component to allow component contributors not to overwrite user-defined initial conditions
    (#75)
  • add shelf attribute to Component to allow the communication of data between component methods
    (#75)
  • add _inwards and _outwards component class attributes to allow contributors to declare what interface transfers their component use and produce, respectively
    (#76)

Dependencies

  • change dependency cf-python>=3.11.0
  • drop support for Python 3.6

Documentation

  • document 'divisions' for component states in preparation page
    (#35)
  • move API reference page to doc tree root
  • move science library page to doc tree root
  • add support page
  • add change log page
  • add logo for package
Assets 2