obsarray 0.2.3__tar.gz → 0.2.5__tar.gz

{obsarray-0.2.3 → obsarray-0.2.5}/.gitignore

@@ -76,8 +76,8 @@ instance/
 .scrapy
 
 # Sphinx documentation
-docs/sphinx/_build/
-docs/sphinx/content/api
+docs/_build/
+docs/content/generated/
 
 # PyBuilder
 target/

{obsarray-0.2.3/obsarray.egg-info → obsarray-0.2.5}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: obsarray
-Version: 0.2.3
-Summary: Measurement uncertainty handling in Python
+Version: 0.2.5
+Summary: Measurement data handling in Python
 Home-page: https://github.com/comet-toolkit/obsarray
 Author: CoMet Toolkit Team
 Author-email: team@comet-toolkit.org
@@ -9,14 +9,19 @@ License: GPLv3
 Platform: UNKNOWN
 Classifier: Development Status :: 2 - Pre-Alpha
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
 Provides-Extra: dev
 License-File: LICENSE
 
 # obsarray: Measurement uncertainty handling in Python
 
+[![Build Status](https://app.travis-ci.com/comet-toolkit/obsarray.svg?branch=main)](https://app.travis-ci.com/comet-toolkit/obsarray)
+[![codecov](https://codecov.io/gh/comet-toolkit/obsarray/branch/main/graph/badge.svg?token=PZTGG03VQY)](https://codecov.io/gh/comet-toolkit/obsarray)
+[![Documentation Status](https://readthedocs.org/projects/obsarray/badge/?version=latest)](https://obsarray.readthedocs.io/en/latest/?badge=latest)
+
 **obsarray** is an extension to [xarray](https://docs.xarray.dev/en/stable/) for defining, storing and interfacing with uncertainty information using standardised metadata. It is particularly designed to work well with [netCDF](https://www.unidata.ucar.edu/software/netcdf/) files and for the Earth Observation community.
 
 obsarray is part of the [CoMet Toolkit](https://www.comet-toolkit.org) (community metrology toolkit), and can combined with the [punpy](https://punpy.readthedocs.io/en/latest/) (propagating uncertainties in python) module for very simple propagation of defined data uncertainties through arbitrary python functions.

{obsarray-0.2.3 → obsarray-0.2.5}/README.md

@@ -1,5 +1,9 @@
 # obsarray: Measurement uncertainty handling in Python
 
+[![Build Status](https://app.travis-ci.com/comet-toolkit/obsarray.svg?branch=main)](https://app.travis-ci.com/comet-toolkit/obsarray)
+[![codecov](https://codecov.io/gh/comet-toolkit/obsarray/branch/main/graph/badge.svg?token=PZTGG03VQY)](https://codecov.io/gh/comet-toolkit/obsarray)
+[![Documentation Status](https://readthedocs.org/projects/obsarray/badge/?version=latest)](https://obsarray.readthedocs.io/en/latest/?badge=latest)
+
 **obsarray** is an extension to [xarray](https://docs.xarray.dev/en/stable/) for defining, storing and interfacing with uncertainty information using standardised metadata. It is particularly designed to work well with [netCDF](https://www.unidata.ucar.edu/software/netcdf/) files and for the Earth Observation community.
 
 obsarray is part of the [CoMet Toolkit](https://www.comet-toolkit.org) (community metrology toolkit), and can combined with the [punpy](https://punpy.readthedocs.io/en/latest/) (propagating uncertainties in python) module for very simple propagation of defined data uncertainties through arbitrary python functions.

obsarray-0.2.5/docs/conf.py

@@ -0,0 +1,181 @@
+#!/usr/bin/env python
+#
+# obsarray documentation build configuration file, created by
+# cookiecutter
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+
+# If extensions (or modules to document with autodoc) are in another
+# directory, add these directories to sys.path here. If the directory is
+# relative to the documentation root, use os.path.abspath to make it
+# absolute, like shown here.
+
+import sphinx_autosummary_accessors
+import obsarray
+
+project_title = "obsarray".replace("_", " ").title()
+
+
+# -- General configuration ---------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Attempt to make links automatially
+default_role = "code"
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+# CFAB added napolean to support google-style docstrings
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.napoleon",
+    "IPython.sphinxext.ipython_directive",
+    "IPython.sphinxext.ipython_console_highlighting",
+    "sphinx_design",
+    "sphinx_autosummary_accessors",
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates", sphinx_autosummary_accessors.templates_path]
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = ".rst"
+
+# The master toctree document.
+master_doc = "index"
+
+# General information about the project.
+project = project_title
+copyright = "CoMet Toolkit Team"
+author = "CoMet Toolkit Team"
+
+# The version info for the project you're documenting, acts as replacement
+# for |version| and |release|, also used in various other places throughout
+# the built documents.
+#
+# The short X.Y version.
+version = obsarray.__version__
+# The full version, including alpha/beta/rc tags.
+release = obsarray.__version__
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = "sphinx"
+
+rst_prolog = """
+.. role:: python(code)
+    :language: python
+    :class: highlight
+"""
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output -------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "sphinx_book_theme"
+
+# Theme options are theme-specific and customize the look and feel of a
+# theme further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+html_logo = "figs/comet_logo.png"
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ["_static"]
+
+# -- Options for HTMLHelp output ---------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = "obsarraydoc"
+
+
+# -- Options for LaTeX output ------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass
+# [howto, manual, or own class]).
+latex_documents = [
+    (
+        master_doc,
+        "user_manual.tex",
+        "{} Documentation".format(project_title),
+        "CoMet Toolkit Team",
+        "manual",
+    ),
+]
+
+
+# -- Options for manual page output ------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [(master_doc, "obsarray", "obsarray Documentation", [author], 1)]
+
+
+# -- Options for Texinfo output ----------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (
+        master_doc,
+        "obsarray",
+        "obsarray Documentation",
+        author,
+        "obsarray",
+        "Extension to xarray for handling uncertainty quantified observation data",
+        "Miscellaneous",
+    ),
+]

obsarray-0.2.5/docs/index.rst

@@ -0,0 +1,66 @@
+obsarray: Measurement data handling in Python
+=============================================
+
+**obsarray** is an extension to `xarray <https://docs.xarray.dev/en/stable/>`_ to support defining, storing and interfacing with measurement data - in particular, measurement uncertainty information using standardised metadata. It is designed to work well with `netCDF <https://www.unidata.ucar.edu/software/netcdf/>`_ files and for the Earth Observation community.
+
+**obsarray** is part of the `CoMet Toolkit <https://www.comet-toolkit.org>`_ (community metrology toolkit), and can combined with the  `punpy <https://punpy.readthedocs.io/en/latest/>`_ (propagating uncertainties in python) module for very simple propagation of defined data uncertainties through arbitrary python functions.
+
+.. grid:: 2
+    :gutter: 2
+
+    .. grid-item-card::  Quickstart Guide
+        :link: content/user/quickstart
+        :link-type: doc
+
+        New to *obsarray*? Check out the quickstart guide for an introduction.
+
+    .. grid-item-card::  User Guide
+        :link: content/user/user_guide
+        :link-type: doc
+
+        The user guide provides a documentation and examples how to use **obsarray** to handle measurement data.
+
+    .. grid-item-card::  API Reference
+        :link: content/user/api
+        :link-type: doc
+
+        The API Reference contains a description the **obsarray** API.
+
+    .. grid-item-card::  Developer Guide
+        :link: content/developer/developer_guide
+        :link-type: doc
+
+        Guide for contributing to **obsarray** (under development).
+
+
+Acknowledgements
+----------------
+
+obsarray has been developed by `Sam Hunt <https://github.com/shunt16>`_.
+
+The development has been funded by:
+
+* The UK's Department for Business, Energy and Industrial Strategy's (BEIS) National Measurement System (NMS) programme
+* The IDEAS-QA4EO project funded by the European Space Agency.
+
+
+Project status
+--------------
+
+obsarray is under active development. It is beta software.
+
+.. toctree::
+   :maxdepth: 2
+   :hidden:
+   :caption: For users
+
+   Quickstart <content/user/quickstart>
+   User Guide <content/user/user_guide>
+   API Reference <content/user/api>
+
+.. toctree::
+   :maxdepth: 2
+   :hidden:
+   :caption: For developers/contributors
+
+   Developer Guide <content/developer/developer_guide>

{obsarray-0.2.3 → obsarray-0.2.5}/obsarray/__init__.py

@@ -4,7 +4,7 @@ __author__ = "Sam Hunt <sam.hunt@npl.co.uk>"
 __all__ = []
 
 from ._version import get_versions
-from obsarray import unc_accessor
+from obsarray import unc_accessor, flag_accessor
 from obsarray.err_corr import err_corr_forms
 from obsarray.templater.template_util import create_ds
 from obsarray.templater.dstemplater import DSTemplater

{obsarray-0.2.3 → obsarray-0.2.5}/obsarray/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2022-11-29T10:52:47+0000",
+ "date": "2024-02-14T16:24:15+0000",
  "dirty": false,
  "error": null,
- "full-revisionid": "0e0f8deef5ce684330dce3414fda5a19c9916eb7",
- "version": "v0.2.3"
+ "full-revisionid": "a4c0efeceef26dd8201830bc88caab5689f25595",
+ "version": "v0.2.5"
 }
 '''  # END VERSION_JSON