Merge pull request #7 from comet-toolkit/flag_accessor

Flag accessor

Author: pdevis

docs/conf.py

@@ -22,13 +22,13 @@
 #
 import obsarray
 
-sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath(".."))
 
 project_title = "obsarray".replace("_", " ").title()
 
 # -- General configuration ---------------------------------------------
 
-latex_toplevel_sectioning = 'section'
+latex_toplevel_sectioning = "section"
 
 # If your documentation needs a minimal Sphinx version, state it here.
 #
@@ -41,22 +41,22 @@
 # 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.viewcode',
-    'sphinx.ext.napoleon',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.napoleon",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
 project = project_title
@@ -82,10 +82,10 @@
 # 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']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
@@ -96,7 +96,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme'
+html_theme = "sphinx_rtd_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
@@ -107,13 +107,13 @@
 # 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']
+html_static_path = ["_static"]
 
 
 # -- Options for HTMLHelp output ---------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'obsarraydoc'
+htmlhelp_basename = "obsarraydoc"
 
 
 # -- Options for LaTeX output ------------------------------------------
@@ -122,15 +122,12 @@
     # 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',
@@ -140,21 +137,21 @@
 # (source start file, target name, title, author, documentclass
 # [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'user_manual.tex',
-     '{} Documentation'.format(project_title),
-     'Sam Hunt', 'manual'),
+    (
+        master_doc,
+        "user_manual.tex",
+        "{} Documentation".format(project_title),
+        "Sam Hunt",
+        "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)
-]
+man_pages = [(master_doc, "obsarray", "obsarray Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output ----------------------------------------
@@ -163,12 +160,15 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'obsarray',
-     'obsarray Documentation',
-     author,
-     'obsarray',
-     'Propagating UNcertainties in PYthon',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "obsarray",
+        "obsarray Documentation",
+        author,
+        "obsarray",
+        "Propagating UNcertainties in PYthon",
+        "Miscellaneous",
+    ),
 ]
 
 """
@@ -361,4 +361,4 @@ def setup(app):
         "Miscellaneous",
     ),
 ]
-"""
+"""

docs/content/user/flag_accessor.rst

@@ -0,0 +1,35 @@
+Interfacing with Flag Information
++++++++++++++++++++++++++++++++++
+
+obsarray enables users to define, store and interface with flag variables in :py:class:`xarray.Dataset`'s following the `CF Convention <https://cfconventions.org/Data/cf-conventions/cf-conventions-1.10/cf-conventions.html#flags>`_ metadata standard.
+
+To access the information from a particular flag variable, use the dataset's ``flag`` accessor as follows,
+
+.. code-block:: python
+
+    import xarray as xr
+    import obsarray
+
+    ds = xr.open_dataset("measurement_data.nc")
+    print(ds.flag["flag_var"])
+
+This lists the flags for that variable. To access the flag values for a particular flag variable,
+
+.. code-block:: python
+
+    ds.flag["flag_var"]["flag_1"].value         # get flag mask
+    ds.flag["flag_var"]["flag_1"][:, 0] = True  # set flag mask values
+
+
+
+You can add a flag variable in a similar way to adding a new variable to a dataset,
+
+.. code-block:: python
+
+    ds.flag["new_flag_var"] = (["dims"], {"flag_meanings": ["f1", "f2"]})
+
+or add a new flag to an existing flag variable,
+
+.. code-block:: python
+
+    ds.flag["new_flag_var"]["f3"] = False

docs/index.rst

@@ -27,6 +27,7 @@ obsarray is under active development. It is beta software.
     :caption: User Guide
 
     content/user/unc_accessor
+    content/user/flag_accessor
     content/user/templater
 
 .. toctree::

obsarray/__init__.py

@@ -4,7 +4,7 @@
 __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