Release v3.3.0

[steven-murray]

Internals

• Refactored setting up of inputs to high-level functions so that there is less code
  repetition.

Fixed

• Running with R_BUBBLE_MAX too large auto-fixes it to be BOX_LEN ([BUG] Box fails for R_BUBBLE_MAX > BOX_LEN #112)
• Bug in calling clear_cache.
• Inconsistency in the way that the very highest redshift of an evolution is handled
  between low-level code (eg. spin_temperature()) and high-level code (eg. run_coeval()).

Added

• New validate_all_inputs function that cross-references the four main input structs
  and ensures all the parameters make sense together. Mostly for internal use.
• Ability to save/read directly from an open HDF5 File ([Feature Req.] More flexible data saving/loading #170)
• An implementation of cloud-in-cell to more accurately redistribute the perturbed mass
  across all neighbouring cells instead of the previous nearest cell approach
• Changed PhotonConsEndCalibz from z = 5 -> z = 3.5 to handle later reionisation
  scenarios in line with current observations ([BUG] Photon conservation seems unstable when using a pre-calibration late EoR #305)
• Add in an initialisation check for the photon conservation to address some issues
  arising for early EOR histories (Segmentation Fault when using photon conservation #311)
• Added NON_CUBIC_FACTOR to UserParams to allow for non-cubic coeval boxes (Non cubic #289)

[codecov]

Codecov Report

Patch coverage: 93.65% and project coverage change: +0.27 🎉

Comparison is base (e271292) 86.33% compared to head (847f43d) 86.60%.

Additional details and impacted files

@@              Coverage Diff               @@
##           production     #327      +/-   ##
==============================================
+ Coverage       86.33%   86.60%   +0.27%     
==============================================
  Files              12       12              
  Lines            2780     2814      +34     
==============================================
+ Hits             2400     2437      +37     
+ Misses            380      377       -3     

Impacted Files	Coverage Δ
src/py21cmfast/_cfg.py	96.87% <ø> (ø)
src/py21cmfast/inputs.py	91.62% <87.75%> (+1.73%)	⬆️
src/py21cmfast/wrapper.py	88.77% <94.23%> (-0.24%)	⬇️
src/py21cmfast/_utils.py	88.90% <95.00%> (+0.82%)	⬆️
src/py21cmfast/cache_tools.py	96.72% <100.00%> (-1.59%)	⬇️
src/py21cmfast/outputs.py	92.12% <100.00%> (-0.02%)	⬇️

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.