-
Notifications
You must be signed in to change notification settings - Fork 70
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Matt Garthwaite
authored and
Matt Garthwaite
committed
May 22, 2017
1 parent
a77f6ee
commit bce00e8
Showing
5 changed files
with
173 additions
and
86 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,40 +1,73 @@ | ||
# Installation | ||
|
||
## Quickstart | ||
Before you start, you will need to have a number of packages installed on your | ||
Linux system. These can either be installed directly onto the system, or you | ||
can use a virtual environment. | ||
|
||
Before you start, make sure your system has the following packages installed: | ||
|
||
## Direct Install | ||
|
||
Make sure your system has the following packages installed. If not, run the | ||
command: | ||
|
||
sudo apt-get install gdal-bin libgdal-dev libpng12-dev libblas-dev liblapack-dev libatlas-dev libatlas-base-dev gfortran libproj-dev openmpi-bin libopenmpi-dev netcdf-bin libnetcdf11 libnetcdf-dev | ||
|
||
|
||
We strongly recommend using a [`virtualenv`](https://gist.github.com/basaks/b33ea9106c7d1d72ac3a79fdcea430eb). | ||
## Virtual Environment | ||
|
||
You can use one of the two virtual environment options below: | ||
|
||
Note: if you are using a HPC environment, refer to [these instructions instead](hpc.html). | ||
|
||
|
||
### Virtualenv | ||
|
||
1. Install [`virtualenv`](https://gist.github.com/basaks/b33ea9106c7d1d72ac3a79fdcea430eb). | ||
|
||
2. You may need to install a slightly older `python-daemon` to install PyRate: | ||
|
||
One might need to install a slightly older `python-daemon` to install `PyRate`: | ||
|
||
pip install python-daemon==2.1.1 | ||
|
||
To install, simply run ``setup.py``: | ||
3. Install PyRate by using one of the following options. | ||
|
||
-- Run ``setup.py``: | ||
|
||
|
||
python setup.py install | ||
|
||
or install with ``pip``: | ||
-- Install the latest version of PyRate with ``pip`` from github: | ||
|
||
|
||
pip install git+https://github.com/GeoscienceAustralia/PyRate | ||
|
||
The python requirements should automatically be built and installed. | ||
-- PyRate is also on ``pypi``, the Python package manager. To install, run: | ||
|
||
|
||
pip install Py-Rate | ||
|
||
The Python requirements should automatically be built and installed. | ||
|
||
|
||
### Anaconda | ||
|
||
## Anaconda setup for `PyRate` | ||
For using PyRate in an Anaconda environment [use this | ||
guide](https://github.com/GeoscienceAustralia/PyRate/blob/master/conda.md). | ||
|
||
For anaconda installation and `virtualenv` instruction, [see this guide](https://github.com/GeoscienceAustralia/PyRate/blob/master/conda.md). | ||
|
||
## Tests | ||
|
||
Tests use [pytest](http://doc.pytest.org/en/latest/) and can be found in *tests*. | ||
A suite of tests have been developed for use in testing PyRate functionality | ||
and for further code development. The tests use | ||
[pytest](http://doc.pytest.org/en/latest/) and can be found in the *tests/* | ||
directory. A small test dataset is included in the *tests/test_data/* | ||
directory. | ||
|
||
To run the tests, use the following command inside the `PyRate` directory: | ||
To run the tests, use the following command inside the top level *PyRate/* | ||
directory: | ||
|
||
pip install pytest | ||
cd PyRate | ||
export PYRATEPATH=/path/to/PyRate | ||
pytest tests/ | ||
pip install pytest | ||
cd PyRate | ||
export PYRATEPATH=/path/to/PyRate | ||
pytest tests/ | ||
|
Oops, something went wrong.