Skip to content

Commit 4f3b0bc

Browse files
keewiskeewis
authored
clean-up and implement the conversion methods (#11)
* add a function to attach units to xarray objects * remove the old and commented out assert_equal_with_units function * add utility functions to attach, convert, extract, and strip units * add the missing assert functions * reorder the array functions * implement a extract_units function * implement convert_units * implement attach_units * implement strip_units * isort and black * implement DataArray.pint.to * implement Dataset.pint.to * set units as optional * remove a leftover comment about mypy * update the minimum required pint version * document Dataset.pint.to * add docstrings to the conversion methods * don't require the variable names to be str * don't try to always convert the DataArray's unit * add the example output * make sure conversion of only the coords works * don't raise if the default value for units is passed * undo the test changes * properly separate the conversions * try separating the example descriptions * properly refer to pint.Unit * show how to use a dict-like to convert the data * fix the docstrings * add a comment on the source of the utility function * link to the source and add xarray's license * add a copyright notice to the xarray license
1 parent 7e8e0d2 commit 4f3b0bc

File tree

8 files changed

+1047
-49
lines changed

8 files changed

+1047
-49
lines changed

‎docs/api.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Dataset
1313

1414
Dataset.pint.quantify
1515
Dataset.pint.dequantify
16+
Dataset.pint.to
1617
Dataset.pint.to_base_units
1718
Dataset.pint.to_system
1819

‎docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
import sphinx_autosummary_accessors
2222

2323
# need to import so accessors get registered
24-
import pintxarray # noqa: F401
24+
import pint_xarray # noqa: F401
2525

2626
# -- Project information -----------------------------------------------------
2727

‎licenses/XARRAY_LICENSE

Lines changed: 194 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,194 @@
1+
Copyright 2014-2020, xarray developers
2+
3+
4+
Apache License
5+
Version 2.0, January 2004
6+
http://www.apache.org/licenses/
7+
8+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
9+
10+
1. Definitions.
11+
12+
"License" shall mean the terms and conditions for use, reproduction, and
13+
distribution as defined by Sections 1 through 9 of this document.
14+
15+
"Licensor" shall mean the copyright owner or entity authorized by the copyright
16+
owner that is granting the License.
17+
18+
"Legal Entity" shall mean the union of the acting entity and all other entities
19+
that control, are controlled by, or are under common control with that entity.
20+
For the purposes of this definition, "control" means (i) the power, direct or
21+
indirect, to cause the direction or management of such entity, whether by
22+
contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
23+
outstanding shares, or (iii) beneficial ownership of such entity.
24+
25+
"You" (or "Your") shall mean an individual or Legal Entity exercising
26+
permissions granted by this License.
27+
28+
"Source" form shall mean the preferred form for making modifications, including
29+
but not limited to software source code, documentation source, and configuration
30+
files.
31+
32+
"Object" form shall mean any form resulting from mechanical transformation or
33+
translation of a Source form, including but not limited to compiled object code,
34+
generated documentation, and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or Object form, made
37+
available under the License, as indicated by a copyright notice that is included
38+
in or attached to the work (an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object form, that
41+
is based on (or derived from) the Work and for which the editorial revisions,
42+
annotations, elaborations, or other modifications represent, as a whole, an
43+
original work of authorship. For the purposes of this License, Derivative Works
44+
shall not include works that remain separable from, or merely link (or bind by
45+
name) to the interfaces of, the Work and Derivative Works thereof.
46+
47+
"Contribution" shall mean any work of authorship, including the original version
48+
of the Work and any modifications or additions to that Work or Derivative Works
49+
thereof, that is intentionally submitted to Licensor for inclusion in the Work
50+
by the copyright owner or by an individual or Legal Entity authorized to submit
51+
on behalf of the copyright owner. For the purposes of this definition,
52+
"submitted" means any form of electronic, verbal, or written communication sent
53+
to the Licensor or its representatives, including but not limited to
54+
communication on electronic mailing lists, source code control systems, and
55+
issue tracking systems that are managed by, or on behalf of, the Licensor for
56+
the purpose of discussing and improving the Work, but excluding communication
57+
that is conspicuously marked or otherwise designated in writing by the copyright
58+
owner as "Not a Contribution."
59+
60+
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
61+
of whom a Contribution has been received by Licensor and subsequently
62+
incorporated within the Work.
63+
64+
2. Grant of Copyright License.
65+
66+
Subject to the terms and conditions of this License, each Contributor hereby
67+
grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
68+
irrevocable copyright license to reproduce, prepare Derivative Works of,
69+
publicly display, publicly perform, sublicense, and distribute the Work and such
70+
Derivative Works in Source or Object form.
71+
72+
3. Grant of Patent License.
73+
74+
Subject to the terms and conditions of this License, each Contributor hereby
75+
grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
76+
irrevocable (except as stated in this section) patent license to make, have
77+
made, use, offer to sell, sell, import, and otherwise transfer the Work, where
78+
such license applies only to those patent claims licensable by such Contributor
79+
that are necessarily infringed by their Contribution(s) alone or by combination
80+
of their Contribution(s) with the Work to which such Contribution(s) was
81+
submitted. If You institute patent litigation against any entity (including a
82+
cross-claim or counterclaim in a lawsuit) alleging that the Work or a
83+
Contribution incorporated within the Work constitutes direct or contributory
84+
patent infringement, then any patent licenses granted to You under this License
85+
for that Work shall terminate as of the date such litigation is filed.
86+
87+
4. Redistribution.
88+
89+
You may reproduce and distribute copies of the Work or Derivative Works thereof
90+
in any medium, with or without modifications, and in Source or Object form,
91+
provided that You meet the following conditions:
92+
93+
You must give any other recipients of the Work or Derivative Works a copy of
94+
this License; and
95+
You must cause any modified files to carry prominent notices stating that You
96+
changed the files; and
97+
You must retain, in the Source form of any Derivative Works that You distribute,
98+
all copyright, patent, trademark, and attribution notices from the Source form
99+
of the Work, excluding those notices that do not pertain to any part of the
100+
Derivative Works; and
101+
If the Work includes a "NOTICE" text file as part of its distribution, then any
102+
Derivative Works that You distribute must include a readable copy of the
103+
attribution notices contained within such NOTICE file, excluding those notices
104+
that do not pertain to any part of the Derivative Works, in at least one of the
105+
following places: within a NOTICE text file distributed as part of the
106+
Derivative Works; within the Source form or documentation, if provided along
107+
with the Derivative Works; or, within a display generated by the Derivative
108+
Works, if and wherever such third-party notices normally appear. The contents of
109+
the NOTICE file are for informational purposes only and do not modify the
110+
License. You may add Your own attribution notices within Derivative Works that
111+
You distribute, alongside or as an addendum to the NOTICE text from the Work,
112+
provided that such additional attribution notices cannot be construed as
113+
modifying the License.
114+
You may add Your own copyright statement to Your modifications and may provide
115+
additional or different license terms and conditions for use, reproduction, or
116+
distribution of Your modifications, or for any such Derivative Works as a whole,
117+
provided Your use, reproduction, and distribution of the Work otherwise complies
118+
with the conditions stated in this License.
119+
120+
5. Submission of Contributions.
121+
122+
Unless You explicitly state otherwise, any Contribution intentionally submitted
123+
for inclusion in the Work by You to the Licensor shall be under the terms and
124+
conditions of this License, without any additional terms or conditions.
125+
Notwithstanding the above, nothing herein shall supersede or modify the terms of
126+
any separate license agreement you may have executed with Licensor regarding
127+
such Contributions.
128+
129+
6. Trademarks.
130+
131+
This License does not grant permission to use the trade names, trademarks,
132+
service marks, or product names of the Licensor, except as required for
133+
reasonable and customary use in describing the origin of the Work and
134+
reproducing the content of the NOTICE file.
135+
136+
7. Disclaimer of Warranty.
137+
138+
Unless required by applicable law or agreed to in writing, Licensor provides the
139+
Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
140+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
141+
including, without limitation, any warranties or conditions of TITLE,
142+
NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
143+
solely responsible for determining the appropriateness of using or
144+
redistributing the Work and assume any risks associated with Your exercise of
145+
permissions under this License.
146+
147+
8. Limitation of Liability.
148+
149+
In no event and under no legal theory, whether in tort (including negligence),
150+
contract, or otherwise, unless required by applicable law (such as deliberate
151+
and grossly negligent acts) or agreed to in writing, shall any Contributor be
152+
liable to You for damages, including any direct, indirect, special, incidental,
153+
or consequential damages of any character arising as a result of this License or
154+
out of the use or inability to use the Work (including but not limited to
155+
damages for loss of goodwill, work stoppage, computer failure or malfunction, or
156+
any and all other commercial damages or losses), even if such Contributor has
157+
been advised of the possibility of such damages.
158+
159+
9. Accepting Warranty or Additional Liability.
160+
161+
While redistributing the Work or Derivative Works thereof, You may choose to
162+
offer, and charge a fee for, acceptance of support, warranty, indemnity, or
163+
other liability obligations and/or rights consistent with this License. However,
164+
in accepting such obligations, You may act only on Your own behalf and on Your
165+
sole responsibility, not on behalf of any other Contributor, and only if You
166+
agree to indemnify, defend, and hold each Contributor harmless for any liability
167+
incurred by, or claims asserted against, such Contributor by reason of your
168+
accepting any such warranty or additional liability.
169+
170+
END OF TERMS AND CONDITIONS
171+
172+
APPENDIX: How to apply the Apache License to your work
173+
174+
To apply the Apache License to your work, attach the following boilerplate
175+
notice, with the fields enclosed by brackets "[]" replaced with your own
176+
identifying information. (Don't include the brackets!) The text should be
177+
enclosed in the appropriate comment syntax for the file format. We also
178+
recommend that a file or class name and description of purpose be included on
179+
the same "printed page" as the copyright notice for easier identification within
180+
third-party archives.
181+
182+
Copyright [yyyy] [name of copyright owner]
183+
184+
Licensed under the Apache License, Version 2.0 (the "License");
185+
you may not use this file except in compliance with the License.
186+
You may obtain a copy of the License at
187+
188+
http://www.apache.org/licenses/LICENSE-2.0
189+
190+
Unless required by applicable law or agreed to in writing, software
191+
distributed under the License is distributed on an "AS IS" BASIS,
192+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
193+
See the License for the specific language governing permissions and
194+
limitations under the License.

0 commit comments

Comments
 (0)