<commit_before>     ██▒   █▓ ▄▄▄       ██▓     ██░ ██  ▄▄▄       ██▓     ██▓    ▄▄▄
    ▓██░   █▒▒████▄    ▓██▒    ▓██░ ██▒▒████▄    ▓██▒    ▓██▒   ▒████▄
     ▓██  █▒░▒██  ▀█▄  ▒██░    ▒██▀▀██░▒██  ▀█▄  ▒██░    ▒██░   ▒██  ▀█▄
      ▒██ █░░░██▄▄▄▄██ ▒██░    ░▓█ ░██ ░██▄▄▄▄██ ▒██░    ▒██░   ░██▄▄▄▄██
       ▒▀█░   ▓█   ▓██▒░██████▒░▓█▒░██▓ ▓█   ▓██▒░██████▒░██████▒▓█   ▓██▒
       ░ ▐░   ▒▒   ▓▒█░░ ▒░▓  ░ ▒ ░░▒░▒ ▒▒   ▓▒█░░ ▒░▓  ░░ ▒░▓  ░▒▒   ▓▒█░
       ░ ░░    ▒   ▒▒ ░░ ░ ▒  ░ ▒ ░▒░ ░  ▒   ▒▒ ░░ ░ ▒  ░░ ░ ▒  ░ ▒   ▒▒ ░
         ░░    ░   ▒     ░ ░    ░  ░░ ░  ░   ▒     ░ ░     ░ ░    ░   ▒
          ░        ░  ░    ░  ░ ░  ░  ░      ░  ░    ░  ░    ░  ░     ░  ░
         ░

Valhalla is an open source routing engine and accompanying libraries for use with Open Street Map data. This code, Joerd, can be used to download, merge and generate tiles from digital elevation data. These tiles can then be used in a variety of ways; for display, in [Skadi](https://github.com/valhalla/skadi) for routing, etc... In keeping with the Norse mythological theme, the jotunn/goddess [Jörð](https://en.wikipedia.org/wiki/J%C3%B6r%C3%B0) was chosen as she is the personification of the Earth.

Build Status
------------

[![Circle CI](https://circleci.com/gh/valhalla/joerd.svg?style=svg)](https://circleci.com/gh/valhalla/joerd)

Building
--------

Joerd is a Python command line tool using `setuptools`. To install on a Debian or Ubuntu system, you need to install its dependencies:

```sh
sudo apt-get install python-gdal
```

(NOTE: not sure if this works: I installed GDAL-2.0.1 manually here, but I don't think it really needs it.)

You can then install it (recommended in a `virtualenv`) by running:

```sh
python setup.py install
```

Using
-----
<commit_msg>Add usage information to the README.<commit_after>     ██▒   █▓ ▄▄▄       ██▓     ██░ ██  ▄▄▄       ██▓     ██▓    ▄▄▄
    ▓██░   █▒▒████▄    ▓██▒    ▓██░ ██▒▒████▄    ▓██▒    ▓██▒   ▒████▄
     ▓██  █▒░▒██  ▀█▄  ▒██░    ▒██▀▀██░▒██  ▀█▄  ▒██░    ▒██░   ▒██  ▀█▄
      ▒██ █░░░██▄▄▄▄██ ▒██░    ░▓█ ░██ ░██▄▄▄▄██ ▒██░    ▒██░   ░██▄▄▄▄██
       ▒▀█░   ▓█   ▓██▒░██████▒░▓█▒░██▓ ▓█   ▓██▒░██████▒░██████▒▓█   ▓██▒
       ░ ▐░   ▒▒   ▓▒█░░ ▒░▓  ░ ▒ ░░▒░▒ ▒▒   ▓▒█░░ ▒░▓  ░░ ▒░▓  ░▒▒   ▓▒█░
       ░ ░░    ▒   ▒▒ ░░ ░ ▒  ░ ▒ ░▒░ ░  ▒   ▒▒ ░░ ░ ▒  ░░ ░ ▒  ░ ▒   ▒▒ ░
         ░░    ░   ▒     ░ ░    ░  ░░ ░  ░   ▒     ░ ░     ░ ░    ░   ▒
          ░        ░  ░    ░  ░ ░  ░  ░      ░  ░    ░  ░    ░  ░     ░  ░
         ░

Valhalla is an open source routing engine and accompanying libraries for use with Open Street Map data. This code, Joerd, can be used to download, merge and generate tiles from digital elevation data. These tiles can then be used in a variety of ways; for display, in [Skadi](https://github.com/valhalla/skadi) for routing, etc... In keeping with the Norse mythological theme, the jotunn/goddess [Jörð](https://en.wikipedia.org/wiki/J%C3%B6r%C3%B0) was chosen as she is the personification of the Earth.

Build Status
------------

[![Circle CI](https://circleci.com/gh/valhalla/joerd.svg?style=svg)](https://circleci.com/gh/valhalla/joerd)

Building
--------

Joerd is a Python command line tool using `setuptools`. To install on a Debian or Ubuntu system, you need to install its dependencies:

```sh
sudo apt-get install python-gdal
```

(NOTE: not sure if this works: I installed GDAL-2.0.1 manually here, but I don't think it really needs it.)

You can then install it (recommended in a `virtualenv`) by running:

```sh
python setup.py install
```

Using
-----

Joerd installs as a command line library, and there are currently three commands:

* `download` reads the regions of interest from your config file and downloads all the sources to satisfy requests in that region. This is a prerequisite for the other steps.
* `buildvrt` builds a [VRT](http://www.gdal.org/gdal_vrttut.html) "virtual dataset" of all the downloaded files. This requires that you have already run `download`, and is a prerequisite of the `generate` step.
* `generate` generates all the configured outputs matching your regions of interest.

To run each command, type something like this:

```sh
joerd <command> --config config.example.yaml
```

Where `<command>` is one of the commands above. The config has four sections:

* `regions` is a map of named sections, each with a `bbox` section having `top`, `left`, `bottom` and `right` coordinates. These describe the bounding box of the region. Data from the sources will be downloaded to cover that region, and outputs within it will be generated.
* `outputs` is a list of output plugins. Currently available:
  * `skadi` creates output in SRTMHGT format suitable for use in [Skadi](https://github.com/valhalla/skadi).
  * `terrarium` creates tiled output in GeoTIFF format.
* `sources` is a list of source plugins. Currently available:
  * `etopo1` downloads data from ETOPO1, a 1 arc-minute global bathymetry and topology dataset.
  * `gmted` downloads data from GMTED, a global topology dataset at 30 or 15 arc-seconds.
  * `srtm` downloads data from SRTM, an almost-global 3 arc-second topology dataset.
* `logging` has a single section, `config`, which gives the location of a Python logging config file.

License
-------

{'fraction_non_alphanumeric': 0.20045775319473583, 'fraction_numerical': 0.004196070951745184, 'mean_word_length': 2.6391394864677307, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 9, 'lorem ipsum': 0, 'www.': 1, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 14, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2157293', 'n_tokens_mistral': 2073, 'n_tokens_neox': 2263, 'n_words': 755}