* Import scaling into uw. (#554)

* Fix docstrings & doctests. * Rename pull request template as Github doesn't appear to register it with upper case naming. * Fix test in config which Py3.8 is complaining about.
underworldcode · Jul 7, 2021 · 19d3c5d · 19d3c5d
1 parent 1c314e6
commit 19d3c5d
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 6 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md → .github/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE.md → .github/pull_request_template.md
diff --git a/underworld/__init__.py b/underworld/__init__.py
@@ -159,6 +159,7 @@ def _set_init_sig_as_sig(mod):
 _set_init_sig_as_sig(underworld.utils)
 timing._add_timing_to_mod(underworld.utils)
 
+import underworld.scaling
 
 # to allow our legacy doctest formats
 try:

diff --git a/underworld/libUnderworld/config/utils/options.py b/underworld/libUnderworld/config/utils/options.py
@@ -233,7 +233,7 @@ def make_help_string(self):
         elif v.type == "enum":
             help += v._pref_sep + "<%s>" % "|".join(v.enum.values())
         elif v.type == "bool":
-            if v._pref_true_flag is "":
+            if v._pref_true_flag == "":
                 help = "[" + help + "]"
             else:
                 help += v._pref_sep + "<" + v._pref_true_flag + \

diff --git a/underworld/scaling/_scaling.py b/underworld/scaling/_scaling.py
@@ -41,14 +41,17 @@ def non_dimensionalise(dimValue):
 
     Parameters
     ----------
-    dimValue : pint quantity
+    dimValue : pint.Quantity 
+        A pint quantity.
 
     Returns
     -------
-    float: The scaled value.
+    float 
+        The scaled value.
+
+    Example
+    -------
 
-    Example:
-    --------
     >>> import underworld as uw
     >>> u = uw.scaling.units
 

diff --git a/underworld/systems/_energy_solver.py b/underworld/systems/_energy_solver.py
@@ -138,7 +138,7 @@ def _check_linearity(self, nonLinearIterate):
 
     def configure(self,solve_type=""):
         """
-        Configure velocity/inner solver (A11 PETSc prefix).
+        Configure solver.
 
         solve_type can be one of: