summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorHernan <hernan.grecco@gmail.com>2022-10-26 17:18:47 -0300
committerHernan <hernan.grecco@gmail.com>2022-10-26 21:30:58 -0300
commitcf3d431f852071364ca5a24b82db595d240bb927 (patch)
tree9eddb552b881a2346485eb792cefe33368468e80 /docs
parent12db799a5bc21bd836151b9d15070a4b8040a232 (diff)
downloadpint-cf3d431f852071364ca5a24b82db595d240bb927.tar.gz
Partially reorganized docs
- api is now split into 3 parts - files are reorganized in folders Additionally, some class members (Quantity, Unit, Measurement, Group, Context, System) are excluded from the docs as they confuse sphinx.
Diffstat (limited to 'docs')
-rw-r--r--docs/advanced/currencies.rst (renamed from docs/user/currencies.rst)0
-rw-r--r--docs/advanced/custom-registry-class.rst (renamed from docs/user/custom-registry-class.rst)0
-rw-r--r--docs/advanced/defining.rst (renamed from docs/user/defining.rst)0
-rw-r--r--docs/advanced/index.rst17
-rw-r--r--docs/advanced/measurement.rst (renamed from docs/user/measurement.rst)0
-rw-r--r--docs/advanced/performance.rst (renamed from docs/user/performance.rst)0
-rw-r--r--docs/advanced/pitheorem.rst (renamed from docs/user/pitheorem.rst)0
-rw-r--r--docs/advanced/serialization.rst (renamed from docs/user/serialization.rst)2
-rw-r--r--docs/advanced/wrapping.rst (renamed from docs/user/wrapping.rst)0
-rw-r--r--docs/advanced_guides.rst15
-rw-r--r--docs/api.rst71
-rw-r--r--docs/api/base.rst65
-rw-r--r--docs/api/common.rst40
-rw-r--r--docs/api/facets.rst39
-rw-r--r--docs/api/index.rst10
-rw-r--r--docs/dev/contributing.rst12
-rw-r--r--docs/ecosystem.rst (renamed from docs/user/ecosystem.rst)0
-rw-r--r--docs/getting/faq.rst (renamed from docs/user/faq.rst)0
-rw-r--r--docs/getting/index.rst (renamed from docs/getting_started.rst)7
-rw-r--r--docs/getting/overview.rst (renamed from docs/user/overview.rst)0
-rw-r--r--docs/getting/pint-in-your-projects.rst70
-rw-r--r--docs/getting/tutorial.rst (renamed from docs/user/tutorial.rst)50
-rw-r--r--docs/index.rst8
-rw-r--r--docs/user/formatting.rst6
-rw-r--r--docs/user/numpy.ipynb216
25 files changed, 439 insertions, 189 deletions
diff --git a/docs/user/currencies.rst b/docs/advanced/currencies.rst
index 26b66b5..26b66b5 100644
--- a/docs/user/currencies.rst
+++ b/docs/advanced/currencies.rst
diff --git a/docs/user/custom-registry-class.rst b/docs/advanced/custom-registry-class.rst
index 31f3d76..31f3d76 100644
--- a/docs/user/custom-registry-class.rst
+++ b/docs/advanced/custom-registry-class.rst
diff --git a/docs/user/defining.rst b/docs/advanced/defining.rst
index 43344bc..43344bc 100644
--- a/docs/user/defining.rst
+++ b/docs/advanced/defining.rst
diff --git a/docs/advanced/index.rst b/docs/advanced/index.rst
new file mode 100644
index 0000000..e013321
--- /dev/null
+++ b/docs/advanced/index.rst
@@ -0,0 +1,17 @@
+Advanced Guides
+===============
+
+Pint contains some useful and fun feature. You will find them here.
+
+.. toctree::
+ :maxdepth: 2
+ :hidden:
+
+ performance
+ serialization
+ defining
+ wrapping
+ measurement
+ pitheorem
+ currencies
+ custom-registry-class
diff --git a/docs/user/measurement.rst b/docs/advanced/measurement.rst
index a49c821..a49c821 100644
--- a/docs/user/measurement.rst
+++ b/docs/advanced/measurement.rst
diff --git a/docs/user/performance.rst b/docs/advanced/performance.rst
index d7b8a0c..d7b8a0c 100644
--- a/docs/user/performance.rst
+++ b/docs/advanced/performance.rst
diff --git a/docs/user/pitheorem.rst b/docs/advanced/pitheorem.rst
index cd37165..cd37165 100644
--- a/docs/user/pitheorem.rst
+++ b/docs/advanced/pitheorem.rst
diff --git a/docs/user/serialization.rst b/docs/advanced/serialization.rst
index 01fed50..581bc9d 100644
--- a/docs/user/serialization.rst
+++ b/docs/advanced/serialization.rst
@@ -1,5 +1,3 @@
-.. _serialization:
-
Serialization
=============
diff --git a/docs/user/wrapping.rst b/docs/advanced/wrapping.rst
index 21d8177..21d8177 100644
--- a/docs/user/wrapping.rst
+++ b/docs/advanced/wrapping.rst
diff --git a/docs/advanced_guides.rst b/docs/advanced_guides.rst
deleted file mode 100644
index 580ddb7..0000000
--- a/docs/advanced_guides.rst
+++ /dev/null
@@ -1,15 +0,0 @@
-Advanced Guides
-===============
-
-.. toctree::
- :maxdepth: 2
- :hidden:
-
- user/performance
- user/serialization
- user/defining
- user/wrapping
- user/measurement
- user/pitheorem
- user/currencies
- user/custom-registry-class
diff --git a/docs/api.rst b/docs/api.rst
deleted file mode 100644
index 6ac269e..0000000
--- a/docs/api.rst
+++ /dev/null
@@ -1,71 +0,0 @@
-===================
-API reference
-===================
-
-.. currentmodule:: pint
-
-.. automodule:: pint.babel_names
- :members:
-
-.. automodule:: pint.compat
- :members:
-
-.. automodule:: pint.converters
- :members:
-
-.. automodule:: pint.definitions
- :members:
-
-.. automodule:: pint.errors
- :members:
-
-.. automodule:: pint.formatting
- :members:
-
-.. automodule:: pint.matplotlib
- :members:
-
-.. automodule:: pint.pint_eval
- :members:
-
-.. automodule:: pint.registry
- :members:
-
-.. automodule:: pint.registry_helpers
- :members:
-
-.. automodule:: pint.testing
- :members:
-
-.. automodule:: pint.util
- :members:
-
-Facets
-------
-
-.. automodule:: pint.facets.plain
- :members:
-
-.. automodule:: pint.facets.nonmultiplicative
- :members:
-
-.. automodule:: pint.facets.formatting
- :members:
-
-.. automodule:: pint.facets.numpy
- :members:
-
-.. automodule:: pint.facets.dask
- :members:
-
-.. automodule:: pint.facets.measurement
- :members:
-
-.. automodule:: pint.facets.group
- :members:
-
-.. automodule:: pint.facets.system
- :members:
-
-.. automodule:: pint.facets.context
- :members:
diff --git a/docs/api/base.rst b/docs/api/base.rst
new file mode 100644
index 0000000..cd28a5f
--- /dev/null
+++ b/docs/api/base.rst
@@ -0,0 +1,65 @@
+
+Base API
+========
+
+.. currentmodule:: pint
+
+
+Most important classes
+----------------------
+
+.. autoclass:: UnitRegistry
+ :members:
+ :exclude-members: Quantity, Unit, Measurement, Group, Context, System
+
+.. autoclass:: Quantity
+ :members:
+
+.. autoclass:: Unit
+ :members:
+
+.. autoclass:: Measurement
+ :members:
+
+
+Exceptions and warnings
+-----------------------
+
+.. autoexception:: PintError
+ :members:
+
+.. autoexception:: DefinitionSyntaxError
+ :members:
+
+.. autoexception:: LogarithmicUnitCalculusError
+ :members:
+
+.. autoexception:: DimensionalityError
+ :members:
+
+.. autoexception:: OffsetUnitCalculusError
+ :members:
+
+.. autoexception:: RedefinitionError
+ :members:
+
+.. autoexception:: UndefinedUnitError
+ :members:
+
+.. autoexception:: UnitStrippedWarning
+ :members:
+
+
+Sharing registry among packages
+-------------------------------
+,
+.. autofunction:: get_application_registry
+.. autofunction:: set_application_registry
+
+Other functions
+---------------
+
+.. autofunction:: formatter
+.. autofunction:: register_unit_format
+.. autofunction:: pi_theorem
+.. autoclass:: Context
diff --git a/docs/api/common.rst b/docs/api/common.rst
new file mode 100644
index 0000000..da4ab70
--- /dev/null
+++ b/docs/api/common.rst
@@ -0,0 +1,40 @@
+Common API
+==========
+
+.. automodule:: pint.babel_names
+ :members:
+
+.. automodule:: pint.compat
+ :members:
+
+.. automodule:: pint.converters
+ :members:
+
+.. automodule:: pint.definitions
+ :members:
+
+.. automodule:: pint.errors
+ :members:
+
+.. automodule:: pint.formatting
+ :members:
+
+.. automodule:: pint.matplotlib
+ :members:
+
+.. automodule:: pint.pint_eval
+ :members:
+
+.. automodule:: pint.registry
+ :members:
+ :exclude-members: Quantity, Unit, Measurement, Group, Context, System, UnitRegistry
+
+.. automodule:: pint.registry_helpers
+ :members:
+
+.. automodule:: pint.testing
+ :members:
+
+.. automodule:: pint.util
+ :members:
+ :exclude-members: Unit
diff --git a/docs/api/facets.rst b/docs/api/facets.rst
new file mode 100644
index 0000000..a40b4a1
--- /dev/null
+++ b/docs/api/facets.rst
@@ -0,0 +1,39 @@
+API facets reference
+====================
+
+
+.. automodule:: pint.facets.plain
+ :members:
+ :exclude-members: Quantity, Unit, Measurement, Group, Context, System
+
+.. automodule:: pint.facets.nonmultiplicative
+ :members:
+ :exclude-members: Quantity, Unit, Measurement, Group, Context, System
+
+.. automodule:: pint.facets.formatting
+ :members:
+ :exclude-members: Quantity, Unit, Measurement, Group, Context, System
+
+.. automodule:: pint.facets.numpy
+ :members:
+ :exclude-members: Quantity, Unit, Measurement, Group, Context, System
+
+.. automodule:: pint.facets.dask
+ :members:
+ :exclude-members: Quantity, Unit, Measurement, Group, Context, System
+
+.. automodule:: pint.facets.measurement
+ :members:
+ :exclude-members: Quantity, Unit, Measurement, Group, Context, System
+
+.. automodule:: pint.facets.group
+ :members:
+ :exclude-members: Quantity, Unit, Measurement, Group, Context, System
+
+.. automodule:: pint.facets.system
+ :members:
+ :exclude-members: Quantity, Unit, Measurement, Group, Context, System
+
+.. automodule:: pint.facets.context
+ :members:
+ :exclude-members: Quantity, Unit, Measurement, Group, Context, System
diff --git a/docs/api/index.rst b/docs/api/index.rst
new file mode 100644
index 0000000..5975c5b
--- /dev/null
+++ b/docs/api/index.rst
@@ -0,0 +1,10 @@
+API reference
+==============
+
+.. toctree::
+ :maxdepth: 1
+ :hidden:
+
+ base
+ common
+ facets
diff --git a/docs/dev/contributing.rst b/docs/dev/contributing.rst
index 10e6f5a..c63381b 100644
--- a/docs/dev/contributing.rst
+++ b/docs/dev/contributing.rst
@@ -107,15 +107,16 @@ Extension Packages
------------------
Pint naturally integrates with other libraries in the scientific Python ecosystem, and
-a small number of
-`extension/compatibility packages<numpy.html#Compatibility-Packages>`_ have arisen to
-aid in compatibility between certain packages. Pint's rule of thumb for integration
+a small _`ecosystem` have arisen to aid in compatibility between certain packages
+allowing to build an
+
+Pint's rule of thumb for integration
features that work best as an extension package versus direct inclusion in Pint is:
* Extension (separate packages)
- * Duck array types that wrap Pint (come above Pint in
- `the type casting hierarchy<numpy.html#Technical-Commentary>`_)
+ * Duck array types that wrap Pint (come above Pint
+ in :ref:`the type casting hierarchy <_numpy#technical-commentary>`
* Uses features independent/on top of the libraries
@@ -143,3 +144,4 @@ features that work best as an extension package versus direct inclusion in Pint
.. _flake8: https://flake8.pycqa.org/en/latest/
.. _pytest: https://docs.pytest.org/en/stable/
.. _sphinx: https://www.sphinx-doc.org/en/master/
+.. _`extension/compatibility packages`:
diff --git a/docs/user/ecosystem.rst b/docs/ecosystem.rst
index 7610fd0..7610fd0 100644
--- a/docs/user/ecosystem.rst
+++ b/docs/ecosystem.rst
diff --git a/docs/user/faq.rst b/docs/getting/faq.rst
index 75d7db7..75d7db7 100644
--- a/docs/user/faq.rst
+++ b/docs/getting/faq.rst
diff --git a/docs/getting_started.rst b/docs/getting/index.rst
index cae31c6..9907aeb 100644
--- a/docs/getting_started.rst
+++ b/docs/getting/index.rst
@@ -45,6 +45,7 @@ That's all! You can check that Pint is correctly installed by starting up python
:maxdepth: 2
:hidden:
- user/overview
- user/tutorial
- user/faq
+ overview
+ tutorial
+ pint-in-your-projects
+ faq
diff --git a/docs/user/overview.rst b/docs/getting/overview.rst
index cd639aa..cd639aa 100644
--- a/docs/user/overview.rst
+++ b/docs/getting/overview.rst
diff --git a/docs/getting/pint-in-your-projects.rst b/docs/getting/pint-in-your-projects.rst
new file mode 100644
index 0000000..37803d9
--- /dev/null
+++ b/docs/getting/pint-in-your-projects.rst
@@ -0,0 +1,70 @@
+.. _pint_in_your_projects:
+
+Using Pint in your projects
+===========================
+
+Having a shared registry
+------------------------
+
+If you use Pint in multiple modules within your Python package, you normally
+want to avoid creating multiple instances of the unit registry.
+The best way to do this is by instantiating the registry in a single place. For
+example, you can add the following code to your package ``__init__.py``
+
+.. doctest::
+
+ >>> from pint import UnitRegistry
+ >>> ureg = UnitRegistry()
+ >>> Q_ = ureg.Quantity
+
+
+Then in ``yourmodule.py`` the code would be
+
+.. code-block:: python
+
+ from . import ureg, Q_
+
+ length = 10 * ureg.meter
+ my_speed = Q_(20, 'm/s')
+
+If you are pickling and unpickling Quantities within your project, you should
+also define the registry as the application registry
+
+.. code-block:: python
+
+ from pint import UnitRegistry, set_application_registry
+ ureg = UnitRegistry()
+ set_application_registry(ureg)
+
+
+.. warning:: There are no global units in Pint. All units belong to a registry and
+ you can have multiple registries instantiated at the same time. However, you
+ are not supposed to operate between quantities that belong to different registries.
+ Never do things like this:
+
+.. doctest::
+
+ >>> q1 = 10 * UnitRegistry().meter
+ >>> q2 = 10 * UnitRegistry().meter
+ >>> q1 + q2
+ Traceback (most recent call last):
+ ...
+ ValueError: Cannot operate with Quantity and Quantity of different registries.
+ >>> id(q1._REGISTRY) == id(q2._REGISTRY)
+ False
+
+
+Keeping up to date with Pint development
+----------------------------------------
+
+While we work hard to avoid breaking code using Pint, sometimes it
+happens. To help you track how Pint is evolving it is recommended
+that you run a daily or weekly job against pint master branch.
+
+For example, this is how xarray_ is doing it:
+
+If a new version of Pint breaks your code, please open an issue_ to
+let us know.
+
+.. _xarray: https://github.com/pydata/xarray/blob/main/.github/workflows/upstream-dev-ci.yaml
+.. _issue: https://github.com/hgrecco/pint/issues
diff --git a/docs/user/tutorial.rst b/docs/getting/tutorial.rst
index 3b3fe98..0889355 100644
--- a/docs/user/tutorial.rst
+++ b/docs/getting/tutorial.rst
@@ -423,56 +423,6 @@ and by doing that, string formatting is now localized:
'1.3 mètre par seconde²'
-Using Pint in your projects
----------------------------
-
-If you use Pint in multiple modules within your Python package, you normally
-want to avoid creating multiple instances of the unit registry.
-The best way to do this is by instantiating the registry in a single place. For
-example, you can add the following code to your package ``__init__.py``
-
-.. code-block:: python
-
- from pint import UnitRegistry
- ureg = UnitRegistry()
- Q_ = ureg.Quantity
-
-
-Then in ``yourmodule.py`` the code would be
-
-.. code-block:: python
-
- from . import ureg, Q_
-
- length = 10 * ureg.meter
- my_speed = Q_(20, 'm/s')
-
-If you are pickling and unpickling Quantities within your project, you should
-also define the registry as the application registry
-
-.. code-block:: python
-
- from pint import UnitRegistry, set_application_registry
- ureg = UnitRegistry()
- set_application_registry(ureg)
-
-
-.. warning:: There are no global units in Pint. All units belong to a registry and
- you can have multiple registries instantiated at the same time. However, you
- are not supposed to operate between quantities that belong to different registries.
- Never do things like this:
-
-.. doctest::
-
- >>> q1 = 10 * UnitRegistry().meter
- >>> q2 = 10 * UnitRegistry().meter
- >>> q1 + q2
- Traceback (most recent call last):
- ...
- ValueError: Cannot operate with Quantity and Quantity of different registries.
- >>> id(q1._REGISTRY) == id(q2._REGISTRY)
- False
-
.. _`default list of units`: https://github.com/hgrecco/pint/blob/master/pint/default_en.txt
.. _`Babel`: http://babel.pocoo.org/
diff --git a/docs/index.rst b/docs/index.rst
index 9a65f43..d4da695 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -65,11 +65,11 @@ Pint: makes units easy
:hidden:
:caption: For users
- Getting started <getting_started>
+ Getting started <getting/index>
User Guide <user/index>
- Advanced topics <advanced_guides>
- user/ecosystem
- api
+ Advanced topics <advanced/index>
+ ecosystem
+ API Reference <api/index>
.. toctree::
:maxdepth: 1
diff --git a/docs/user/formatting.rst b/docs/user/formatting.rst
index 3ed3540..7b0f15b 100644
--- a/docs/user/formatting.rst
+++ b/docs/user/formatting.rst
@@ -1,4 +1,3 @@
-.. _formatting:
.. currentmodule:: pint
@@ -8,8 +7,9 @@
import pint
-String formatting
-=================
+String formatting specification
+===============================
+
The conversion of :py:class:`Unit` and :py:class:`Quantity` objects to strings (e.g.
through the :py:class:`str` builtin or f-strings) can be customized using :ref:`format
specifications <formatspec>`. The basic format is:
diff --git a/docs/user/numpy.ipynb b/docs/user/numpy.ipynb
index 59def65..2586626 100644
--- a/docs/user/numpy.ipynb
+++ b/docs/user/numpy.ipynb
@@ -2,7 +2,11 @@
"cells": [
{
"cell_type": "markdown",
- "metadata": {},
+ "metadata": {
+ "pycharm": {
+ "name": "#%% md\n"
+ }
+ },
"source": [
"NumPy Support\n",
"=============\n",
@@ -21,7 +25,11 @@
{
"cell_type": "code",
"execution_count": null,
- "metadata": {},
+ "metadata": {
+ "pycharm": {
+ "name": "#%%\n"
+ }
+ },
"outputs": [],
"source": [
"# Import NumPy\n",
@@ -41,7 +49,11 @@
},
{
"cell_type": "markdown",
- "metadata": {},
+ "metadata": {
+ "pycharm": {
+ "name": "#%% md\n"
+ }
+ },
"source": [
"and then we create a quantity the standard way"
]
@@ -49,7 +61,11 @@
{
"cell_type": "code",
"execution_count": null,
- "metadata": {},
+ "metadata": {
+ "pycharm": {
+ "name": "#%%\n"
+ }
+ },
"outputs": [],
"source": [
"legs1 = Q_(np.asarray([3., 4.]), 'meter')\n",
@@ -59,7 +75,11 @@
{
"cell_type": "code",
"execution_count": null,
- "metadata": {},
+ "metadata": {
+ "pycharm": {
+ "name": "#%%\n"
+ }
+ },
"outputs": [],
"source": [
"legs1 = [3., 4.] * ureg.meter\n",
@@ -68,7 +88,11 @@
},
{
"cell_type": "markdown",
- "metadata": {},
+ "metadata": {
+ "pycharm": {
+ "name": "#%% md\n"
+ }
+ },
"source": [
"All usual Pint methods can be used with this quantity. For example:"
]
@@ -76,7 +100,11 @@
{
"cell_type": "code",
"execution_count": null,
- "metadata": {},
+ "metadata": {
+ "pycharm": {
+ "name": "#%%\n"
+ }
+ },
"outputs": [],
"source": [
"print(legs1.to('kilometer'))"
@@ -85,7 +113,11 @@
{
"cell_type": "code",
"execution_count": null,
- "metadata": {},
+ "metadata": {
+ "pycharm": {
+ "name": "#%%\n"
+ }
+ },
"outputs": [],
"source": [
"print(legs1.dimensionality)"
@@ -94,7 +126,11 @@
{
"cell_type": "code",
"execution_count": null,
- "metadata": {},
+ "metadata": {
+ "pycharm": {
+ "name": "#%%\n"
+ }
+ },
"outputs": [],
"source": [
"try:\n",
@@ -105,7 +141,11 @@
},
{
"cell_type": "markdown",
- "metadata": {},
+ "metadata": {
+ "pycharm": {
+ "name": "#%% md\n"
+ }
+ },
"source": [
"NumPy functions are supported by Pint. For example if we define:"
]
@@ -113,7 +153,11 @@
{
"cell_type": "code",
"execution_count": null,
- "metadata": {},
+ "metadata": {
+ "pycharm": {
+ "name": "#%%\n"
+ }
+ },
"outputs": [],
"source": [
"legs2 = [400., 300.] * ureg.centimeter\n",
@@ -122,7 +166,11 @@
},
{
"cell_type": "markdown",
- "metadata": {},
+ "metadata": {
+ "pycharm": {
+ "name": "#%% md\n"
+ }
+ },
"source": [
"we can calculate the hypotenuse of the right triangles with legs1 and legs2."
]
@@ -130,7 +178,11 @@
{
"cell_type": "code",
"execution_count": null,
- "metadata": {},
+ "metadata": {
+ "pycharm": {
+ "name": "#%%\n"
+ }
+ },
"outputs": [],
"source": [
"hyps = np.hypot(legs1, legs2)\n",
@@ -139,7 +191,11 @@
},
{
"cell_type": "markdown",
- "metadata": {},
+ "metadata": {
+ "pycharm": {
+ "name": "#%% md\n"
+ }
+ },
"source": [
"Notice that before the `np.hypot` was used, the numerical value of legs2 was\n",
"internally converted to the units of legs1 as expected.\n",
@@ -151,7 +207,11 @@
{
"cell_type": "code",
"execution_count": null,
- "metadata": {},
+ "metadata": {
+ "pycharm": {
+ "name": "#%%\n"
+ }
+ },
"outputs": [],
"source": [
"angles = np.arccos(legs2/hyps)\n",
@@ -160,7 +220,11 @@
},
{
"cell_type": "markdown",
- "metadata": {},
+ "metadata": {
+ "pycharm": {
+ "name": "#%% md\n"
+ }
+ },
"source": [
"You can convert the result to degrees using usual unit conversion:"
]
@@ -168,7 +232,11 @@
{
"cell_type": "code",
"execution_count": null,
- "metadata": {},
+ "metadata": {
+ "pycharm": {
+ "name": "#%%\n"
+ }
+ },
"outputs": [],
"source": [
"print(angles.to('degree'))"
@@ -176,7 +244,11 @@
},
{
"cell_type": "markdown",
- "metadata": {},
+ "metadata": {
+ "pycharm": {
+ "name": "#%% md\n"
+ }
+ },
"source": [
"Applying a function that expects angles to a quantity with a different dimensionality\n",
"results in an error:"
@@ -185,7 +257,11 @@
{
"cell_type": "code",
"execution_count": null,
- "metadata": {},
+ "metadata": {
+ "pycharm": {
+ "name": "#%%\n"
+ }
+ },
"outputs": [],
"source": [
"try:\n",
@@ -196,7 +272,11 @@
},
{
"cell_type": "markdown",
- "metadata": {},
+ "metadata": {
+ "pycharm": {
+ "name": "#%% md\n"
+ }
+ },
"source": [
"Function/Method Support\n",
"-----------------------\n",
@@ -214,7 +294,11 @@
{
"cell_type": "code",
"execution_count": null,
- "metadata": {},
+ "metadata": {
+ "pycharm": {
+ "name": "#%%\n"
+ }
+ },
"outputs": [],
"source": [
"from pint.facets.numpy.numpy_func import HANDLED_FUNCTIONS\n",
@@ -223,7 +307,11 @@
},
{
"cell_type": "markdown",
- "metadata": {},
+ "metadata": {
+ "pycharm": {
+ "name": "#%% md\n"
+ }
+ },
"source": [
"And the following [NumPy ndarray methods](http://docs.scipy.org/doc/numpy/reference/arrays.ndarray.html#array-methods):\n",
"\n",
@@ -235,7 +323,11 @@
},
{
"cell_type": "markdown",
- "metadata": {},
+ "metadata": {
+ "pycharm": {
+ "name": "#%% md\n"
+ }
+ },
"source": [
"Array Type Support\n",
"------------------\n",
@@ -273,7 +365,11 @@
{
"cell_type": "code",
"execution_count": null,
- "metadata": {},
+ "metadata": {
+ "pycharm": {
+ "name": "#%%\n"
+ }
+ },
"outputs": [],
"source": [
"from graphviz import Digraph\n",
@@ -304,7 +400,11 @@
},
{
"cell_type": "markdown",
- "metadata": {},
+ "metadata": {
+ "pycharm": {
+ "name": "#%% md\n"
+ }
+ },
"source": [
"### Examples\n",
"\n",
@@ -314,7 +414,11 @@
{
"cell_type": "code",
"execution_count": null,
- "metadata": {},
+ "metadata": {
+ "pycharm": {
+ "name": "#%%\n"
+ }
+ },
"outputs": [],
"source": [
"import xarray as xr\n",
@@ -332,7 +436,11 @@
},
{
"cell_type": "markdown",
- "metadata": {},
+ "metadata": {
+ "pycharm": {
+ "name": "#%% md\n"
+ }
+ },
"source": [
"**Pint Quantity wrapping Sparse COO**"
]
@@ -340,7 +448,11 @@
{
"cell_type": "code",
"execution_count": null,
- "metadata": {},
+ "metadata": {
+ "pycharm": {
+ "name": "#%%\n"
+ }
+ },
"outputs": [],
"source": [
"from sparse import COO\n",
@@ -360,7 +472,11 @@
},
{
"cell_type": "markdown",
- "metadata": {},
+ "metadata": {
+ "pycharm": {
+ "name": "#%% md\n"
+ }
+ },
"source": [
"**Pint Quantity wrapping NumPy Masked Array**"
]
@@ -368,7 +484,11 @@
{
"cell_type": "code",
"execution_count": null,
- "metadata": {},
+ "metadata": {
+ "pycharm": {
+ "name": "#%%\n"
+ }
+ },
"outputs": [],
"source": [
"m = np.ma.masked_array([2, 3, 5, 7], mask=[False, True, False, True])\n",
@@ -385,7 +505,11 @@
},
{
"cell_type": "markdown",
- "metadata": {},
+ "metadata": {
+ "pycharm": {
+ "name": "#%% md\n"
+ }
+ },
"source": [
"**Pint Quantity wrapping Dask Array**"
]
@@ -393,7 +517,11 @@
{
"cell_type": "code",
"execution_count": null,
- "metadata": {},
+ "metadata": {
+ "pycharm": {
+ "name": "#%%\n"
+ }
+ },
"outputs": [],
"source": [
"import dask.array as da\n",
@@ -415,7 +543,11 @@
},
{
"cell_type": "markdown",
- "metadata": {},
+ "metadata": {
+ "pycharm": {
+ "name": "#%% md\n"
+ }
+ },
"source": [
"**xarray wrapping Pint Quantity wrapping Dask array wrapping Sparse COO**"
]
@@ -423,7 +555,11 @@
{
"cell_type": "code",
"execution_count": null,
- "metadata": {},
+ "metadata": {
+ "pycharm": {
+ "name": "#%%\n"
+ }
+ },
"outputs": [],
"source": [
"import dask.array as da\n",
@@ -449,7 +585,11 @@
},
{
"cell_type": "markdown",
- "metadata": {},
+ "metadata": {
+ "pycharm": {
+ "name": "#%% md\n"
+ }
+ },
"source": [
"### Compatibility Packages\n",
"\n",
@@ -463,7 +603,11 @@
},
{
"cell_type": "markdown",
- "metadata": {},
+ "metadata": {
+ "pycharm": {
+ "name": "#%% md\n"
+ }
+ },
"source": [
"## Additional Comments\n",
"\n",