Document macOS setup instructions #499
Conversation
docs/setup.rst
Outdated
| @@ -16,6 +16,20 @@ You can get the library directly from PyPI: | |||
|
|
|||
| .. note:: Raster Vision requires Python 3 or later. | |||
|
|
|||
| macOS Installation | |||
There was a problem hiding this comment.
I did not have to do this for my MacOS installation, for whatever reason - it could be because the necessary libraries were installed with other dependencies previously. Considering that, should we frame this more as a "if you have the following issues, you might need to do this" rather than as the definitive Mac install instructions? That way we don't encourage folk to install an unreleased version of pyproj if they don't have to.
I think another thing besides Mac that's worth maybe mentioning is that it's a python 3.7 issue (which was mentioned in the pyproj issues you linked to in #487)
There was a problem hiding this comment.
Ah, okay -- that makes sense. If we're okay keeping the header, I can change it to something like...
Troubleshooting macOS Installation
If you encounter problems running pip install rastervision on macOS, you may have to manually install Cython and pyproj. To circumvent an issue installing pyproj with Python 3.7, you may also have to install it using git+https:
... instructions
Tensorflow header
....
There was a problem hiding this comment.
I think that makes sense. Thanks!
Getting `pip install rastervision` to work on macOS may require installing some dependencies manually. This change updates the documentation to add guidance for installing Cython as a pre-req as well as guidance for installing pyproj with git+https when using Python 3.7. The change also places a subheading before the AWS/Tensorflow/Keras installation instructions to distinguish them from the macOS troubleshooting instructions.
|
Great, thank you. I'll merge once Travis goes green. |
|
I cherry picked the commit to the 0.8 branch so it should be on the docs site soon. |
Overview
This PR updates the Raster Vision docs to include macOS specific setup instructions which I used to circumvent the problems I encountered in #487.
The minimal set of manual installation requirements seems to be:
...before
pip install rastervision. The git+https install for pyproj seems to be required on macOS, according to pyproj4/pyproj#138 and pyproj4/pyproj#136Testing Instructions
From a clean install on macOS High Sierra, follow the the new macOS specific setup instructions and verify that they work.
After installation, you should be able to run
...without error.
Closes #487