32 |
106 |
119 |
123 |
124 |
--------------------------------------------------------------------------------
/docs/_build/html/objects.inv:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/nrc-cnrc/MetroloPy/333f9a9fb8c81696a92adafbf3ed831bf18b3d17/docs/_build/html/objects.inv
--------------------------------------------------------------------------------
/docs/_build/html/py-modindex.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
33 |
65 |
104 |
105 |
34 |
63 |
64 |
34 |
198 |
211 |
215 |
216 |
--------------------------------------------------------------------------------
/docs/_build/html/search.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
35 |
182 |
196 |
197 |
36 |
181 |
37 |
38 |
39 |
46 |
176 |
177 |
178 |
179 |
180 | Python Module Index
40 | 41 |
42 | m
43 |
44 |
45 | | 48 | m | ||
| 52 | |
53 | metrolopy | 54 | |
| 57 | |
58 | metrolopy.budget | 59 | |
| 62 | |
63 | metrolopy.dfunc | 64 | |
| 67 | |
68 | metrolopy.distributions | 69 | |
| 72 | |
73 | metrolopy.exceptions | 74 | |
| 77 | |
78 | metrolopy.fit | 79 | |
| 82 | |
83 | metrolopy.functions | 84 | |
| 87 | |
88 | metrolopy.gummy | 89 | |
| 92 | |
93 | metrolopy.logunit | 94 | |
| 97 | |
98 | metrolopy.mean | 99 | |
| 102 | |
103 | metrolopy.nonlinearunit | 104 | |
| 107 | |
108 | metrolopy.nummy | 109 | |
| 112 | |
113 | metrolopy.offsetunit | 114 | |
| 117 | |
118 | metrolopy.pmethod | 119 | |
| 122 | |
123 | metrolopy.prefixedunit | 124 | |
| 127 | |
128 | metrolopy.printing | 129 | |
| 132 | |
133 | metrolopy.relunits | 134 | |
| 137 | |
138 | metrolopy.siunits | 139 | |
| 142 | |
143 | metrolopy.tests | 144 | |
| 147 | |
148 | metrolopy.tests.test_create | 149 | |
| 152 | |
153 | metrolopy.ummy | 154 | |
| 157 | |
158 | metrolopy.unit | 159 | |
| 162 | |
163 | metrolopy.unitutils | 164 | |
| 167 | |
168 | metrolopy.usunits | 169 | |
| 172 | |
173 | metrolopy.version | 174 | |
38 |
80 |
93 |
97 |
98 |
--------------------------------------------------------------------------------
/docs/_build/html/todo.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
39 |
74 |
78 |
79 |
40 |
73 |
41 |
42 |
72 | Search
43 | 44 | 52 | 53 | 54 |55 | Searching for multiple words only shows matches that contain 56 | all words. 57 |
58 | 59 | 60 | 65 | 66 | 67 | 68 | 69 | 70 | 71 |
32 |
72 |
85 |
89 |
90 |
--------------------------------------------------------------------------------
/docs/_static/.DS_Store:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/nrc-cnrc/MetroloPy/333f9a9fb8c81696a92adafbf3ed831bf18b3d17/docs/_static/.DS_Store
--------------------------------------------------------------------------------
/docs/conf.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python3
2 | # -*- coding: utf-8 -*-
3 | #
4 | # gummy documentation build configuration file, created by
5 | # sphinx-quickstart on Fri Feb 22 16:15:02 2019.
6 | #
7 | # This file is execfile()d with the current directory set to its
8 | # containing dir.
9 | #
10 | # Note that not all possible configuration values are present in this
11 | # autogenerated file.
12 | #
13 | # All configuration values have a default; values that are commented out
14 | # serve to show the default.
15 |
16 | # If extensions (or modules to document with autodoc) are in another directory,
17 | # add these directories to sys.path here. If the directory is relative to the
18 | # documentation root, use os.path.abspath to make it absolute, like shown here.
19 | #
20 | # import os
21 | # import sys
22 | # sys.path.insert(0, os.path.abspath('.'))
23 |
24 |
25 | # -- General configuration ------------------------------------------------
26 |
27 | # If your documentation needs a minimal Sphinx version, state it here.
28 | #
29 | # needs_sphinx = '1.0'
30 |
31 | # Add any Sphinx extension module names here, as strings. They can be
32 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
33 | # ones.
34 |
35 | extensions = [
36 | 'sphinx.ext.autodoc',
37 | 'sphinx.ext.mathjax',
38 | 'sphinx.ext.githubpages',
39 | 'sphinx.ext.napoleon']
40 |
41 | napoleon_use_param = False
42 |
43 | # Add any paths that contain templates here, relative to this directory.
44 | templates_path = ['_templates']
45 |
46 | # The suffix(es) of source filenames.
47 | # You can specify multiple suffix as a list of string:
48 | #
49 | # source_suffix = ['.rst', '.md']
50 | source_suffix = '.rst'
51 |
52 | # The master toctree document.
53 | master_doc = 'index'
54 |
55 | # General information about the project.
56 | project = 'metrolopy'
57 | copyright = '2020, National Research Council Canada'
58 | author = 'Harold Parks'
59 |
60 | __version__ = None
61 | with open('../metrolopy/version.py') as f:
62 | exec(f.read())
63 | # The version info for the project you're documenting, acts as replacement for
64 | # |version| and |release|, also used in various other places throughout the
65 | # built documents.
66 | #
67 | # The short X.Y version.
68 | version = __version__
69 | # The full version, including alpha/beta/rc tags.
70 | release = __version__
71 |
72 | # The language for content autogenerated by Sphinx. Refer to documentation
73 | # for a list of supported languages.
74 | #
75 | # This is also used if you do content translation via gettext catalogs.
76 | # Usually you set "language" from the command line for these cases.
77 | language = None
78 |
79 | # List of patterns, relative to source directory, that match files and
80 | # directories to ignore when looking for source files.
81 | # This patterns also effect to html_static_path and html_extra_path
82 | exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
83 |
84 | # The name of the Pygments (syntax highlighting) style to use.
85 | pygments_style = 'sphinx'
86 |
87 | # If true, `todo` and `todoList` produce output, else they produce nothing.
88 | todo_include_todos = False
89 |
90 |
91 | # -- Options for HTML output ----------------------------------------------
92 |
93 | # The theme to use for HTML and HTML Help pages. See the documentation for
94 | # a list of builtin themes.
95 | #
96 | html_theme = 'nature'
97 |
98 | # Theme options are theme-specific and customize the look and feel of a theme
99 | # further. For a list of options available for each theme, see the
100 | # documentation.
101 | #
102 | # html_theme_options = {}
103 |
104 | # Add any paths that contain custom static files (such as style sheets) here,
105 | # relative to this directory. They are copied after the builtin static files,
106 | # so a file named "default.css" will overwrite the builtin "default.css".
107 | html_static_path = ['_static']
108 |
109 |
110 | # -- Options for HTMLHelp output ------------------------------------------
111 |
112 | # Output file base name for HTML help builder.
113 | htmlhelp_basename = 'metrolopydoc'
114 |
115 |
116 | # -- Options for LaTeX output ---------------------------------------------
117 |
118 | latex_elements = {
119 | # The paper size ('letterpaper' or 'a4paper').
120 | #
121 | # 'papersize': 'letterpaper',
122 |
123 | # The font size ('10pt', '11pt' or '12pt').
124 | #
125 | # 'pointsize': '10pt',
126 |
127 | # Additional stuff for the LaTeX preamble.
128 | #
129 | # 'preamble': '',
130 |
131 | # Latex figure (float) alignment
132 | #
133 | # 'figure_align': 'htbp',
134 | }
135 |
136 | # Grouping the document tree into LaTeX files. List of tuples
137 | # (source start file, target name, title,
138 | # author, documentclass [howto, manual, or own class]).
139 | latex_documents = [
140 | (master_doc, 'metrolopy.tex', 'MetroloPy Documentation',
141 | 'Harold Parks', 'manual'),
142 | ]
143 |
144 |
145 | # -- Options for manual page output ---------------------------------------
146 |
147 | # One entry per manual page. List of tuples
148 | # (source start file, name, description, authors, manual section).
149 | man_pages = [
150 | (master_doc, 'metrolopy', 'MetroloPy Documentation',
151 | [author], 1)
152 | ]
153 |
154 |
155 | # -- Options for Texinfo output -------------------------------------------
156 |
157 | # Grouping the document tree into Texinfo files. List of tuples
158 | # (source start file, target name, title, author,
159 | # dir menu entry, description, category)
160 | texinfo_documents = [
161 | (master_doc, 'metrolopy', 'MetroloPy Documentation',
162 | author, 'metrolopy', 'One line description of project.',
163 | 'Miscellaneous'),
164 | ]
165 |
166 |
167 |
168 |
--------------------------------------------------------------------------------
/docs/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
--------------------------------------------------------------------------------
/docs/index.rst:
--------------------------------------------------------------------------------
1 | .. metrolopy documentation master file, created by
2 | sphinx-quickstart on Fri Feb 22 16:15:02 2019.
3 | You can adapt this file completely to your liking, but it should at least
4 | contain the root `toctree` directive.
5 |
6 | .. toctree::
7 | :maxdepth: 2
8 | :caption: Contents:
9 |
10 | ===================
11 | MetroloPy, the docs
12 | ===================
13 |
14 | tools for dealing with physical quantities: uncertainty propagation and unit
15 | conversion
16 |
17 |
18 | getting started
19 | ===============
20 |
21 | MetroloPy is a pure python package and requires Python 3 and the
22 | `SciPy
33 |
49 |
70 |
71 |
34 |
48 |
35 |
36 |
40 |
43 |
44 |
45 |
46 |
47 |
37 |
38 | Lots of help is needed to find bugs.
39 |to do¶
41 |start by putting something here
42 |>>> import metrolopy as uc
36 | >>> a = uc.gummy(1.2345,u=0.0234,unit='cm')
37 | >>> a
38 | 1.234(23) cm
39 |
40 | >>> b = uc.gummy(3.034,u=0.174,unit='mm')
41 | >>> f = uc.gummy(uc.UniformDist(center=0.9345,half_width=0.096),unit='N')
42 | >>> p = f/(a*b)
43 | >>> p
44 | 2.50(21) N/cm2
45 |
46 | >>> p.unit = 'kPa'
47 | >>> p.uunit = '%'
48 | >>> p
49 | 25.0 kPa ± 8.5%
50 |