Skip to content

Commit

Permalink
docs: Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
frgfm committed Dec 13, 2020
1 parent 3c87ee4 commit 3791f1e
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,16 @@ pip install git+git://github.com/pyronear/pyro-risks

## Usage

### datasets
Beforehand, you will need to set a few environment variables either manually or by writing an `.env` file in the root directory of this project, like in the example below:

```
CDS_UID=my_secret_uid
CDS_API_KEY=my_very_secret_key
```
Those values will allow your web server to connect to CDS [API](https://github.com/ecmwf/cdsapi), which is mandatory for your datasets access to be fully operational.


### pyro_risks.datasets

Access all pyro-risks datasets.

Expand All @@ -57,6 +66,17 @@ firms = NASAFIRMS()
noaa = NOAAWeather()
```

### Web server

To be able to expose model inference, you can run a web server using docker containers with this command:

```bash
PORT=8003 docker-compose up -d --build
```

Once completed, you will notice that you have a docker container running on the port you selected, which can process requests just like any web server.


## Examples

You are free to merge the datasets however you want and to implement any zonal statistic you want, but some are already provided for reference. In order to use them check the example scripts options as follows:
Expand Down

0 comments on commit 3791f1e

Please sign in to comment.