diff --git a/README.md b/README.md index 9c01949..a1ddff3 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,28 @@ -# polytope-mars +| :warning: This project is BETA and will be experimental for the foreseeable future. Interfaces and functionality are likely to change. DO NOT use this software in any project/software that is operational. | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -> [!WARNING] -> This project is BETA and will be experimental for the forseable future. Interfaces and functionality are likely to change, and the project itself may be scrapped. DO NOT use this software in any project/software that is operational. +

+ +
+ +# Polytope-mars + +

+ + ci + + + + +

+

+ Concept • + Installation • + Example • + Testing +

+ +## Concept Repository for high level API of polytope feature extraction such as vertical profile and time series. @@ -18,12 +39,20 @@ Current features include: ## Installation ```bash +pip install polytope-mars +``` + +Or clone the repo and install locally + +```bash +git clone git@github.com:ecmwf/polytope-mars.git +cd polytope-mars + pip install -e . ``` -Currently no pypi package available. WIll be added in the future. -## Usage +## Example **Create time series request**: Create a request for a time series request using the time series feature, set options and config for use by polytope feature extraction. NB: Assumes data is in a local FDB. diff --git a/docs/images/ECMWF_logo.svg.png b/docs/images/ECMWF_logo.svg.png new file mode 100644 index 0000000..69266e1 Binary files /dev/null and b/docs/images/ECMWF_logo.svg.png differ diff --git a/manifest.in b/manifest.in new file mode 100644 index 0000000..3c901e2 --- /dev/null +++ b/manifest.in @@ -0,0 +1 @@ +exclude tests/data/* \ No newline at end of file diff --git a/polytope_mars/version.py b/polytope_mars/version.py index 27fdca4..81f0fde 100644 --- a/polytope_mars/version.py +++ b/polytope_mars/version.py @@ -1 +1 @@ -__version__ = "0.0.3" +__version__ = "0.0.4" diff --git a/requirements.txt b/requirements.txt index 0ad6652..1f53fb9 100644 --- a/requirements.txt +++ b/requirements.txt @@ -3,3 +3,4 @@ covjsonkit xarray shapely geopandas +pygribjump \ No newline at end of file