Changeset 5d3d7b4 in sasmodels for README.rst

Timestamp:

Sep 4, 2014 11:40:26 AM (10 years ago)

Author:

Paul Kienzle <pkienzle@…>

Branches:

master, core_shell_microgels, costrafo411, magnetic_model, release_v0.94, release_v0.95, ticket-1257-vesicle-product, ticket_1156, ticket_1265_superball, ticket_822_more_unit_tests

Children:

6798848

Parents:

6ce1a29

Message:

fix tangential and simultaneous fit in example

File:

• README.rst (modified) (1 diff)

README.rst

@@ -9 +9 @@
 the distributed package.  New models can be added if OpenCL or a C compiler
 is available.
+
+Example
+-------
+
+The example directory contains a radial+tangential data set for an oriented
+rod-like shape.
+
+The data is loaded by sans.dataloader from the sasview package, so sasview
+is needed to run the example.
+
+To run the example, you need sasview, sasmodels and bumps.  Assuming these
+repositories are installed side by side, change to the sasmodels/example
+directory and enter::
+
+    PYTHONPATH=..:../../sasview/src ../../bumps/run.py fit.py \
+        cylinder --preview
+
+See bumps documentation for instructions on running the fit.  With the
+python packages installed, e.g., into a virtual environment, then the
+python path need not be set, and the command would be::
+
+    bumps fit.py cylinder --preview
+
+The fit.py model accepts up to two arguments.  The first argument is the
+model type, which has been defined for cylinder, capped_cylinder,
+core_shell_cylinder, ellipsoid, triaxial_ellipsoid and lamellar.  The
+second argument is view, which can be radial or tangential.  To fit
+both radial and tangential simultaneously, use the word "both".
+
+Notes
+-----
 
 cylinder.c + cylinder.py is the cylinder model with renamed variables and