Commit 009069a6 authored by Jon Pye's avatar Jon Pye
Browse files

more markdown documentation

parent c7dd2d26
......@@ -2,24 +2,26 @@
#### It is not necessary to install these to follow the demo on Tuesday. The presentation will not assume you are also going through the steps, and will show you the results of what's being entered/run. If you want to follow along on your own machine, though, these packages are the ones you'll need.
### For working in a GUI - QGIS: It helps to do this install first, because for some OSes, it will automatically install requirements we'll need later for the Python install.
### For working in a GUI - QGIS:
It helps to do this install first, because for some OSes, it will automatically install requirements we'll need later for the Python install.
link: https://www.qgis.org/en/site/forusers/download.html
Mac users note - you will need to install the secondary packages from kyngchaos.com listed on this site.
*Mac users note - you will need to install the secondary packages from kyngchaos.com listed on this site.*
### Working in Python - CartoPy:
Python, cartopy, and owslib are needed. Below we will create a Python virtual environment to hold these things and all their prerequisites. I will try and be OS-agnostic in these instructions, apologies if they are incomplete for your distribution.
1) Getting Python:
*1) Getting Python:*
link: https://www.python.org/download/releases/2.7/
Follow instructions for your OS/platform
Windows users may have to add python to their PATH variable
2) Installing the python package manager pip:
*2) Installing the python package manager pip:*
howto: https://pip.pypa.io/en/latest/installing.html
link: https://bootstrap.pypa.io/get-pip.py
......@@ -27,11 +29,12 @@ run get-pip.py in your new python environment
#> python get-pip.py
3) Now we can install python packages on the command line through pip. In a command-line window (cmd or Terminal), type:
*3) Now we can install python packages on the command line through pip.*
In a command-line window (cmd or Terminal), type:
#> pip install virtualenv
4) Now make a virtual environment somewhere (in your home folder, perhaps):
*4) Now make a virtual environment somewhere (in your home folder, perhaps):*
#> cd place/to/put/my/python/virtualenvs
#> virtualenv carto-demo
......@@ -45,7 +48,8 @@ Mac/Linux:
#> source carto-demo/bin/activate
5) Now we can use pip to install (most of) the rest of our requirements
*5) Now we can use pip to install (most of) the rest of our requirements*
pip will install prerequisites, so this is the most painless way to do things
#> pip install matplotlib
......@@ -57,12 +61,12 @@ pip will install prerequisites, so this is the most painless way to do things
#> pip install pyproj
5a) You may also need to install GDAL (to get PROJ and GEOS), follow these instructions
*5a) You may also need to install GDAL (to get PROJ and GEOS), follow these instructions*
for Windows:
*for Windows:*
http://trac.osgeo.org/osgeo4w/
Mac users:
*Mac users:*
If you use Homebrew, you can install these libraries on the command line:
#> brew install geos
......@@ -73,9 +77,9 @@ or download KyngChaos' GDAL Complete Frameworks .dmg
http://www.kyngchaos.com/software/frameworks#gdal_complete
Alas, cartopy is not in pip's library, we'll have to install it manually
CartoPy is not in pip's library, we'll have to install it manually
6) Install python module cartopy:
*6) Install python module cartopy:*
howto: http://scitools.org.uk/cartopy/docs/latest/installing.html#installing
link: https://github.com/SciTools/cartopy/archive/master.zip
......@@ -85,21 +89,22 @@ link: https://github.com/SciTools/cartopy/archive/master.zip
#> python setup.py install
7) Download the example from the GitLab repo:
*7) Download the example from the GitLab repo:*
https://utility.oceantrack.org/gitlab/jdpye/otn-python-visualization/repository/archive.zip
Using the OSGeo Live Virtual Machine:
1)Download the OSGeo-provided VM with most of this pre-installed:
### Using the OSGeo Live Virtual Machine:
*1)Download the OSGeo-provided VM with most of this pre-installed:*
howto: http://live.osgeo.org/en/quickstart/virtualization_quickstart.html
Your user will 'user', the password is 'user'
Your user will be 'user', the password is 'user'
Sudo will prompt you for this.
2)We still have to update/install various python packages. Right click and open a Terminal, and type:
*2)We still have to update/install various python packages. Right click and open a Terminal, and type:*
#> sudo apt-get install python-dev
#> sudo apt-get install git
......@@ -108,19 +113,19 @@ Sudo will prompt you for this.
#> sudo pip install owslib --upgrade
#> sudo pip install matplotlib --upgrade
3) Grab the latest version of CartoPy
*3) Grab the latest version of CartoPy*
#> wget https://github.com/SciTools/cartopy/archive/master.zip
#> unzip master.zip
#> cd cartopy-master/
#> sudo python setup.py install
Download the owslib example from the OTN GitLab
*4) Download the owslib example from the OTN GitLab*
#> wget https://utility.oceantrack.org/gitlab/jdpye/otn-python-visualization/repository/archive.zip --no-check-certificate
#> unzip archive.zip
Run the owslib example
*5) Run the owslib example*
#> cd otn-python-visualization.git
#> python owslib_example.py
\ No newline at end of file
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