cloudmetrics - v0.3.0

Full Changelog

new features

• scalar field standard deviation metric, available as scalar.std #64 By Leif Denby (@leifdenby)

changed defaults

• open-sky metric calculation (mask.open_sky) now only returns max-value by default #65 Leif Denby (@leifdenby)

maintenance

• refactored cloudmetrics.mask.open_sky for better performance #72 Hauke Schulz (@observingClouds)
• removed caching of regionproperties for each image that is calculated, to prevent memory accumulation #73 Martin Janssens
• updated isort and removed nb-black to work with latest package versions #71 Martin Janssens
• handle fully cloudy scenes in open-sky metric (previously broke, now returns zero) #67 Leif Denby
• add zenodo DOI badge and citation information #66 Leif Denby (@leifdenby)
• fix ci/cd pre-commit setup by pinning to python 3.8 for linting step and remove unused conda environment #80 Leif Denby (@leifdenby)

- Python
Published by leifdenby over 2 years ago

cloudmetrics - v0.2.0

Full Changelog

First release of cloudmetrics package! All methods that operate on masks are available in cloudmetrics.mask (e.g. cloudmetrics.mask.fractal_dimension(mask)), those that operate on labelled-objects are in cloudmetrics.objects (e.g. cloudmetrics.objects.iorg(labelled_objects)) and can be used directly on masks with wrapped function calls in cloudmetrics.mask.{metric_name}_objects (e.g. cloudmetrics.mask.iorg_objects(mask)). Finally, all metrics that operate on scalar fields are in cloudmetrics.scalar (e.g. cloudmetrics.scalar.kurtosis(scalar_field, mask)).

new features

• Refactor iorg metric to use object-labels as argument (now available as cloudmetrics.mask.iorg_objects and cloudmetrics.objects.iorg) and combine methods using either a) inhibition nearest-neighbour or b) Poisson reference distribution into single function taking reference_dist as argument. #54 By Leif Denby (@leifdenby)

• Refactor SCAI metric (now available as cloudmetrics.objects.scai and cloudmetrics.mask.scai_objects) and add test which accounts for change in SCAI value with resolution #42 By Leif Denby & Martin Janssens (@leifdenby & @martinjanssens)

• Add metrics for statistical reductions of scalar fields (either globally or masked) available as cloudmetrics.scalar.mean, cloudmetrics.scalar.var, cloudmetrics.scalar.skew and cloudmetrics.scalar.kurtosis #46 By Leif Denby & Martin Janssens (@leifdenby & @martinjanssens)

• Refactored Convective Organisation Potential (COP) metric, now available in cloudmetrics.objects.cop and cloudmetrics.mask.cop_objects #41 By Leif Denby & Martin Janssens (@leifdenby & @martinjanssens)

• Refactored metrics into common api based on what input each operates on, so that metrics are now in submodules called cloudmetrics.mask, cloudmetrics.objects and cloudmetrics.scalar. #39. By Leif Denby (@leifdenby)

• Refactored cloud-object metrics that compute geometry metrics of labelled objects #23. By Leif Denby (@leifdenby)

• Change build setup to use setup.cfg and setup linting using pre-commit #38. By Leif Denby (@leifdenby)

• Refactored wavelet organisation indices, now available as woi1=cloudmetrics.woi1(...), woi2=cloudmetrics.woi2(...) and woi3=cloudmetrics.woi3(...) #32. By Leif Denby & Martin Janssens (@leifdenby & @martinjanssens)

• Refactored orientation metric calculation, now available as cloudmetrics.orientation(...) #24. By Leif Denby & Martin Janssens (@leifdenby & @martinjanssens)

• Refactored "open sky" (clear sky) metric calculation, now available as cloudmetrics.open_sky(...) #22. By Leif Denby & Martin Janssens (@leifdenby & @martinjanssens)

• Refactored iorg metric calculation, now available as cloudmetrics.iorg(...) #21. By Leif Denby & Martin Janssens (@leifdenby & @martinjanssens)

• Refactored spectral metric calculation, now available to calculate all spectral metrics as cloudmetrics.scalar.compute_all_spectral(...) #30, #36. By Leif Denby & Martin Janssens (@leifdenby & @martinjanssens)

• Add tests for producing spatially-continuous object masks and for computing nearest-neighbor distances on periodic domains #61. @leifdenby & @martinjanssens

maintenance

• set up package versioning with setuptools_scm and create v0.2.0 release #62 By @leifdenby

• update black version to address recent breaking change in black's dependency on click #59 By Leif Denby (@leifdenby)

• ci action to automatically deploy releases on github to pypi #53. By Leif Denby (@leifdenby)

• Code cleanup and setup of continuous integration testing #19, #55. By Leif Denby (@leifdenby)

- Python
Published by leifdenby over 3 years ago

cloudmetrics - GRL publication release

This tagged version comprises the routines used for computing organisation metrics as published in M. Janssens et al 2021 (https://agupubs.onlinelibrary.wiley.com/doi/full/10.1029/2020GL091001)

- Python
Published by leifdenby over 4 years ago