Skip to content

Commit

Permalink
Update README.md (#91)
Browse files Browse the repository at this point in the history
* Update README.md

Cleaning up README.md and clearly state that wis2box-api needs to be used as wis2box-stack and that it is based on dim_eccodes_baseimage ...

* Update README.md

---------

Co-authored-by: Tom Kralidis <tomkralidis@gmail.com>
  • Loading branch information
maaikelimper and tomkralidis authored Feb 4, 2025
1 parent 73ef568 commit 855a98f
Showing 1 changed file with 5 additions and 39 deletions.
44 changes: 5 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,16 @@
# wis2box-api

WIS 2.0 in a box OGC API
WIS 2.0 in a box API provides [OGC API](https://ogcapi.ogc.org) support using [pygeoapi](https://pygeoapi.io), and intended for use for within the [wis2box](https://docs.wis2box.wis.wmo.int) project.

## Installation

wis2box-api is part of the [wis2box](https://docs.wis2box.wis.wmo.int) project.
wis2box-api uses the base image provided by [dim_eccodes_baseimage](https://github.com/wmo-im/dim_eccodes_baseimage) to enable support for data conversion through pygeoapi processes.

### Requirements
## Installation

* Python 3 and above
* Python [virtualenv](https://virtualenv.pypa.io/) package
wis2box-api is part of the [wis2box](https://community.wmo.int/en/activity-areas/wis/wis2box) software stack.

### Dependencies

Dependencies are listed in [requirements.txt](requirements.txt). Dependencies
are automatically installed during wis2box-api's installation.

### Installing the Package

```bash
python3 -m venv my-env
cd my-env
. bin/activate
git clone https://github.com/wmo-im/wis2box-api.git
cd wis2box-api
python setup.py build
python setup.py install
```

## Running

```bash
export FLASK_APP=wis2box_api.app
flask run
```

## Development

### Setting up a Development Environment

Same as installing a package. Use a virtualenv. Also install developer
requirements:

```bash
pip install -r requirements-dev.txt
```
Dependencies are listed in [requirements.txt](requirements.txt). Dependencies are automatically installed during wis2box-api installation.

## Releasing

Expand Down

0 comments on commit 855a98f

Please sign in to comment.