| 1 |
Installing the API |
| 2 |
------------------- |
| 3 |
|
| 4 |
Installation |
| 5 |
^^^^^^^^^^^^ |
| 6 |
|
| 7 |
Users should proceed as if :ref:`installing RAW from source on their OS of |
| 8 |
choice.<install>` If you are not going to use the RAW GUI from source, |
| 9 |
then you do not need to install the wx package. Once you've installed all |
| 10 |
required packages and downloaded and unpacked the source code, you then |
| 11 |
proceed differently: |
| 12 |
|
| 13 |
#. Open a terminal window and cd into the top level source directory. |
| 14 |
|
| 15 |
#. Install the RAW API using pip with the command ``pip install .`` |
| 16 |
|
| 17 |
The RAW API is now installed and ready to use. |
| 18 |
|
| 19 |
|
| 20 |
Using the RAW GUI from the installed package |
| 21 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 22 |
|
| 23 |
If you don't want to have RAW hanging around in several places, it is possible |
| 24 |
to run the RAW GUI directly from the installed API package on most systems. |
| 25 |
When you install the RAW package, it creates a bioxtas_raw script that |
| 26 |
should be in the system path. You can simply run bioxtas_raw from the |
| 27 |
command line and the RAW GUI should start. |
| 28 |
|
| 29 |
Note: Does not work for older versions of conda on MacOS due to the need |
| 30 |
to use the pythonw command to run GUI programs. Works on modern versions |
| 31 |
of conda. |