| [990d8df] | 1 | ******************** |
|---|
| 2 | sasmodels Setup |
|---|
| 3 | ******************** |
|---|
| 4 | |
|---|
| 5 | |
|---|
| 6 | sasmodels Installation |
|---|
| 7 | ********************** |
|---|
| 8 | Sasmodels 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 | |
|---|
| 13 | There are a number of dependent python packages which need to be installed |
|---|
| 14 | separately:: |
|---|
| 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 | |
|---|
| 21 | When using sasmodels to fit data:: |
|---|
| 22 | |
|---|
| 23 | sasview (for loading data) |
|---|
| 24 | bumps (for fitting) |
|---|
| 25 | matplotlib (for displaying results) |
|---|
| 26 | |
|---|
| 27 | For 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 | |
|---|
| 38 | Developers will need to clone the sasmodels reposistory from github:: |
|---|
| 39 | |
|---|
| 40 | $ git clone https://github.com/sasview/sasmodels.git |
|---|
| 41 | |
|---|
| 42 | or if you have a github account:: |
|---|
| 43 | |
|---|
| 44 | $ git clone git@github.com:sasview/sasmodels.git |
|---|
| 45 | |
|---|
| 46 | Sasmodels can be run in-place by including the sasmodels directory on the |
|---|
| 47 | python path. There are numerous ways to do this which will not be outlined |
|---|
| 48 | here. It will be easiest to install the package in "develop" mode using:: |
|---|
| 49 | |
|---|
| 50 | $ cd sasmodels |
|---|
| 51 | $ python setup.py develop |
|---|
| 52 | |
|---|
| 53 | This will allow you to edit the files in the package and have the changes |
|---|
| 54 | show up immediately in python the next time you load your program. |
|---|
