use application reg in docs

andrewgsavage · Feb 2, 2024 · 8671676 · 8671676
1 parent 29a139f
commit 8671676
Show file tree

Hide file tree

Showing 7 changed files with 16 additions and 16 deletions.
diff --git a/docs/advanced/performance.rst b/docs/advanced/performance.rst
@@ -69,7 +69,7 @@ A better way to use magnitudes is to use pint's wraps decorator (See :ref:`wrapp
 
     In [1]: import pint
 
-    In [2]: ureg = pint.UnitRegistry()
+    In [2]: ureg = pint.get_application_registry()
 
     In [3]: import numpy as np
 

diff --git a/docs/advanced/serialization.rst b/docs/advanced/serialization.rst
@@ -11,7 +11,7 @@ The easiest way to do this is by converting the quantity to a string:
 .. doctest::
 
    >>> import pint
-   >>> ureg = pint.UnitRegistry()
+   >>> ureg = pint.get_application_registry()
    >>> duration = 24.2 * ureg.years
    >>> duration
    <Quantity(24.2, 'year')>
@@ -28,7 +28,7 @@ to recover it in another process/machine, you just:
 .. doctest::
 
    >>> import pint
-   >>> ureg = pint.UnitRegistry()
+   >>> ureg = pint.get_application_registry()
    >>> duration = ureg('24.2 year')
    >>> print(duration)
    24.2 year

diff --git a/docs/getting/overview.rst b/docs/getting/overview.rst
@@ -22,7 +22,7 @@ It is extremely easy and natural to use:
 .. code-block:: python
 
     >>> import pint
-    >>> ureg = pint.UnitRegistry()
+    >>> ureg = pint.get_application_registry()
     >>> 3 * ureg.meter + 4 * ureg.cm
     <Quantity(3.04, 'meter')>
 

diff --git a/docs/user/contexts.rst b/docs/user/contexts.rst
@@ -11,7 +11,7 @@ raise an error if you do this directly:
 .. doctest::
 
     >>> import pint
-    >>> ureg = pint.UnitRegistry()
+    >>> ureg = pint.get_application_registry()
     >>> q = 500 * ureg.nm
     >>> q.to('Hz')
     Traceback (most recent call last):
@@ -197,7 +197,7 @@ functions. For example:
 
 .. doctest::
 
-    >>> ureg = pint.UnitRegistry()
+    >>> ureg = pint.get_application_registry()
     >>> c = pint.Context('ab')
     >>> c.add_transformation('[length]', '[time]',
     ...                      lambda ureg, x: x / ureg.speed_of_light)
@@ -258,7 +258,7 @@ Programmatically:
 
 .. code-block:: python
 
-    >>> ureg = pint.UnitRegistry()
+    >>> ureg = pint.get_application_registry()
     >>> q = ureg.Quantity("1 BTU")
     >>> q.to("J")
     1055.056 joule
@@ -278,7 +278,7 @@ Or with a definitions file::
 
 .. code-block:: python
 
-    >>> ureg = pint.UnitRegistry()
+    >>> ureg = pint.get_application_registry()
     >>> ureg.load_definitions("somefile.txt")
     >>> q = ureg.Quantity("1 BTU")
     >>> q.to("J")

diff --git a/docs/user/formatting.rst b/docs/user/formatting.rst
@@ -26,7 +26,7 @@ In case the format is omitted, the corresponding value in the object's
 
 .. ipython::
 
-   In [1]: ureg = pint.UnitRegistry()
+   In [1]: ureg = pint.get_application_registry()
       ...: ureg.default_format = "~P"
 
    In [2]: u = ureg.Unit("m ** 2 / s ** 2")
@@ -71,7 +71,7 @@ Let's look at some examples:
 
 .. ipython:: python
 
-   ureg = pint.UnitRegistry()
+   ureg = pint.get_application_registry()
    u = ureg.kg * ureg.m / ureg.s ** 2
 
    f"{u:P}"  # using the pretty format

diff --git a/docs/user/numpy.ipynb b/docs/user/numpy.ipynb
@@ -38,7 +38,7 @@
     "# Import Pint\n",
     "import pint\n",
     "\n",
-    "ureg = pint.UnitRegistry()\n",
+    "ureg = pint.get_application_registry()\n",
     "Q_ = ureg.Quantity\n",
     "\n",
     "# Silence NEP 18 warning\n",

diff --git a/docs/user/plotting.rst b/docs/user/plotting.rst
@@ -13,12 +13,12 @@ a **UnitRegistry**:
 .. testsetup:: *
 
    import pint
-   ureg = pint.UnitRegistry()
+   ureg = pint.get_application_registry()
 
 .. doctest::
 
    >>> import pint
-   >>> ureg = pint.UnitRegistry()
+   >>> ureg = pint.get_application_registry()
    >>> ureg.setup_matplotlib()
 
 This support can also be disabled with:
@@ -36,7 +36,7 @@ This allows plotting quantities with different units:
    import numpy as np
    import pint
 
-   ureg = pint.UnitRegistry()
+   ureg = pint.get_application_registry()
    ureg.setup_matplotlib(True)
 
    y = np.linspace(0, 30) * ureg.miles
@@ -56,7 +56,7 @@ This also allows controlling the actual plotting units for the x and y axes:
    import numpy as np
    import pint
 
-   ureg = pint.UnitRegistry()
+   ureg = pint.get_application_registry()
    ureg.setup_matplotlib(True)
 
    y = np.linspace(0, 30) * ureg.miles
@@ -79,7 +79,7 @@ Users have the possibility to change the format of the units on the plot:
    import numpy as np
    import pint
 
-   ureg = pint.UnitRegistry()
+   ureg = pint.get_application_registry()
    ureg.setup_matplotlib(True)
 
    ureg.mpl_formatter = "{:~P}"