Quality control routines for CloudnetPy products

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for cloudnet from gravatar.com cloudnet Avatar for siiptuo from gravatar.com siiptuo Avatar for tukiains from gravatar.com tukiains

Unverified details

These details have not been verified by PyPI
Project links
GitHub Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Meta

License: MIT License (MIT License Copyright (c) 2021-2022 Finnish Meteorological Institute Permission is hereby granted,...)

Author: Finnish Meteorological Institute

Requires: Python >=3.10

Classifiers

Project description

CloudnetPy-QC

CloudnetPy-QC CI PyPI version

Software for evaluating quality of ACTRIS-Cloudnet data products.

Installation

$ pip3 install cloudnetpy-qc

Usage

import json
from cloudnetpy_qc import quality
report = quality.run_tests('cloudnet-file.nc')
json_object = json.dumps(report.to_dict(), indent=2)
print(json_object)

Format of the report

  • timestamp: UTC timestamp of the test
  • qcVersion: cloudnetpy-qc version
  • tests: Test[]

Test

  • testId: Unique name of the test
  • exceptions: Exception[]

Exception

  • message: Free-form message about the exception
  • result: "info", "error" or "warning"

Example:

{
  "timestamp": "2022-10-13T07:00:26.906815Z",
  "qcVersion": "1.1.2",
  "tests": [
    {
      "testId": "TestUnits",
      "exceptions": []
    },
    {
      "testId": "TestInstrumentPid",
      "exceptions": [
        {
          "message": "Instrument PID is missing.",
          "result": "warning"
        }
      ]
    },
    {
      "testId": "TestTimeVector",
      "exceptions": []
    },
    {
      "testId": "TestVariableNames",
      "exceptions": []
    },
    {
      "testId": "TestCFConvention",
      "exceptions": []
    }
  ]
}

Tests

Test Description
FindAttributeOutliers Find suspicious values in global attributes.
FindFolding Test for radar folding.
FindVariableOutliers Find suspicious data values.
TestCFConvention Test compliance with the CF metadata conventions.
TestDataCoverage Test that file contains enough data.
TestDataTypes Check that variables have expected data types.
TestFillValue Test that fill value is explicitly set for variables with missing data.
TestFloatingPointValues Test for special floating-point values which may indicate problems with the processing.
TestGlobalAttributes Check that file contains required global attributes.
TestIfRangeCorrected Test that beta is range corrected.
TestInstrumentPid Test that valid instrument PID exists.
TestLDR Test that LDR values are proper.
TestLidarBeta Test that one beta variable exists.
TestLongNames Check that variables have expected long names.
TestMask Test that data are not completely masked.
TestMedianLwp Test that LWP data are valid.
TestModelData Test that model data are valid.
TestStandardNames Check that variable have expected standard names.
TestTimeVector Test that time vector is continuous.
TestUnits Check that variables have expected units.
TestVariableNames Check that file contains required variables.
TestVariableNamesDefined Check that variables have expected names.

License

MIT

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for cloudnet from gravatar.com cloudnet Avatar for siiptuo from gravatar.com siiptuo Avatar for tukiains from gravatar.com tukiains

Unverified details

These details have not been verified by PyPI
Project links
GitHub Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Meta

License: MIT License (MIT License Copyright (c) 2021-2022 Finnish Meteorological Institute Permission is hereby granted,...)

Author: Finnish Meteorological Institute

Requires: Python >=3.10

Classifiers

Release history Release notifications | RSS feed

This version

1.17.5

1.17.4

1.17.3

1.17.2

1.17.1

1.17.0

1.16.3

1.16.2

1.16.1

1.16.0

1.15.8

1.15.7

1.15.6

1.15.5

1.15.4

1.15.3

1.15.2

1.15.1

1.15.0

1.14.6

1.14.5

1.14.4

1.14.3

1.14.2

1.14.1

1.14.0

1.13.8

1.13.7

1.13.6

1.13.5

1.13.4

1.13.3

1.13.2

1.13.1

1.13.0

1.12.1

1.12.0

1.11.2

1.11.1

1.11.0

1.10.8

1.10.7

1.10.6

1.10.5

1.10.4

1.10.3

1.10.2

1.10.1

1.10.0

1.9.5

1.9.4

1.9.3

1.9.2

1.9.1

1.9.0

1.8.1

1.8.0

1.7.2

1.7.1

1.7.0

1.6.1

1.6.0

1.5.2

1.5.1

1.5.0

1.4.2

1.4.1

1.4.0

1.3.2

1.3.1

1.3.0

1.2.1

1.2.0

1.1.2

1.1.1

1.1.0

1.0.8

1.0.7

1.0.6

1.0.5

1.0.4

1.0.3

1.0.2

1.0.1

1.0.0

0.2.0

0.1.12

0.1.11

0.1.10

0.1.9

0.1.8

0.1.7

0.1.6

0.1.5

0.1.4

0.1.3

0.1.2

0.1.1

0.1.0

0.0.19

0.0.18

0.0.17

0.0.16

0.0.15

0.0.14

0.0.13

0.0.12

0.0.11

0.0.10

0.0.9

0.0.8

0.0.7

0.0.6

0.0.5

0.0.4

0.0.3

0.0.2

0.0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cloudnetpy_qc-1.17.5.tar.gz (324.7 kB view hashes)

Uploaded Source

Built Distribution

cloudnetpy_qc-1.17.5-py3-none-any.whl (327.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page