<commit_before>## Installation

`pip install planet2ebs` (may need `sudo`)

## Usage

The environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` are required.

AWS Region defaults to `us-west-2`.

### Copy
Creates an EBS volume containing the specified OSM .PBF file.

    $ planet2ebs copy http://download.geofabrik.de/north-america/us/hawaii-latest.osm.pbf
	...
     -> Created vol-111111
### Import
Creates a rendering database on an EBS volume from the .PBF stored on the given volume.

By default, uses the [imposm3]() mapping [example-mapping.json]().

    $ planet2ebs import vol-111111
    ...
    -> Created vol-222222

* To use a custom mapping: `planet2ebs import -mapping=mapping.json vol-111111`


### Start
Starts an EC2 instance using the given data volume, and creates a read-only rendering user.

    $ planet2ebs start vol-222222
    ...
	-> Started postgres://render:password@3-3-3-3.ec2.amazonaws.com/osm`

* To set the `render` user password: `planet2ebs start -password=PASSWORD vol-222222`
* This instance must be terminated manually. It can be rebooted without problems.

### List
Lists volumes and instances created by `planet2ebs` and how they were created.

		$ planet2ebs ls
		id			type	  source
        vol-111111  pbf       http://example.com/something/osm.pbf
        vol-222222  pgdata    vol-111111
        i-333333    db        vol-222222

### Global Options
  
* `-region=REGION`: the AWS region.
* `-ami=ami-444444`: use an alternate AMI. Needed if you build the AMI yourself and/or are using a non-US region.<commit_msg>Whitespace<commit_after>## Installation

`pip install planet2ebs` 

(may need `sudo`)

## Usage

The environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` are required.

AWS Region defaults to `us-west-2`.

### Copy
Creates an EBS volume containing the specified OSM .PBF file.

    $ planet2ebs copy http://download.geofabrik.de/north-america/us/hawaii-latest.osm.pbf
	...
     -> Created vol-111111
### Import
Creates a rendering database on an EBS volume from the .PBF stored on the given volume.

By default, uses the [imposm3]() mapping [example-mapping.json]().

    $ planet2ebs import vol-111111
    ...
    -> Created vol-222222

* To use a custom mapping: `planet2ebs import -mapping=mapping.json vol-111111`


### Start
Starts an EC2 instance using the given data volume, and creates a read-only rendering user.

    $ planet2ebs start vol-222222
    ...
	-> Started postgres://render:password@3-3-3-3.ec2.amazonaws.com/osm`

* To set the `render` user password: `planet2ebs start -password=PASSWORD vol-222222`
* This instance must be terminated manually. It can be rebooted without problems.

### List
Lists volumes and instances created by `planet2ebs` and how they were created.

	$ planet2ebs ls
	id			type	  source
    vol-111111  pbf       http://example.com/something/osm.pbf
    vol-222222  pgdata    vol-111111
    i-333333    db        vol-222222

### Global Options
  
* `-region=REGION`: the AWS region.
* `-ami=ami-444444`: use an alternate AMI. Needed if you build the AMI yourself and/or are using a non-US region.
{'fraction_non_alphanumeric': 0.10099073186321508, 'fraction_numerical': 0.05624800255672739, 'mean_word_length': 3.3053645116918844, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 9, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 2, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6898644', 'n_tokens_mistral': 1151, 'n_tokens_neox': 1023, 'n_words': 339}