Improving documentation, in process.

uibcdf · May 25, 2021 · 6f93a8a · 6f93a8a
1 parent f95fa8a
commit 6f93a8a
Show file tree

Hide file tree

Showing 99 changed files with 5,223 additions and 9,811 deletions.
diff --git a/docs/_build/doctrees/contents/AAA.doctree b/docs/_build/doctrees/contents/AAA.doctree
diff --git a/docs/_build/doctrees/contents/Convert.doctree b/docs/_build/doctrees/contents/Convert.doctree
diff --git a/docs/_build/doctrees/contents/Dimensionality.doctree b/docs/_build/doctrees/contents/Dimensionality.doctree
diff --git a/docs/_build/doctrees/contents/Forms.doctree b/docs/_build/doctrees/contents/Forms.doctree
diff --git a/docs/_build/doctrees/contents/Importing.doctree b/docs/_build/doctrees/contents/Importing.doctree
diff --git a/docs/_build/doctrees/contents/In_Your_Library.doctree b/docs/_build/doctrees/contents/In_Your_Library.doctree
diff --git a/docs/_build/doctrees/contents/Quantities_and_Units.doctree b/docs/_build/doctrees/contents/Quantities_and_Units.doctree
diff --git a/docs/_build/doctrees/contents/Quantity_and_Units.doctree b/docs/_build/doctrees/contents/Quantity_and_Units.doctree
diff --git a/docs/_build/doctrees/contents/Quick_Guide.doctree b/docs/_build/doctrees/contents/Quick_Guide.doctree
diff --git a/docs/_build/doctrees/contents/Quick_Tutorial.doctree b/docs/_build/doctrees/contents/Quick_Tutorial.doctree
diff --git a/docs/_build/doctrees/contents/Standardize.doctree b/docs/_build/doctrees/contents/Standardize.doctree
diff --git a/docs/_build/doctrees/contents/Strings.doctree b/docs/_build/doctrees/contents/Strings.doctree
diff --git a/docs/_build/doctrees/contents/Translate.doctree b/docs/_build/doctrees/contents/Translate.doctree
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/doctrees/nbsphinx/contents/AAA.ipynb b/docs/_build/doctrees/nbsphinx/contents/AAA.ipynb
diff --git a/docs/_build/doctrees/nbsphinx/contents/Convert.ipynb b/docs/_build/doctrees/nbsphinx/contents/Convert.ipynb
@@ -15,9 +15,9 @@
    "metadata": {},
    "source": [
     "# Convert quantities\n",
-    "*Text*\n",
+    "*Quantities can be converted into other form and units with PyUnitWizard.*\n",
     "\n",
-    "Text here"
+    "To facilitate the conversion of units between different forms, PyUnitWizard includes the method `pyunitwizard.convert()`. This way quantities and units can be converted between different forms and units:"
    ]
   },
   {
@@ -31,17 +31,127 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 3,
    "metadata": {},
    "outputs": [],
-   "source": []
+   "source": [
+    "puw.configure.load_libraries(['pint', 'simtk.unit'])"
+   ]
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 4,
    "metadata": {},
    "outputs": [],
-   "source": []
+   "source": [
+    "q = puw.quantity(value=3.0, unit='joules', form='simtk.unit')"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "q2 = puw.convert(q, to_unit='kilocalories', to_form='pint')"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/html": [
+       "0.0007170172084130018 kilocalorie"
+      ],
+      "text/latex": [
+       "$0.0007170172084130018\\ \\mathrm{kilocalorie}$"
+      ],
+      "text/plain": [
+       "0.0007170172084130018 <Unit('kilocalorie')>"
+      ]
+     },
+     "execution_count": 6,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "q2"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "If the output form is not specified with the argument `to_form`, a quantity with the same form is obtained:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "q = puw.quantity(value=1000.0, unit='kN/m**2', form='pint')"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 8,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "q2 = puw.convert(q, to_unit='atmospheres')"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 9,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/html": [
+       "9.869232667160128 standard_atmosphere"
+      ],
+      "text/latex": [
+       "$9.869232667160128\\ \\mathrm{standard\\_atmosphere}$"
+      ],
+      "text/plain": [
+       "9.869232667160128 <Unit('standard_atmosphere')>"
+      ]
+     },
+     "execution_count": 9,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "q2"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 11,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'pint'"
+      ]
+     },
+     "execution_count": 11,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "puw.get_form(q2)"
+   ]
   }
  ],
  "metadata": {