From a5ff72f604d97e031b5b4648efe2491bf7812528 Mon Sep 17 00:00:00 2001 From: Mathilde Leuridan Date: Wed, 21 Jun 2023 11:01:25 +0200 Subject: [PATCH 1/5] change project name --- .github/workflows/ci.yaml | 2 +- setup.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 46dc2369..9d0b2d82 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -4,7 +4,7 @@ on: # Trigger the workflow on push to master or develop, except tag creation push: branches: - - 'master' + - 'main' - 'develop' # Trigger the workflow on pull request diff --git a/setup.py b/setup.py index b614485a..3decfd37 100644 --- a/setup.py +++ b/setup.py @@ -10,7 +10,7 @@ setup( - name="polytope", + name="polytope-python", version=__version__, description="Polytope datacube feature extraction library", url="https://github.com/ecmwf/polytope", From ed11df53cfaae66a2b6847b228de43d1d16c40ba Mon Sep 17 00:00:00 2001 From: Mathilde Leuridan Date: Wed, 21 Jun 2023 12:01:26 +0200 Subject: [PATCH 2/5] add paper to readme --- readme.md | 62 +++++-------------------------------------------------- setup.py | 4 ++++ 2 files changed, 9 insertions(+), 57 deletions(-) diff --git a/readme.md b/readme.md index 2fc49e07..b7cebd13 100644 --- a/readme.md +++ b/readme.md @@ -1,65 +1,10 @@ - - - - - - - - -

-
- +

- - - - - - - - - - - +

ci @@ -122,6 +67,9 @@ The Polytope algorithm can for example be used to extract: - and many more high-dimensional shapes in arbitrary dimensions... +For more information about the Polytope algorithm, refer to our [paper] (https://arxiv.org/abs/2306.11553). +If this project is useful for your work, please consider citing this paper. + ## Installation Install the polytope software with Python 3 (>=3.7) from GitHub directly with the command diff --git a/setup.py b/setup.py index 3decfd37..6a5ca3c6 100644 --- a/setup.py +++ b/setup.py @@ -13,6 +13,10 @@ name="polytope-python", version=__version__, description="Polytope datacube feature extraction library", + long_description="""Polytope is a library for extracting complex data from datacubes. It provides an API for + non-orthogonal access to data, where the stencil used to extract data from the datacube can be + any arbitrary n-dimensional polygon (called a polytope). This can be used to efficiently + extract complex features from a datacube, such as polygon regions or spatio-temporal paths.""", url="https://github.com/ecmwf/polytope", author="ECMWF", author_email="James.Hawkes@ecmwf.int, Mathilde.Leuridan@ecmwf.int", From 323686af10d54d9094bf098f74cc16c48f782e5b Mon Sep 17 00:00:00 2001 From: Mathilde Leuridan Date: Wed, 21 Jun 2023 14:12:27 +0200 Subject: [PATCH 3/5] add paper to readme --- readme.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index b7cebd13..783b1057 100644 --- a/readme.md +++ b/readme.md @@ -11,7 +11,8 @@ - + + Documentation Status

From cb90d7481f4785ecca455993f051936a13415a65 Mon Sep 17 00:00:00 2001 From: Mathilde Leuridan Date: Wed, 21 Jun 2023 14:13:13 +0200 Subject: [PATCH 4/5] add paper to readme --- readme.md | 1 - 1 file changed, 1 deletion(-) diff --git a/readme.md b/readme.md index 783b1057..b2ac63de 100644 --- a/readme.md +++ b/readme.md @@ -11,7 +11,6 @@ - Documentation Status

From bf85031cddd121301a873c6a45685f566c6173d8 Mon Sep 17 00:00:00 2001 From: Mathilde Leuridan Date: Wed, 21 Jun 2023 14:13:52 +0200 Subject: [PATCH 5/5] clean up ci workflow --- .github/workflows/ci.yaml | 13 ------------- 1 file changed, 13 deletions(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 45f305ee..4b2f16b7 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -109,15 +109,6 @@ jobs: - uses: actions/checkout@v3 with: fetch-depth: 3 # enable full clone to download Git LFS files - # - uses: actions/checkout@master - # - uses: codecov/codecov-action@v3 - # with: - # token: ${{ secrets.CODECOV_TOKEN }} - # # files: ./coverage1.xml,./coverage2.xml # optional - # # flags: unittests # optional - # name: codecov-umbrella # optional - # fail_ci_if_error: true # optional (default = false) - # verbose: true # optional (default = false) - name: Change write permission run: chmod -R 777 ./tests/data/ - name: Install Git LFS @@ -142,10 +133,6 @@ jobs: python -m pip install -r requirements.txt python -m pip install -r ./tests/requirements_test.txt - # - name: Create code cov report - # run: | - # pytest --cov=./ --cov-report=xml tests - - name: Verify Source Distribution shell: bash -eux {0} run: |