| 1 |
OS X and macOS detailed install from source instructions |
| 2 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 3 |
.. _macsource: |
| 4 |
|
| 5 |
#. Install Miniconda python distribution |
| 6 |
|
| 7 |
* Download the free miniconda python 3.x, e.g. 3.8, installer from: |
| 8 |
`https://docs.conda.io/en/latest/miniconda.html <https://docs.conda.io/en/latest/miniconda.html>`_ |
| 9 |
|
| 10 |
* Open a Terminal window. |
| 11 |
|
| 12 |
* In the terminal window type ``cd ~\Downloads`` and hit enter. |
| 13 |
|
| 14 |
* In the terminal window type ``bash Miniconda3-latest-MacOSX-x86_64.sh`` and hit enter. |
| 15 |
|
| 16 |
* Agree to all of the prompts. |
| 17 |
|
| 18 |
* More detailed install instructions are available here: |
| 19 |
`https://conda.io/docs/user-guide/install/macos.html <https://conda.io/docs/user-guide/install/macos.html>`_ |
| 20 |
|
| 21 |
* Close the terminal window. |
| 22 |
|
| 23 |
#. Install the necessary python packages. |
| 24 |
|
| 25 |
* Open a new terminal window as in the previous step |
| 26 |
|
| 27 |
* Type ``conda upgrade conda pip wheel setuptools`` and hit enter. Agree to all the prompts. |
| 28 |
|
| 29 |
* Type ``conda install numpy scipy matplotlib pillow numba h5py cython reportlab`` and hit enter. |
| 30 |
Agree to all the prompts. |
| 31 |
|
| 32 |
* Type ``conda install -c conda-forge wxpython hdf5plugin fabio pyfai mmcif_pdbx svglib`` and hit enter. Agree |
| 33 |
to all prompts. |
| 34 |
|
| 35 |
#. Download RAW from sourceforge |
| 36 |
|
| 37 |
* `https://sourceforge.net/projects/bioxtasraw <https://sourceforge.net/projects/bioxtasraw>`_ |
| 38 |
|
| 39 |
* Navigate to the :guilabel:`Files` tab and download the latest source code, |
| 40 |
:file:`RAW-{x}.{y}.{z}-Source.zip`. Or download the latest development version |
| 41 |
from the git by navigating to the :guilabel:`Code` tab. |
| 42 |
|
| 43 |
#. Expand the downloaded zip file in the Downloads folder by double clicking on it. |
| 44 |
|
| 45 |
* This step may not be necessary, some browsers may automatically expand zip files. |
| 46 |
|
| 47 |
#. In the terminal or in the graphical file manager, confirm that the file named :file:`setup.py` |
| 48 |
is in your expanded raw directory. If it isn’t, it’s likely that when you expanded the |
| 49 |
RAW download, you ended up with unnecessary layers of directories. Find the |
| 50 |
directory with :file:`setup.py` in it, and make that the top level folder. |
| 51 |
|
| 52 |
#. Move the RAW files to Applications folder |
| 53 |
|
| 54 |
* Move the folder that contains all of the RAW files to the :file:`Applications` folder. |
| 55 |
As above, this would be the folder with :file:`setup.py` in it. |
| 56 |
|
| 57 |
* Rename the folder that you just moved to :file:`raw`. |
| 58 |
|
| 59 |
#. In a terminal, change directory into the top level RAW folder |
| 60 |
|
| 61 |
* If you used the suggested path of :file:`Applications/raw` |
| 62 |
type: ``cd /Applications/raw`` |
| 63 |
|
| 64 |
#. Build the extensions. |
| 65 |
|
| 66 |
* ``python setup.py build_ext --inplace`` |
| 67 |
|
| 68 |
#. Navigate to the :file:`bioxtasraw` subfolder |
| 69 |
|
| 70 |
* From the top level RAW folder it should be ``cd ./bioxtasraw`` |
| 71 |
|
| 72 |
#. Run RAW |
| 73 |
|
| 74 |
* ``python RAW.py`` |
| 75 |
|
| 76 |
* Note: Older versions of conda will use the command ``pythonw RAW.py`` |
| 77 |
|
| 78 |
#. Enjoy! |
| 79 |
|
| 80 |
* In the future, you can start RAW as in the previous step. |
| 81 |
|
| 82 |
* If RAW doesn’t work, check out the :ref:`solutions to common problems <mactrb>` |