Changeset f41027b in sasmodels for doc

Timestamp:

Jul 19, 2018 11:12:48 AM (6 years ago)

Author:

Paul Kienzle <pkienzle@…>

Branches:

master

Children:

d0fdba2

Parents:

7609046

Message:

change environment variable for distributions to SAS_WEIGHTS_PATH

File:

• doc/guide/pd/polydispersity.rst (modified) (1 diff)

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