ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalcmagnetic_scattrelease-4.2.2ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change
on this file since 094b9eb was
26c9b85,
checked in by Paul Kienzle <pkienzle@…>, 8 years 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
|
Rev | Line | |
---|
[d09f0ae1] | 1 | Quick Intro for Building Sasview |
---|
| 2 | ================================ |
---|
| 3 | |
---|
[26c9b85] | 4 | Note - at the current time sasview will only run in gui form under Python 2. |
---|
[d09f0ae1] | 5 | |
---|
[26c9b85] | 6 | Before trying to install and run sasview you'll need to check what |
---|
| 7 | dependencies are required: |
---|
[d09f0ae1] | 8 | |
---|
[26c9b85] | 9 | $ python check_packages.py |
---|
[d09f0ae1] | 10 | |
---|
[26c9b85] | 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. |
---|
[d09f0ae1] | 15 | |
---|
[26c9b85] | 16 | The build works in the pythonic way: |
---|
[d09f0ae1] | 17 | |
---|
[26c9b85] | 18 | $ python setup.py build # will build the package underneath 'build/' |
---|
| 19 | $ python setup.py install # will install the package into site-packages |
---|
[d09f0ae1] | 20 | |
---|
| 21 | |
---|
[26c9b85] | 22 | If you want to check the build without installing: |
---|
[d09f0ae1] | 23 | |
---|
[26c9b85] | 24 | $ python run.py # will run the code in place (building the C code once, if required) |
---|
[d09f0ae1] | 25 | |
---|
[26c9b85] | 26 | On OSX or windows you may need to use: |
---|
[d09f0ae1] | 27 | |
---|
[26c9b85] | 28 | $ pythonw run.py |
---|
[d09f0ae1] | 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.html |
---|
| 50 | http://www.sasview.org/faq.html |
---|
| 51 | http://www.sasview.org/trac/wiki/DevNotes |
---|
Note: See
TracBrowser
for help on using the repository browser.