Development Priorities

On this page, current known issues and technical debt will be recorded. These issues would make good first contributions for new contributors to the project. You can also take a look at the issues page for more.

Make sure to check an item off the list if you have completed it.

Code debt

  • Ensemble.mix_mod_fit - a docstring exists but the function is not implemented. Either remove completely or implement.

  • The ‘sparse’ conversion method for qp.interp_irregular does not seem to be functional to convert any type of input Ensemble to the irregular interpolation parameterization.

  • The qp.mixmod parameterization is not completely functional. rvs() method does not work on mixmod. The reason seems to be that mixmod’s _ppf() method does not allow CASE_2D inputs

  • add_reader_method is an option within a parameterization class to add a function that will be called when reading in an Ensemble of that type. It is supported by qp.read() in factory.py, but other functions that read data in (like qp.iterator() or qp.read_dict()) do not call this reader method, so if someone were to use add_reader_method it would likely result in bugs at the moment. Support needs to be added to the other read functions, or the add_reader_method option could be removed.

Tests

  • Add specific tests for utility functions in the utils/ folder

  • Add specific tests for utility functions in hist_utils.py, interp_utils.py, quant_utils.py, and mixmod_utils.py

  • Add tests to check that errors are raised as expected

Documentation

  • Add details and examples of usage to docstrings for utility functions

  • Update legacy notebooks to work with existing code as makes sense