source: sasview/INSTALL.txt

ESS_GUI_beta_approx
Last change on this file was 26c9b85, checked in by Paul Kienzle <pkienzle@…>, 17 months ago

DOC: build documentation for command line improved (#45)

DOC: put build docs into INSTALL.txt

  • Property mode set to 100644
File size: 1.4 KB
Line 
1Quick Intro for Building Sasview
2================================
3
4Note - at the current time sasview will only run in gui form under Python 2.
5
6Before trying to install and run sasview you'll need to check what
7dependencies are required:
8
9$ python check_packages.py
10
11Many of these are available from PyPi, but some (e.g. h5py) may require more
12involvement to build and install. If you use the conda package manager then
13many of the pre-built dependencies are available there. This may be the easiest
14route if you are on windows.
15
16The 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
22If 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
26On OSX or windows you may need to use:
27
28$ pythonw run.py
29
30
31Build scripts that are used on http://build.sasview.org/ are in
32build_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
38The scripts can be customized using environment variables, but
39should do a reasonable job as is in a sane setup.
40
41
42
43To build just the Sphinx docs:
44build_sphinx.py
45
46
47More information can be found here:
48
49http://www.sasview.org/help.html
50http://www.sasview.org/faq.html
51http://www.sasview.org/trac/wiki/DevNotes
Note: See TracBrowser for help on using the repository browser.