gboehl / econsieve Goto Github PK

Not a priority now, can discuss which a re more desireable:

• unit tests
• requirements.txt
• tests run on Github Actions
• black/isort
• type annotations and mypy/pyright for type stability
• docs show package API

One point to explore API is looking at __init__.py - my suggestion is to make explicict what is being imported from the package.

For example:

from kalman_filter import  *

can be (if reshape_z() is needed for end user):

from kalman_filter import KalmanFilter, reshape_z 

This should help to choose what needs to be documented.

It was intended as a stand-alone package, but currently I am only using the package in conjunction with pydsge, though this is not strictly necessary.

@gboehl - can you think of a minimal code (outside pydsge) that allows demonstarte usage of econsieve? Thank should help guide refatoring of README on next step. Many thanks!