Changes in README.rst [2a64722:e30d645] in sasmodels

File:

• README.rst (modified) (2 diffs)

README.rst

@@ -10 +10 @@
 is available.
 
-Install
+Example
 -------
-
-The easiest way to use sasmodels is from `SasView <http://www.sasview.org/>`_.
-
-You can also install sasmodels as a standalone package in python. Use
-`miniconda <https://docs.conda.io/en/latest/miniconda.html>`_
-or `anaconda <https://www.anaconda.com/>`_
-to 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.
 
-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.
+The data is loaded by sas.dataloader from the sasview package, so sasview
+is needed to run the example.
 
-Use the following to install sasview, and the sasmodels examples::
+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::
 
-    (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
+    PYTHONPATH=..:../../sasview/src ../../bumps/run.py fit.py \
+        cylinder --preview
 
-Set the path to the sasview source on your python path within the sasmodels
-environment.  On Windows, this will be::
+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::
 
-    (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
+    bumps fit.py cylinder --preview
 
 The fit.py model accepts up to two arguments.  The first argument is the
@@ -92 +38 @@
 both radial and tangential simultaneously, use the word "both".
 
-See `bumps documentation <https://bumps.readthedocs.io/>`_ for detailed
-instructions on running the fit.
+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.
 
 |TravisStatus|_