source: sasmodels/doc/guide/install.rst @ eb3eb38

core_shell_microgelsmagnetic_modelticket-1257-vesicle-productticket_1156ticket_1265_superballticket_822_more_unit_tests
Last change on this file since eb3eb38 was c0d7ab3, checked in by Paul Kienzle <pkienzle@…>, 7 years ago

split gpu setup from sasmodels installation

  • Property mode set to 100644
File size: 1.5 KB
RevLine 
[990d8df]1********************
2sasmodels Setup
3********************
4
5
6sasmodels Installation
7**********************
8Sasmodels can be installed using a simple pip installation::
9
10    # Won't work yet! For now follow the developer instructions below.
11    $ pip install sasmodels
12
13There are a number of dependent python packages which need to be installed
14separately::
15
16    numpy
17    scipy
18    opencl (for speed if your system has OpenCL drivers)
19    tinycc (windows only, if no C compiler and no OpenCL)
20
21When using sasmodels to fit data::
22
23    sasview (for loading data)
24    bumps (for fitting)
25    matplotlib (for displaying results)
26
27For development and testing it is handy to have some additional packages::
28
29    nose (for testing)
30    xmlrunner (for testing)
31    matplotlib (for showing models)
32    docutils (for showing model docs)
33    sphinx (for building docs)
34    wx ([optional] for adjusting parameters interactively)
35
36**Developer Installation**
37
38Developers will need to clone the sasmodels reposistory from github::
39
40    $ git clone https://github.com/sasview/sasmodels.git
41
42or if you have a github account::
43
44    $ git clone git@github.com:sasview/sasmodels.git
45
46Sasmodels can be run in-place by including the sasmodels directory on the
47python path.  There are numerous ways to do this which will not be outlined
48here.  It will be easiest to install the package in "develop" mode using::
49
50    $ cd sasmodels
51    $ python setup.py develop
52
53This will allow you to edit the files in the package and have the changes
54show up immediately in python the next time you load your program.
Note: See TracBrowser for help on using the repository browser.