-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add manifest to remove data files from pypi distribution, update read…
…me and add logo image
- Loading branch information
Showing
5 changed files
with
37 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
<h3 align="center"> | ||
<img src="./docs/images/ECMWF_logo.svg.png" width=60%> | ||
</br> | ||
|
||
# Polytope-mars | ||
|
||
<p align="center"> | ||
<a href="https://github.com/ecmwf/polytope-mars/actions/workflows/ci.yaml"> | ||
<img src="https://github.com/ecmwf/polytope-mars/actions/workflows/ci.yaml/badge.svg" alt="ci"> | ||
</a> | ||
<a href="https://codecov.io/gh/ecmwf/polytope-mars"><img src="https://codecov.io/gh/ecmwf/polytope-mars/branch/develop/graph/badge.svg"></a> | ||
<a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a> | ||
<a href="https://github.com/ecmwf/polytope-mars/releases"><img src="https://img.shields.io/github/v/release/ecmwf/polytope-mars?color=blue&label=Release&style=flat-square"></a> | ||
</p> | ||
<p align="center"> | ||
<a href="#concept">Concept</a> • | ||
<a href="#installation">Installation</a> • | ||
<a href="#example">Example</a> • | ||
<a href="#testing">Testing</a> | ||
</p> | ||
|
||
## 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 [email protected]: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. | ||
|
||
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
exclude tests/data/* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
__version__ = "0.0.3" | ||
__version__ = "0.0.4" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,3 +3,4 @@ covjsonkit | |
xarray | ||
shapely | ||
geopandas | ||
pygribjump |