source: sasmodels/README.rst @ e30d645

core_shell_microgelscostrafo411magnetic_modelticket-1257-vesicle-productticket_1156ticket_1265_superballticket_822_more_unit_tests
Last change on this file since e30d645 was e30d645, checked in by Paul Kienzle <pkienzle@…>, 3 years ago

remove out of date magnetism note from README

  • Property mode set to 100644
File size: 1.8 KB
Line 
1Sasmodels
2=========
3
4Theory models for small angle scattering.
5
6The models provided are usable directly in the bumps fitting package and
7in the sasview analysis package.  If OpenCL is available, the models will
8run much faster.  If not, then precompiled versions will be included with
9the distributed package.  New models can be added if OpenCL or a C compiler
10is available.
11
12Example
13-------
14
15The example directory contains a radial+tangential data set for an oriented
16rod-like shape.
17
18The data is loaded by sas.dataloader from the sasview package, so sasview
19is needed to run the example.
20
21To run the example, you need sasview, sasmodels and bumps.  Assuming these
22repositories are installed side by side, change to the sasmodels/example
23directory and enter::
24
25    PYTHONPATH=..:../../sasview/src ../../bumps/run.py fit.py \
26        cylinder --preview
27
28See bumps documentation for instructions on running the fit.  With the
29python packages installed, e.g., into a virtual environment, then the
30python path need not be set, and the command would be::
31
32    bumps fit.py cylinder --preview
33
34The fit.py model accepts up to two arguments.  The first argument is the
35model type, which has been defined for cylinder, capped_cylinder,
36core_shell_cylinder, ellipsoid, triaxial_ellipsoid and lamellar.  The
37second argument is view, which can be radial or tangential.  To fit
38both radial and tangential simultaneously, use the word "both".
39
40Notes
41-----
42
43cylinder.c + cylinder.py is the cylinder model with renamed variables and
44sld scaled by 1e6 so the numbers are nicer.  The model name is "cylinder"
45
46lamellar.py is an example of a single file model with embedded C code.
47
48|TravisStatus|_
49
50.. |TravisStatus| image:: https://travis-ci.org/SasView/sasmodels.svg?branch=master
51.. _TravisStatus: https://travis-ci.org/SasView/sasmodels
Note: See TracBrowser for help on using the repository browser.