Commit 8c1d4d87 authored by Owen Arnold's avatar Owen Arnold
Browse files

update install instructions

parent 9d8ab807
## Installation
1. Download and install Mantid from [here](http://download.mantidproject.org/) ensure that you take the official latest release.
1. Open the [MantidPlot](https://www.mantidproject.org/MantidPlot:_General_Concepts_and_Terms) Grapical User Interface which came with your Mantid installation and open the [script window](http://docs.mantidproject.org/v3.7.2/interfaces/ScriptingWindow.html)
1. Download and install MantidWorkbench from [here](http://download.mantidproject.org/) ensure that you take the official or nightly latest release.
1. Open the `MantidWorkbench` Grapical User Interface which came with your Mantid installation and open the script window
1. Download [this](https://git.esss.dk/wedel/wfm_stitching/raw/master/install_wfm_stitching.py) python script
1. In the `script window` in MantidPlot open the script you just downloaded `install_wfm_stitching.py` and run it.
1. In the `script window` in `MantidWorkbench` open the script you just downloaded `install_wfm_stitching.py` and run it.
Once the script has run successfully, you will have the wfm_package available for use with Mantid.
......@@ -31,13 +31,13 @@ from wfm_stitching import WFMProcessor
**Common Mistakes**
* On windows, ensure that the python interpreter you are using is the one shipped with Mantid. This is located in the Mantid install directory, i.e. `C:\MantidInstall\bin\mantidpython --classic`
* On Linux, OSX, the pythonpath must be set correctly. This would be done via `export PYTHONPATH=/Applications/MantidPlot.app/Contents/MacOS`, or on linux via `export PYTHONPATH=/opt/Mantid/bin`. After doing this, recheck that the mantid modules are in the python path via `/usr/bin/python -c "import mantid"``, which should produce no error.
* On Linux, OSX, the pythonpath must be set correctly. This would be done via `export PYTHONPATH=/Applications/MantidWorkbench.app/Contents/MacOS`, or on linux via `export PYTHONPATH=/opt/Mantid/bin`. After doing this, recheck that the mantid modules are in the python path via `/usr/bin/python -c "import mantid"``, which should produce no error.
* * You need to ensure that you are using the system python 2.7, and not defaulting to a homebrew or other such package provided version. To be verbose about the version of python used, you can specify `/usr/bin/python`, and that is used in the following.
### Further Notes for installing on Linux and OSX
Note: At the time of writing, only python 2.7 is supported
Note: At the time of writing, python 3.5+ is supported
* Check that Mantid is in the python path. Official releases on linux should automatically add themselves. You can check this by running
......@@ -45,7 +45,7 @@ Note: At the time of writing, only python 2.7 is supported
If this works without issue then, skip forward to the installation of wfm-stitching below. If the command above produces an error, then you must manually add Mantid to your python path.
On OSX this would be done via `export PYTHONPATH=/Applications/MantidPlot.app/Contents/MacOS`, or on linux via `export PYTHONPATH=/opt/Mantid/bin`. After doing this, recheck that the mantid modules are in the python path via `/usr/bin/python -c "import mantid"``, which should produce no error.
On OSX this would be done via `export PYTHONPATH=/Applications/MantidWorkbench.app/Contents/MacOS`, or on linux via `export PYTHONPATH=/opt/Mantid/bin`. After doing this, recheck that the mantid modules are in the python path via `/usr/bin/python -c "import mantid"``, which should produce no error.
### Astropy caveat and versioning
......@@ -53,6 +53,6 @@ Astropy, the up-to-date pacakge for loading fits files, [does not install cleanl
```PyFITS is deprecated, please use astropy.io.fits PyFITSDeprecationWarning```
If you want to use astropy, instead and have a suitable environement to support it, you can install it by using `v0.1.2` of this package, which you can pass as a command line argument (`-v`) to the [installation script](https://git.esss.dk/wedel/wfm_stitching/raw/master/install_wfm_stitching.py).
If you want to use astropy, instead and have a suitable environement to support it, you can install it by using `v0.1.3` of this package, which you can pass as a command line argument (`-v`) to the [installation script](https://git.esss.dk/wedel/wfm_stitching/raw/master/install_wfm_stitching.py).
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment