Changeset f41027b in sasmodels

Timestamp:

Jul 19, 2018 1:12:48 PM (6 years ago)

Author:

Paul Kienzle <pkienzle@…>

Branches:

master

Children:

d0fdba2

Parents:

7609046

Message:

change environment variable for distributions to SAS_WEIGHTS_PATH

Files:

• doc/guide/pd/polydispersity.rst (modified) (1 diff)
• sasmodels/compare.py (modified) (1 diff)
• sasmodels/weights.py (modified) (2 diffs)

doc/guide/pd/polydispersity.rst

@@ -405 +405 @@
 the volume fraction to lie between zero and one.
 
-To activate a user-defined distribution, set the following environment variable:
-
-    SASMODELS_WEIGHTS=path/to/folder/name_of_distribution.py
+To activate a user-defined distribution, put it in a file such as *distname.py*
+in the *SAS_WEIGHTS_PATH* folder.  This is defined with an environment
+variable, defaulting to::
+
+    SAS_WEIGHTS_PATH=~/.sasview/weights
+
+The weights path is loaded on startup.  To update the distribution definition
+in a running application you will need to enter the following python commands::
+
+    import sasmodels.weights
+    sasmodels.weights.load_weights('path/to/distname.py')
 
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ

sasmodels/compare.py

@@ -115 +115 @@
     === environment variables ===
     -DSAS_MODELPATH=path sets directory containing custom models
+    -DSAS_WEIGHTS_PATH=path sets directory containing custom distributions
     -DSAS_OPENCL=vendor:device|none sets the target OpenCL device
     -DXDG_CACHE_HOME=~/.cache sets the pyopencl cache root (linux only)

sasmodels/weights.py

@@ -231 +231 @@
 ))
 
-SASMODELS_WEIGHTS = "~/.sasview/weights/*.py"
+SAS_WEIGHTS_PATH = "~/.sasview/weights"
 def load_weights(pattern=None):
     # type: (str) -> None
     """
-    Load dispersion distributions matching the given pattern
+    Load dispersion distributions matching the given glob pattern
     """
     import logging
@@ -244 +244 @@
     from .custom import load_custom_kernel_module
     if pattern is None:
-        pattern = os.environ.get("SASMODELS_WEIGHTS", SASMODELS_WEIGHTS)
+        path = os.environ.get("SAS_WEIGHTS_PATH", SAS_WEIGHTS_PATH)
+        pattern = os.path.join(path, "*.py")
     for filename in sorted(glob.glob(os.path.expanduser(pattern))):
         try: