|
|
|
# Overview
|
|
|
|
To make the installation of ShakeMap as simple as possible, we have tried to keep all dependencies to be python packages. We support and regularly test the install script and code on Linux and Mac OSX systems. The programs should also be able to work on Windows systems but we do not provide support for Windows installations.
|
|
|
|
|
|
|
|
We also make use of [conda virtual environments](https://conda.io/docs/user-guide/concepts.html#conda-environments). The purpose of this is to try to achieve a fully self-contained environment and avoid conflicts with other software. We have discovered that there are some problems with this strategy in shells other than bash. The use of the install script and conda virtual environments are not required to run ShakeMap, but manually managing the dependencies is difficult and you should be aware that if you choose to do this then you should expect to encounter significant difficulties. That said, the list of dependencies is given in the `environment.yml` file in the root directory. Additionally
|
|
|
|
* `environment_linux.yml` provides the comprehensive list of all dependencies (including indirect dependencies) with specific version numbers for linux systems.
|
|
|
|
* `environment_osx.yml` is the same except for OSX.
|
|
|
|
|
|
|
|
# Instructions
|
|
|
|
If you are already using conda virtual environments, return to root before proceeding
|
|
|
|
```
|
|
|
|
> conda deactivate
|
|
|
|
```
|
|
|
|
And clone this repository
|
|
|
|
```
|
|
|
|
> git clone https://github.com/usgs/shakemap.git shakemap_src
|
|
|
|
```
|
|
|
|
|
|
|
|
Run the install script in the cloned repository
|
|
|
|
```
|
|
|
|
> cd shakemap_src
|
|
|
|
> bash install.sh
|
|
|
|
```
|
|
|
|
If no version of `conda` is detected, it will install [miniconda](https://conda.io/miniconda.html), which we use for managing dependencies and creating a virtual environment for running ShakeMap.
|
|
|
|
|
|
|
|
If the script finishes without errors, then the final two lines of output will be
|
|
|
|
```
|
|
|
|
Successfully installed shakemap
|
|
|
|
Type 'conda activate shakemap' to use this new virtual environment.
|
|
|
|
```
|
|
|
|
|
|
|
|
Last, activate the shakemap virtual environment
|
|
|
|
```
|
|
|
|
> conda activate shakemap
|
|
|
|
```
|
|
|
|
|
|
|
|
---
|
|
|
|
Next step: [Testing](testing) |
|
|
|
\ No newline at end of file |
