1 | Quick Intro for Building Sasview |
---|
2 | ================================ |
---|
3 | |
---|
4 | Note - at the current time sasview will only run in gui form under Python 2. |
---|
5 | |
---|
6 | Before trying to install and run sasview you'll need to check what |
---|
7 | dependencies are required: |
---|
8 | |
---|
9 | $ python check_packages.py |
---|
10 | |
---|
11 | Many of these are available from PyPi, but some (e.g. h5py) may require more |
---|
12 | involvement to build and install. If you use the conda package manager then |
---|
13 | many of the pre-built dependencies are available there. This may be the easiest |
---|
14 | route if you are on windows. |
---|
15 | |
---|
16 | The build works in the pythonic way: |
---|
17 | |
---|
18 | $ python setup.py build # will build the package underneath 'build/' |
---|
19 | $ python setup.py install # will install the package into site-packages |
---|
20 | |
---|
21 | |
---|
22 | If you want to check the build without installing: |
---|
23 | |
---|
24 | $ python run.py # will run the code in place (building the C code once, if required) |
---|
25 | |
---|
26 | On OSX or windows you may need to use: |
---|
27 | |
---|
28 | $ pythonw run.py |
---|
29 | |
---|
30 | |
---|
31 | Build scripts that are used on http://build.sasview.org/ are in |
---|
32 | build_tools. Make sure the build is run first obviously. |
---|
33 | |
---|
34 | $ build_tools/jenkins_linux_build.sh |
---|
35 | $ build_tools/jenkins_linux_test.sh |
---|
36 | $ build_tools/jenkins_linux_pylint.sh |
---|
37 | |
---|
38 | The scripts can be customized using environment variables, but |
---|
39 | should do a reasonable job as is in a sane setup. |
---|
40 | |
---|
41 | |
---|
42 | |
---|
43 | To build just the Sphinx docs: |
---|
44 | build_sphinx.py |
---|
45 | |
---|
46 | |
---|
47 | More information can be found here: |
---|
48 | |
---|
49 | http://www.sasview.org/help/ |
---|
50 | http://www.sasview.org/faq/ |
---|
51 | http://www.sasview.org/trac/wiki/DevNotes |
---|