Changeset ade01a0 in sasmodels

Timestamp:

Feb 24, 2019 7:11:27 PM (5 years ago)

Author:

Paul Kienzle <pkienzle@…>

Branches:

master, core_shell_microgels, magnetic_model, ticket-1257-vesicle-product, ticket_1156, ticket_1265_superball, ticket_822_more_unit_tests

Children:

c03e0cc

Parents:

cd28947

Message:

improve tutorial shown on the github landing page for sasmodels

File:

• README.rst (modified) (2 diffs)

README.rst

@@ -10 +10 @@
 is available.
 
-Example
+Install
 -------
+
+The easiest way to use sasmodels is from `SasView <http://www.sasview.org/>`.
+
+You can also install sasmodels as a standalone package in python. Using
+`miniconda <https://docs.conda.io/en/latest/miniconda.html>`
+(or `anaconda <https://www.anaconda.com/>`),
+create a python environment with the sasmodels dependencies::
+
+    $ conda create -n sasmodels -c conda-forge numpy scipy matplotlib pyopencl
+
+The option `-n sasmodels` names the environment sasmodels, and the option
+`-c conda-forge` selects the conda-forge package channel because pyopencl
+is not part of the base anaconda distribution.
+
+Activate the environment and install sasmodels::
+
+    $ conda activate sasmodels
+    (sasmodels) $ pip install sasmodels
+
+Install `bumps <https://github.com/bumps/bumps>` if you want to use it to fit
+your data::
+
+    (sasmodels) $ pip install bumps
+
+Usage
+-----
+
+Check that the works::
+
+    (sasmodels) $ python -m sasmodels.compare cylinder
+
+To show the orientation explorer::
+
+    (sasmodels) $ python -m sasmodels.jitter
+
+Documentation is available online as part of the SasView
+`fitting perspective <http://www.sasview.org/docs/index.html>`_
+as well as separate pages for
+`individual models <http://www.sasview.org/docs/user/sasgui/perspectives/fitting/models/index.html>`_.
+Programming details for sasmodels are available in the
+`developer documentation <http://www.sasview.org/docs/dev/dev.html>`_.
+
+
+Fitting Example
+---------------
 
 The example directory contains a radial+tangential data set for an oriented
 rod-like shape.
 
-The data is loaded by sas.dataloader from the sasview package, so sasview
-is needed to run the example.
+To load the example data, you will need the SAS data loader from the sasview
+package. This is not yet available on PyPI, so you will need a copy of the
+SasView source code to run it.  Create a directory somewhere to hold the
+sasview and sasmodels source code, which we will refer to as $SOURCE.
 
-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::
+Use the following to install sasview, and the sasmodels examples::
 
-    PYTHONPATH=..:../../sasview/src ../../bumps/run.py fit.py \
-        cylinder --preview
+    (sasmodels) $ cd $SOURCE
+    (sasmodels) $ conda install git
+    (sasmodels) $ git clone https://github.com/sasview/sasview.git
+    (sasmodels) $ git clone https://github.com/sasview/sasmodels.git
 
-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::
+Set the path to the sasview source on your python path within the sasmodels
+environment.  On Windows, this will be::
 
-    bumps fit.py cylinder --preview
+    (sasmodels)> set PYTHONPATH="$SOURCE\sasview\src"
+    (sasmodels)> cd $SOURCE/sasmodels/example
+    (sasmodels)> python -m bumps.cli fit.py cylinder --preview
+
+On Mac/Linux with the standard shell this will be::
+
+    (sasmodels) $ export PYTHONPATH="$SOURCE/sasview/src"
+    (sasmodels) $ cd $SOURCE/sasmodels/example
+    (sasmodels) $ bumps fit.py cylinder --preview
 
 The fit.py model accepts up to two arguments.  The first argument is the
@@ -38 +92 @@
 both radial and tangential simultaneously, use the word "both".
 
-Notes
------
-
-cylinder.c + cylinder.py is the cylinder model with renamed variables and
-sld scaled by 1e6 so the numbers are nicer.  The model name is "cylinder"
-
-lamellar.py is an example of a single file model with embedded C code.
+See `bumps documentation <https://bumps.readthedocs.io/>` for detailed
+instructions on running the fit.
 
 |TravisStatus|_