ruisdael-observatory / NCQC

NetCDF Quality Control Python library
GNU General Public License v3.0
0 stars 0 forks source link

review: play and explore #3

Open andrecastro0o opened 2 months ago

andrecastro0o commented 2 months ago

do it over a jupyter notebook in examples/

andrecastro0o commented 2 months ago

@mschleiss,

based on simple attempts to run the library (see examples/01-basic-example.ipynb) I am starting to feel that the user interface is a bit over engineered. It is difficult to use.

In order for configuration to be loaded successfully, it needs to specify dims, vars and global attrs. Specifying only one these will trow back an error.

andrecastro0o commented 2 months ago

Missing information:

Units for 'file_size'

Units for 'file_size' are not described in the README

        'gbl_attrs': {
            'title': {'existence_check': True},
            'file_size': {
               'lower_bound': 'int',
                'upper_bound': 'int'
            }

since the file_size_check() method uses Path(self.nc.filepath()).stat().st_size to calculate the file size, the unit will be bytes