Commit e26573a6 authored by Owen Arnold's avatar Owen Arnold
Browse files

make the install instructions better

parent ce2c458d
......@@ -9,19 +9,17 @@ The next steps will depend on your operating system, so select the heading relat
Note: At the time of writing, only python 2.7 is supported
* Check that Mantid is in the python path. Official releases on linux should automatically add themselves. Check that the path to the Mantid bin directory is listed, i.e.
* 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.
`echo $PYTHONPATH`
* Check that Mantid is in the python path. Official releases on linux should automatically add themselves. You can check this by running
should yield something like:
`/usr/bin/python -c "import mantid"``
`/opt/Mantid/bin/:`
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.
Otherwise it should be set. On OSX this would be done via `export PYTHONPATH=/Applications/MantidPlot.app/Contents/MacOS`, or on linux via `export PYTHONPATH=/opt/Mantid/bin`.
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.
* [Optional Step] We recomment the use of `virtualenv` to install and use `wfm-stitching`, see [here](https://pypi.python.org/pypi/virtualenv) for information on installing and activating a virtual environment
`pip install {path to *.whl}`
`pip install --user {path to *.whl}`
* You can verify that this has installed correctly using:
......@@ -59,7 +57,8 @@ Requires: astropy
### Importing in a Console
You should be able to import from `wfm_stitching`, i.e. in MantidPlot
1. Start a python console. On linux and osx ensure that you are starting a system python console, on windows, you should use `C:\MantidInstall\bin\mantidpython.bat --classic` as your console.
1. You should be able to import from `wfm_stitching`
```python
from wfm_stitching import WFMProcessor
......@@ -67,8 +66,8 @@ 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\python`
* On Linux, OSX, the pythonpath must be set correctly (show via `echo $PYTHONPATH`) which must point to the Mantid install directory.
* 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 revisit the section describing how to do this above.
### Importing in MantidPlot
......
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