Changes between Version 16 and Version 17 of ModelConvInst

Timestamp:

Nov 22, 2015 12:31:11 AM (8 years ago)

Author:

pkienzle

Comment:

—

ModelConvInst

@@ -56 +56 @@
   - "volume" parameters are passed to Iq(), Iqxy(), and form_volume(), and have polydispersity loops generated automatically.
   - "orientation" parameters are only passed to Iqxy().
+ - "units" is the string that is displayed to the user in the user interface.  This is not latex markup.  If you want the manual to show fancy markup, do the following:
+  - check RST_UNITS variable near the top of [https://github.com/SasView/sasmodels/tree/master/sasmodels/generate.py sasmodels/generate.py] for units with special markup
+  - if you don't see the units you need there, make a new entry in the RST_UNITS table
+  - use the macros defined in [https://github.com/SasView/sasmodels/tree/master/doc/rst_prolog doc/rst_prolog], or add your own if needed
+  - if the markup is trivial, or if the it is really a one-off, then you can put the restructured text commands into RST_UNITS directly (I'm not sure if $latex$ works in this context)
+  - if there is enough demand, we can set units to "display string|markup string" and have the model loader/documentation generator select the correct version for whomever is asking
 - **THE COMPUTATION**
  - Pure Python
@@ -109 +115 @@
 '''TEST YOUR NEW/NEWLY-CONVERTED MODEL'''
 
-Test your new model by runing compare.py to verify that the converted model is giving the same results as it did in SasView prior to conversion. In order to do this, you need either a version of SasView installed in your python path, or a locally-built SasView in a checked-out directory ''at the same level'' as the checked-out sasmodels repository; i.e. you have the file structure:
+Test your new model by running compare.py to verify that the converted model is giving the same results as it did in !SasView prior to conversion. In order to do this, you need either a version of !SasView installed in your python path, or a locally-built !SasView in a checked-out directory ''at the same level'' as the checked-out sasmodels repository; i.e. you have the file structure:
 
 {{{
@@ -122 +128 @@
 }}}
 
-If using a locally-built SasView, you need to add ''drive:\some_folder\sasview'' to your PYTHONPATH environment variable, or use \sasmodels\compare.sh which will do so for you. If you don't have PYTHONPATH, use the ''User'' PATH variable instead. 
+If using a locally-built !SasView, you need to add ''drive:\some_folder\sasview'' to your PYTHONPATH environment variable, or use \sasmodels\compare.sh which will do so for you. If you don't have PYTHONPATH, use the ''User'' PATH variable instead. 
 
 The first thing to test is that you are getting the same answer as !SasView for the 1D version of the model. This is done with:
@@ -130 +136 @@
 }}}
 
-This will result in some comparison metrics between the openCL implementation (if installed - should revert to using ctypes if no OpenCL is installed) and a plot of the two calculations and a comparison plot.
+This will result in some comparison metrics between the OpenCL implementation (if installed - should revert to using ctypes if no OpenCL is installed) and a plot of the two calculations and a comparison plot.
 
 If the model has 2D orientational calculation, then you should additionally test with:
@@ -146 +152 @@
 }}}
 
+'''CHECK THE DOCS'''
+
+To build the docs you will need:
+- sphinx
+{{{
+conda install sphinx
+}}}
+- gnu make (e.g., from http://gnuwin32.sourceforge.net/packages.html, or maybe there is an anaconda mingw package)
+
+Make sure C:\Program Files (x86)\!GnuWin32\bin and C:\Python27 are on your path.
+
+Build the docs by changing into path/to/sasmodels/doc and typing "make html".
+
+Navigate to path/to/sasmodels/doc/_build/html in your file browser and open index.html.  You will need to use firefox, chrome or safari since internet explorer doesn't seem to support mathjax from a local file.
+
 '''FINALLY'''