obsarray 1.0__tar.gz → 1.0.1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {obsarray-1.0/obsarray.egg-info → obsarray-1.0.1}/PKG-INFO +12 -4
- {obsarray-1.0 → obsarray-1.0.1}/obsarray/_version.py +3 -3
- {obsarray-1.0 → obsarray-1.0.1/obsarray.egg-info}/PKG-INFO +12 -4
- obsarray-1.0.1/obsarray.egg-info/SOURCES.txt +30 -0
- {obsarray-1.0 → obsarray-1.0.1}/obsarray.egg-info/requires.txt +2 -2
- {obsarray-1.0 → obsarray-1.0.1}/setup.py +1 -1
- obsarray-1.0/.gitignore +0 -119
- obsarray-1.0/.pre-commit-config.yaml +0 -5
- obsarray-1.0/docs/Makefile +0 -20
- obsarray-1.0/docs/conf.py +0 -181
- obsarray-1.0/docs/index.rst +0 -66
- obsarray-1.0/docs/make.bat +0 -36
- obsarray-1.0/obsarray/templater/template_util_jon.py +0 -206
- obsarray-1.0/obsarray.egg-info/SOURCES.txt +0 -68
- obsarray-1.0/quality_documentation/.gitignore +0 -295
- obsarray-1.0/quality_documentation/QualityDocumentation.tex +0 -122
- obsarray-1.0/quality_documentation/base/CookiecutterMacros.tex +0 -7
- obsarray-1.0/quality_documentation/base/acronyms.tex +0 -10
- obsarray-1.0/quality_documentation/base/history.tex +0 -10
- obsarray-1.0/quality_documentation/base/metadata.tex +0 -23
- obsarray-1.0/quality_documentation/base/pythoninputstyle.tex +0 -20
- obsarray-1.0/quality_documentation/base/sil2.tex +0 -11
- obsarray-1.0/quality_documentation/base/sil3.tex +0 -11
- obsarray-1.0/quality_documentation/base/sources.bib +0 -22
- obsarray-1.0/quality_documentation/base/sources.tex +0 -5
- obsarray-1.0/quality_documentation/countpdfpages.sh +0 -8
- obsarray-1.0/quality_documentation/footnotehyper-sphinx.sty +0 -269
- obsarray-1.0/quality_documentation/obsarray_QF-59.docm +0 -0
- obsarray-1.0/quality_documentation/obsarray_requirements.docx +0 -0
- obsarray-1.0/quality_documentation/review_checklists/qf-16a.docx +0 -0
- obsarray-1.0/quality_documentation/review_checklists/qf-16b.docx +0 -0
- obsarray-1.0/quality_documentation/review_checklists/qf-16c.docx +0 -0
- obsarray-1.0/quality_documentation/review_checklists/qf-16d.docx +0 -0
- obsarray-1.0/quality_documentation/review_checklists/qf-16e.docx +0 -0
- obsarray-1.0/quality_documentation/review_checklists/qf-16f.docx +0 -0
- obsarray-1.0/quality_documentation/softwareRequirements.sty +0 -153
- obsarray-1.0/quality_documentation/sphinx.sty +0 -1960
- obsarray-1.0/quality_documentation/sphinxcyrillic.sty +0 -55
- obsarray-1.0/quality_documentation/sphinxhighlight.sty +0 -105
- obsarray-1.0/quality_documentation/sphinxhowto.cls +0 -102
- obsarray-1.0/quality_documentation/sphinxmanual.cls +0 -128
- obsarray-1.0/quality_documentation/sphinxmessages.sty +0 -21
- obsarray-1.0/quality_documentation/sphinxmulticell.sty +0 -317
- obsarray-1.0/quality_documentation/uml/copy your design png file into this folder.txt +0 -1
- obsarray-1.0/tox.ini +0 -12
- {obsarray-1.0 → obsarray-1.0.1}/LICENSE +0 -0
- {obsarray-1.0 → obsarray-1.0.1}/MANIFEST.in +0 -0
- {obsarray-1.0 → obsarray-1.0.1}/README.md +0 -0
- {obsarray-1.0 → obsarray-1.0.1}/obsarray/__init__.py +0 -0
- {obsarray-1.0 → obsarray-1.0.1}/obsarray/err_corr.py +0 -0
- {obsarray-1.0 → obsarray-1.0.1}/obsarray/flag_accessor.py +0 -0
- {obsarray-1.0 → obsarray-1.0.1}/obsarray/templater/__init__.py +0 -0
- {obsarray-1.0 → obsarray-1.0.1}/obsarray/templater/dataset_util.py +0 -0
- {obsarray-1.0 → obsarray-1.0.1}/obsarray/templater/dstemplater.py +0 -0
- {obsarray-1.0 → obsarray-1.0.1}/obsarray/templater/dswriter.py +0 -0
- {obsarray-1.0 → obsarray-1.0.1}/obsarray/templater/template_util.py +0 -0
- {obsarray-1.0 → obsarray-1.0.1}/obsarray/templater/tests/__init__.py +0 -0
- {obsarray-1.0 → obsarray-1.0.1}/obsarray/templater/tests/test_dataset_util.py +0 -0
- {obsarray-1.0 → obsarray-1.0.1}/obsarray/templater/tests/test_dswriter.py +0 -0
- {obsarray-1.0 → obsarray-1.0.1}/obsarray/templater/tests/test_template_util.py +0 -0
- {obsarray-1.0 → obsarray-1.0.1}/obsarray/test/__init__.py +0 -0
- {obsarray-1.0 → obsarray-1.0.1}/obsarray/test/test_err_corr_forms.py +0 -0
- {obsarray-1.0 → obsarray-1.0.1}/obsarray/test/test_flag_accessor.py +0 -0
- {obsarray-1.0 → obsarray-1.0.1}/obsarray/test/test_unc_accessor.py +0 -0
- {obsarray-1.0 → obsarray-1.0.1}/obsarray/unc_accessor.py +0 -0
- {obsarray-1.0 → obsarray-1.0.1}/obsarray/utils.py +0 -0
- {obsarray-1.0 → obsarray-1.0.1}/obsarray.egg-info/dependency_links.txt +0 -0
- {obsarray-1.0 → obsarray-1.0.1}/obsarray.egg-info/top_level.txt +0 -0
- {obsarray-1.0 → obsarray-1.0.1}/setup.cfg +0 -0
- {obsarray-1.0 → obsarray-1.0.1}/versioneer.py +0 -0
|
@@ -1,20 +1,29 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: obsarray
|
|
3
|
-
Version: 1.0
|
|
3
|
+
Version: 1.0.1
|
|
4
4
|
Summary: Measurement data handling in Python
|
|
5
5
|
Home-page: https://github.com/comet-toolkit/obsarray
|
|
6
6
|
Author: CoMet Toolkit Team
|
|
7
7
|
Author-email: team@comet-toolkit.org
|
|
8
8
|
License: GPLv3
|
|
9
|
-
Platform: UNKNOWN
|
|
10
9
|
Classifier: Development Status :: 2 - Pre-Alpha
|
|
11
10
|
Classifier: Programming Language :: Python
|
|
12
11
|
Classifier: Programming Language :: Python :: 3.8
|
|
13
12
|
Classifier: Programming Language :: Python :: 3.9
|
|
14
13
|
Classifier: Programming Language :: Python :: 3.10
|
|
15
14
|
Classifier: Programming Language :: Python :: 3.11
|
|
16
|
-
Provides-Extra: dev
|
|
17
15
|
License-File: LICENSE
|
|
16
|
+
Requires-Dist: comet_maths
|
|
17
|
+
Requires-Dist: netcdf4==1.6.5
|
|
18
|
+
Requires-Dist: xarray
|
|
19
|
+
Provides-Extra: dev
|
|
20
|
+
Requires-Dist: pre-commit; extra == "dev"
|
|
21
|
+
Requires-Dist: tox; extra == "dev"
|
|
22
|
+
Requires-Dist: sphinx; extra == "dev"
|
|
23
|
+
Requires-Dist: sphinx_design; extra == "dev"
|
|
24
|
+
Requires-Dist: sphinx_book_theme; extra == "dev"
|
|
25
|
+
Requires-Dist: ipython; extra == "dev"
|
|
26
|
+
Requires-Dist: sphinx_autosummary_accessors; extra == "dev"
|
|
18
27
|
|
|
19
28
|
# obsarray: Measurement uncertainty handling in Python
|
|
20
29
|
|
|
@@ -51,4 +60,3 @@ The development has been funded by:
|
|
|
51
60
|
## Project status
|
|
52
61
|
|
|
53
62
|
obsarray is under active development. It is beta software.
|
|
54
|
-
|
|
@@ -8,11 +8,11 @@ import json
|
|
|
8
8
|
|
|
9
9
|
version_json = '''
|
|
10
10
|
{
|
|
11
|
-
"date": "2024-
|
|
11
|
+
"date": "2024-10-17T11:56:22+0100",
|
|
12
12
|
"dirty": false,
|
|
13
13
|
"error": null,
|
|
14
|
-
"full-revisionid": "
|
|
15
|
-
"version": "v1.0"
|
|
14
|
+
"full-revisionid": "e69e81f9deaa8c268e07f521788251875a87ef1a",
|
|
15
|
+
"version": "v1.0.1"
|
|
16
16
|
}
|
|
17
17
|
''' # END VERSION_JSON
|
|
18
18
|
|
|
@@ -1,20 +1,29 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: obsarray
|
|
3
|
-
Version: 1.0
|
|
3
|
+
Version: 1.0.1
|
|
4
4
|
Summary: Measurement data handling in Python
|
|
5
5
|
Home-page: https://github.com/comet-toolkit/obsarray
|
|
6
6
|
Author: CoMet Toolkit Team
|
|
7
7
|
Author-email: team@comet-toolkit.org
|
|
8
8
|
License: GPLv3
|
|
9
|
-
Platform: UNKNOWN
|
|
10
9
|
Classifier: Development Status :: 2 - Pre-Alpha
|
|
11
10
|
Classifier: Programming Language :: Python
|
|
12
11
|
Classifier: Programming Language :: Python :: 3.8
|
|
13
12
|
Classifier: Programming Language :: Python :: 3.9
|
|
14
13
|
Classifier: Programming Language :: Python :: 3.10
|
|
15
14
|
Classifier: Programming Language :: Python :: 3.11
|
|
16
|
-
Provides-Extra: dev
|
|
17
15
|
License-File: LICENSE
|
|
16
|
+
Requires-Dist: comet_maths
|
|
17
|
+
Requires-Dist: netcdf4==1.6.5
|
|
18
|
+
Requires-Dist: xarray
|
|
19
|
+
Provides-Extra: dev
|
|
20
|
+
Requires-Dist: pre-commit; extra == "dev"
|
|
21
|
+
Requires-Dist: tox; extra == "dev"
|
|
22
|
+
Requires-Dist: sphinx; extra == "dev"
|
|
23
|
+
Requires-Dist: sphinx_design; extra == "dev"
|
|
24
|
+
Requires-Dist: sphinx_book_theme; extra == "dev"
|
|
25
|
+
Requires-Dist: ipython; extra == "dev"
|
|
26
|
+
Requires-Dist: sphinx_autosummary_accessors; extra == "dev"
|
|
18
27
|
|
|
19
28
|
# obsarray: Measurement uncertainty handling in Python
|
|
20
29
|
|
|
@@ -51,4 +60,3 @@ The development has been funded by:
|
|
|
51
60
|
## Project status
|
|
52
61
|
|
|
53
62
|
obsarray is under active development. It is beta software.
|
|
54
|
-
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
LICENSE
|
|
2
|
+
MANIFEST.in
|
|
3
|
+
README.md
|
|
4
|
+
setup.cfg
|
|
5
|
+
setup.py
|
|
6
|
+
versioneer.py
|
|
7
|
+
obsarray/__init__.py
|
|
8
|
+
obsarray/_version.py
|
|
9
|
+
obsarray/err_corr.py
|
|
10
|
+
obsarray/flag_accessor.py
|
|
11
|
+
obsarray/unc_accessor.py
|
|
12
|
+
obsarray/utils.py
|
|
13
|
+
obsarray.egg-info/PKG-INFO
|
|
14
|
+
obsarray.egg-info/SOURCES.txt
|
|
15
|
+
obsarray.egg-info/dependency_links.txt
|
|
16
|
+
obsarray.egg-info/requires.txt
|
|
17
|
+
obsarray.egg-info/top_level.txt
|
|
18
|
+
obsarray/templater/__init__.py
|
|
19
|
+
obsarray/templater/dataset_util.py
|
|
20
|
+
obsarray/templater/dstemplater.py
|
|
21
|
+
obsarray/templater/dswriter.py
|
|
22
|
+
obsarray/templater/template_util.py
|
|
23
|
+
obsarray/templater/tests/__init__.py
|
|
24
|
+
obsarray/templater/tests/test_dataset_util.py
|
|
25
|
+
obsarray/templater/tests/test_dswriter.py
|
|
26
|
+
obsarray/templater/tests/test_template_util.py
|
|
27
|
+
obsarray/test/__init__.py
|
|
28
|
+
obsarray/test/test_err_corr_forms.py
|
|
29
|
+
obsarray/test/test_flag_accessor.py
|
|
30
|
+
obsarray/test/test_unc_accessor.py
|
|
@@ -25,7 +25,7 @@ setup(
|
|
|
25
25
|
description="Measurement data handling in Python",
|
|
26
26
|
long_description=read("README.md"),
|
|
27
27
|
packages=find_packages(exclude=("tests",)),
|
|
28
|
-
install_requires=["
|
|
28
|
+
install_requires=["comet_maths", "netcdf4==1.6.5", "xarray"],
|
|
29
29
|
extras_require={
|
|
30
30
|
"dev": [
|
|
31
31
|
"pre-commit",
|
obsarray-1.0/.gitignore
DELETED
|
@@ -1,119 +0,0 @@
|
|
|
1
|
-
# Mypy cache
|
|
2
|
-
.mypy_cache
|
|
3
|
-
|
|
4
|
-
# Compiles docs for gitlab pages
|
|
5
|
-
public
|
|
6
|
-
latex
|
|
7
|
-
|
|
8
|
-
# Visual studio / pycharm folders
|
|
9
|
-
.idea
|
|
10
|
-
.vscode
|
|
11
|
-
|
|
12
|
-
# Byte-compiled / optimized / DLL files
|
|
13
|
-
__pycache__/
|
|
14
|
-
*.py[cod]
|
|
15
|
-
*$py.class
|
|
16
|
-
|
|
17
|
-
# C extensions
|
|
18
|
-
*.so
|
|
19
|
-
|
|
20
|
-
# Distribution / packaging
|
|
21
|
-
.Python
|
|
22
|
-
env/
|
|
23
|
-
build/
|
|
24
|
-
develop-eggs/
|
|
25
|
-
dist/
|
|
26
|
-
downloads/
|
|
27
|
-
eggs/
|
|
28
|
-
.eggs/
|
|
29
|
-
lib/
|
|
30
|
-
lib64/
|
|
31
|
-
parts/
|
|
32
|
-
sdist/
|
|
33
|
-
var/
|
|
34
|
-
wheels/
|
|
35
|
-
*.egg-info/
|
|
36
|
-
.installed.cfg
|
|
37
|
-
*.egg
|
|
38
|
-
docs/_build
|
|
39
|
-
docs/content/api
|
|
40
|
-
|
|
41
|
-
# PyInstaller
|
|
42
|
-
# Usually these files are written by a python script from a template
|
|
43
|
-
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
|
44
|
-
*.manifest
|
|
45
|
-
*.spec
|
|
46
|
-
|
|
47
|
-
# Installer logs
|
|
48
|
-
pip-log.txt
|
|
49
|
-
pip-delete-this-directory.txt
|
|
50
|
-
|
|
51
|
-
# Unit test / coverage reports
|
|
52
|
-
htmlcov/
|
|
53
|
-
.tox/
|
|
54
|
-
.coverage
|
|
55
|
-
.coverage.*
|
|
56
|
-
.cache
|
|
57
|
-
nosetests.xml
|
|
58
|
-
coverage.xml
|
|
59
|
-
*.cover
|
|
60
|
-
.hypothesis/
|
|
61
|
-
.pytest_cache/
|
|
62
|
-
|
|
63
|
-
# Translations
|
|
64
|
-
*.mo
|
|
65
|
-
*.pot
|
|
66
|
-
|
|
67
|
-
# Django stuff:
|
|
68
|
-
*.log
|
|
69
|
-
local_settings.py
|
|
70
|
-
|
|
71
|
-
# Flask stuff:
|
|
72
|
-
instance/
|
|
73
|
-
.webassets-cache
|
|
74
|
-
|
|
75
|
-
# Scrapy stuff:
|
|
76
|
-
.scrapy
|
|
77
|
-
|
|
78
|
-
# Sphinx documentation
|
|
79
|
-
docs/_build/
|
|
80
|
-
docs/content/user/generated/
|
|
81
|
-
|
|
82
|
-
# PyBuilder
|
|
83
|
-
target/
|
|
84
|
-
|
|
85
|
-
# Jupyter Notebook
|
|
86
|
-
.ipynb_checkpoints
|
|
87
|
-
|
|
88
|
-
# pyenv
|
|
89
|
-
.python-version
|
|
90
|
-
|
|
91
|
-
# celery beat schedule file
|
|
92
|
-
celerybeat-schedule
|
|
93
|
-
|
|
94
|
-
# SageMath parsed files
|
|
95
|
-
*.sage.py
|
|
96
|
-
|
|
97
|
-
# dotenv
|
|
98
|
-
.env
|
|
99
|
-
|
|
100
|
-
# virtualenv
|
|
101
|
-
.venv
|
|
102
|
-
venv/
|
|
103
|
-
ENV/
|
|
104
|
-
|
|
105
|
-
# Spyder project settings
|
|
106
|
-
.spyderproject
|
|
107
|
-
.spyproject
|
|
108
|
-
|
|
109
|
-
# Rope project settings
|
|
110
|
-
.ropeproject
|
|
111
|
-
|
|
112
|
-
# mkdocs documentation
|
|
113
|
-
/site
|
|
114
|
-
|
|
115
|
-
# mypy
|
|
116
|
-
.mypy_cache/
|
|
117
|
-
|
|
118
|
-
# IDE settings
|
|
119
|
-
.vscode/.git.old
|
obsarray-1.0/docs/Makefile
DELETED
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
# Minimal makefile for Sphinx documentation
|
|
2
|
-
#
|
|
3
|
-
|
|
4
|
-
# You can set these variables from the command line.
|
|
5
|
-
SPHINXOPTS =
|
|
6
|
-
SPHINXBUILD = python -msphinx
|
|
7
|
-
SPHINXPROJ = obsarray
|
|
8
|
-
SOURCEDIR = .
|
|
9
|
-
BUILDDIR = _build
|
|
10
|
-
|
|
11
|
-
# Put it first so that "make" without argument is like "make help".
|
|
12
|
-
help:
|
|
13
|
-
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
14
|
-
|
|
15
|
-
.PHONY: help Makefile
|
|
16
|
-
|
|
17
|
-
# Catch-all target: route all unknown targets to Sphinx using the new
|
|
18
|
-
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
|
19
|
-
%: Makefile
|
|
20
|
-
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
obsarray-1.0/docs/conf.py
DELETED
|
@@ -1,181 +0,0 @@
|
|
|
1
|
-
#!/usr/bin/env python
|
|
2
|
-
#
|
|
3
|
-
# obsarray documentation build configuration file, created by
|
|
4
|
-
# cookiecutter
|
|
5
|
-
#
|
|
6
|
-
# This file is execfile()d with the current directory set to its
|
|
7
|
-
# containing dir.
|
|
8
|
-
#
|
|
9
|
-
# Note that not all possible configuration values are present in this
|
|
10
|
-
# autogenerated file.
|
|
11
|
-
#
|
|
12
|
-
# All configuration values have a default; values that are commented out
|
|
13
|
-
# serve to show the default.
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
# If extensions (or modules to document with autodoc) are in another
|
|
17
|
-
# directory, add these directories to sys.path here. If the directory is
|
|
18
|
-
# relative to the documentation root, use os.path.abspath to make it
|
|
19
|
-
# absolute, like shown here.
|
|
20
|
-
|
|
21
|
-
import sphinx_autosummary_accessors
|
|
22
|
-
import obsarray
|
|
23
|
-
|
|
24
|
-
project_title = "obsarray".replace("_", " ").title()
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
# -- General configuration ---------------------------------------------
|
|
28
|
-
|
|
29
|
-
# If your documentation needs a minimal Sphinx version, state it here.
|
|
30
|
-
#
|
|
31
|
-
# needs_sphinx = '1.0'
|
|
32
|
-
|
|
33
|
-
# Attempt to make links automatially
|
|
34
|
-
default_role = "code"
|
|
35
|
-
|
|
36
|
-
# Add any Sphinx extension module names here, as strings. They can be
|
|
37
|
-
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
|
38
|
-
# CFAB added napolean to support google-style docstrings
|
|
39
|
-
extensions = [
|
|
40
|
-
"sphinx.ext.autodoc",
|
|
41
|
-
"sphinx.ext.autosummary",
|
|
42
|
-
"sphinx.ext.intersphinx",
|
|
43
|
-
"sphinx.ext.viewcode",
|
|
44
|
-
"sphinx.ext.napoleon",
|
|
45
|
-
"IPython.sphinxext.ipython_directive",
|
|
46
|
-
"IPython.sphinxext.ipython_console_highlighting",
|
|
47
|
-
"sphinx_design",
|
|
48
|
-
"sphinx_autosummary_accessors",
|
|
49
|
-
]
|
|
50
|
-
|
|
51
|
-
# Add any paths that contain templates here, relative to this directory.
|
|
52
|
-
templates_path = ["_templates", sphinx_autosummary_accessors.templates_path]
|
|
53
|
-
|
|
54
|
-
# The suffix(es) of source filenames.
|
|
55
|
-
# You can specify multiple suffix as a list of string:
|
|
56
|
-
#
|
|
57
|
-
# source_suffix = ['.rst', '.md']
|
|
58
|
-
source_suffix = ".rst"
|
|
59
|
-
|
|
60
|
-
# The master toctree document.
|
|
61
|
-
master_doc = "index"
|
|
62
|
-
|
|
63
|
-
# General information about the project.
|
|
64
|
-
project = project_title
|
|
65
|
-
copyright = "CoMet Toolkit Team"
|
|
66
|
-
author = "CoMet Toolkit Team"
|
|
67
|
-
|
|
68
|
-
# The version info for the project you're documenting, acts as replacement
|
|
69
|
-
# for |version| and |release|, also used in various other places throughout
|
|
70
|
-
# the built documents.
|
|
71
|
-
#
|
|
72
|
-
# The short X.Y version.
|
|
73
|
-
version = obsarray.__version__
|
|
74
|
-
# The full version, including alpha/beta/rc tags.
|
|
75
|
-
release = obsarray.__version__
|
|
76
|
-
|
|
77
|
-
# The language for content autogenerated by Sphinx. Refer to documentation
|
|
78
|
-
# for a list of supported languages.
|
|
79
|
-
#
|
|
80
|
-
# This is also used if you do content translation via gettext catalogs.
|
|
81
|
-
# Usually you set "language" from the command line for these cases.
|
|
82
|
-
language = None
|
|
83
|
-
|
|
84
|
-
# List of patterns, relative to source directory, that match files and
|
|
85
|
-
# directories to ignore when looking for source files.
|
|
86
|
-
# This patterns also effect to html_static_path and html_extra_path
|
|
87
|
-
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
|
|
88
|
-
|
|
89
|
-
# The name of the Pygments (syntax highlighting) style to use.
|
|
90
|
-
pygments_style = "sphinx"
|
|
91
|
-
|
|
92
|
-
rst_prolog = """
|
|
93
|
-
.. role:: python(code)
|
|
94
|
-
:language: python
|
|
95
|
-
:class: highlight
|
|
96
|
-
"""
|
|
97
|
-
|
|
98
|
-
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
|
99
|
-
todo_include_todos = False
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
# -- Options for HTML output -------------------------------------------
|
|
103
|
-
|
|
104
|
-
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
105
|
-
# a list of builtin themes.
|
|
106
|
-
#
|
|
107
|
-
html_theme = "sphinx_book_theme"
|
|
108
|
-
|
|
109
|
-
# Theme options are theme-specific and customize the look and feel of a
|
|
110
|
-
# theme further. For a list of options available for each theme, see the
|
|
111
|
-
# documentation.
|
|
112
|
-
#
|
|
113
|
-
# html_theme_options = {}
|
|
114
|
-
|
|
115
|
-
html_logo = "figs/obsarray.png"
|
|
116
|
-
|
|
117
|
-
# Add any paths that contain custom static files (such as style sheets) here,
|
|
118
|
-
# relative to this directory. They are copied after the builtin static files,
|
|
119
|
-
# so a file named "default.css" will overwrite the builtin "default.css".
|
|
120
|
-
html_static_path = ["_static"]
|
|
121
|
-
|
|
122
|
-
# -- Options for HTMLHelp output ---------------------------------------
|
|
123
|
-
|
|
124
|
-
# Output file base name for HTML help builder.
|
|
125
|
-
htmlhelp_basename = "obsarraydoc"
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
# -- Options for LaTeX output ------------------------------------------
|
|
129
|
-
|
|
130
|
-
latex_elements = {
|
|
131
|
-
# The paper size ('letterpaper' or 'a4paper').
|
|
132
|
-
#
|
|
133
|
-
# 'papersize': 'letterpaper',
|
|
134
|
-
# The font size ('10pt', '11pt' or '12pt').
|
|
135
|
-
#
|
|
136
|
-
# 'pointsize': '10pt',
|
|
137
|
-
# Additional stuff for the LaTeX preamble.
|
|
138
|
-
#
|
|
139
|
-
# 'preamble': '',
|
|
140
|
-
# Latex figure (float) alignment
|
|
141
|
-
#
|
|
142
|
-
# 'figure_align': 'htbp',
|
|
143
|
-
}
|
|
144
|
-
|
|
145
|
-
# Grouping the document tree into LaTeX files. List of tuples
|
|
146
|
-
# (source start file, target name, title, author, documentclass
|
|
147
|
-
# [howto, manual, or own class]).
|
|
148
|
-
latex_documents = [
|
|
149
|
-
(
|
|
150
|
-
master_doc,
|
|
151
|
-
"user_manual.tex",
|
|
152
|
-
"{} Documentation".format(project_title),
|
|
153
|
-
"CoMet Toolkit Team",
|
|
154
|
-
"manual",
|
|
155
|
-
),
|
|
156
|
-
]
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
# -- Options for manual page output ------------------------------------
|
|
160
|
-
|
|
161
|
-
# One entry per manual page. List of tuples
|
|
162
|
-
# (source start file, name, description, authors, manual section).
|
|
163
|
-
man_pages = [(master_doc, "obsarray", "obsarray Documentation", [author], 1)]
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
# -- Options for Texinfo output ----------------------------------------
|
|
167
|
-
|
|
168
|
-
# Grouping the document tree into Texinfo files. List of tuples
|
|
169
|
-
# (source start file, target name, title, author,
|
|
170
|
-
# dir menu entry, description, category)
|
|
171
|
-
texinfo_documents = [
|
|
172
|
-
(
|
|
173
|
-
master_doc,
|
|
174
|
-
"obsarray",
|
|
175
|
-
"obsarray Documentation",
|
|
176
|
-
author,
|
|
177
|
-
"obsarray",
|
|
178
|
-
"Extension to xarray for handling uncertainty quantified observation data",
|
|
179
|
-
"Miscellaneous",
|
|
180
|
-
),
|
|
181
|
-
]
|
obsarray-1.0/docs/index.rst
DELETED
|
@@ -1,66 +0,0 @@
|
|
|
1
|
-
obsarray: Measurement data handling in Python
|
|
2
|
-
=============================================
|
|
3
|
-
|
|
4
|
-
**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.
|
|
5
|
-
|
|
6
|
-
**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.
|
|
7
|
-
|
|
8
|
-
.. grid:: 2
|
|
9
|
-
:gutter: 2
|
|
10
|
-
|
|
11
|
-
.. grid-item-card:: Quickstart Guide
|
|
12
|
-
:link: content/user/quickstart
|
|
13
|
-
:link-type: doc
|
|
14
|
-
|
|
15
|
-
New to *obsarray*? Check out the quickstart guide for an introduction.
|
|
16
|
-
|
|
17
|
-
.. grid-item-card:: User Guide
|
|
18
|
-
:link: content/user/user_guide
|
|
19
|
-
:link-type: doc
|
|
20
|
-
|
|
21
|
-
The user guide provides a documentation and examples how to use **obsarray** to handle measurement data.
|
|
22
|
-
|
|
23
|
-
.. grid-item-card:: API Reference
|
|
24
|
-
:link: content/user/api
|
|
25
|
-
:link-type: doc
|
|
26
|
-
|
|
27
|
-
The API Reference contains a description the **obsarray** API.
|
|
28
|
-
|
|
29
|
-
.. grid-item-card:: Developer Guide
|
|
30
|
-
:link: content/developer/developer_guide
|
|
31
|
-
:link-type: doc
|
|
32
|
-
|
|
33
|
-
Guide for contributing to **obsarray** (under development).
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
Acknowledgements
|
|
37
|
-
----------------
|
|
38
|
-
|
|
39
|
-
obsarray has been developed by `Sam Hunt <https://github.com/shunt16>`_.
|
|
40
|
-
|
|
41
|
-
The development has been funded by:
|
|
42
|
-
|
|
43
|
-
* The UK's Department for Business, Energy and Industrial Strategy's (BEIS) National Measurement System (NMS) programme
|
|
44
|
-
* The IDEAS-QA4EO project funded by the European Space Agency.
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
Project status
|
|
48
|
-
--------------
|
|
49
|
-
|
|
50
|
-
obsarray is under active development. It is beta software.
|
|
51
|
-
|
|
52
|
-
.. toctree::
|
|
53
|
-
:maxdepth: 2
|
|
54
|
-
:hidden:
|
|
55
|
-
:caption: For users
|
|
56
|
-
|
|
57
|
-
Quickstart <content/user/quickstart>
|
|
58
|
-
User Guide <content/user/user_guide>
|
|
59
|
-
API Reference <content/user/api>
|
|
60
|
-
|
|
61
|
-
.. toctree::
|
|
62
|
-
:maxdepth: 2
|
|
63
|
-
:hidden:
|
|
64
|
-
:caption: For developers/contributors
|
|
65
|
-
|
|
66
|
-
Developer Guide <content/developer/developer_guide>
|
obsarray-1.0/docs/make.bat
DELETED
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
@ECHO OFF
|
|
2
|
-
|
|
3
|
-
pushd %~dp0
|
|
4
|
-
|
|
5
|
-
REM Command file for Sphinx documentation
|
|
6
|
-
|
|
7
|
-
if "%SPHINXBUILD%" == "" (
|
|
8
|
-
set SPHINXBUILD=python -msphinx
|
|
9
|
-
)
|
|
10
|
-
set SOURCEDIR=.
|
|
11
|
-
set BUILDDIR=_build
|
|
12
|
-
set SPHINXPROJ=obsarray
|
|
13
|
-
|
|
14
|
-
if "%1" == "" goto help
|
|
15
|
-
|
|
16
|
-
%SPHINXBUILD% >NUL 2>NUL
|
|
17
|
-
if errorlevel 9009 (
|
|
18
|
-
echo.
|
|
19
|
-
echo.The Sphinx module was not found. Make sure you have Sphinx installed,
|
|
20
|
-
echo.then set the SPHINXBUILD environment variable to point to the full
|
|
21
|
-
echo.path of the 'sphinx-build' executable. Alternatively you may add the
|
|
22
|
-
echo.Sphinx directory to PATH.
|
|
23
|
-
echo.
|
|
24
|
-
echo.If you don't have Sphinx installed, grab it from
|
|
25
|
-
echo.http://sphinx-doc.org/
|
|
26
|
-
exit /b 1
|
|
27
|
-
)
|
|
28
|
-
|
|
29
|
-
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
|
|
30
|
-
goto end
|
|
31
|
-
|
|
32
|
-
:help
|
|
33
|
-
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
|
|
34
|
-
|
|
35
|
-
:end
|
|
36
|
-
popd
|