diff --git a/.github/workflows/python-install-and-test-on-linux-always.yml b/.github/workflows/python-install-and-test-on-linux-always.yml index 1f373cb3..36e4f833 100644 --- a/.github/workflows/python-install-and-test-on-linux-always.yml +++ b/.github/workflows/python-install-and-test-on-linux-always.yml @@ -4,7 +4,6 @@ on: [push] jobs: build: - permissions: read-all runs-on: ubuntu-latest @@ -29,4 +28,4 @@ jobs: coverage run -m pytest -v -s - name: Generate Coverage Report run: | - coverage report -m \ No newline at end of file + coverage report -m diff --git a/.github/workflows/python-tests-coverage.yml b/.github/workflows/python-tests-coverage.yml new file mode 100644 index 00000000..fa3444b6 --- /dev/null +++ b/.github/workflows/python-tests-coverage.yml @@ -0,0 +1,72 @@ +name: Build tests coverage badge + +on: + push: + branches: + - main + - dev + +jobs: + build: + permissions: + actions: read + attestations: read + checks: read + contents: write + deployments: read + id-token: none + issues: none + discussions: none + packages: read + pages: read + pull-requests: write + security-events: read + statuses: read + + runs-on: ubuntu-latest + strategy: + fail-fast: false + matrix: + python-version: ["3.12"] + + steps: + - uses: actions/checkout@v4 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v4 + with: + python-version: ${{ matrix.python-version }} + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install . + pip install --group dev + - name: Test with pytest + run: | + coverage run -m pytest -v -s + - name: Generate Coverage Report + run: | + coverage report -m + + - name: Coverage Badge + uses: tj-actions/coverage-badge-py@1788babcb24544eb5bbb6e0d374df5d1e54e670f # v2 + + - name: Verify Changed files + uses: tj-actions/verify-changed-files@a1c6acee9df209257a246f2cc6ae8cb6581c1edf # v20 + id: verify-changed-files + with: + files: coverage.svg + + - name: Commit files + if: steps.verify-changed-files.outputs.files_changed == 'true' + run: | + git config --local user.email "github-actions[bot]@users.noreply.github.com" + git config --local user.name "github-actions[bot]" + git add coverage.svg + git commit -m "Updated coverage.svg" + + - name: Push changes + if: steps.verify-changed-files.outputs.files_changed == 'true' + uses: ad-m/github-push-action@master + with: + github_token: ${{ secrets.github_token }} + branch: ${{ github.ref }} \ No newline at end of file diff --git a/README.md b/README.md index 657ec65a..cebed1bf 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,10 @@ -![status](https://joss.theoj.org/papers/3f87f562264c4e5174d9e6ed6d8812aa/status.svg) ![License](https://img.shields.io/github/license/szymon-datalions/pyinterpolate) ![Documentation Status](https://readthedocs.org/projects/pyinterpolate/badge/?version=latest) [![CodeFactor](https://www.codefactor.io/repository/github/dataverselabs/pyinterpolate/badge)](https://www.codefactor.io/repository/github/dataverselabs/pyinterpolate) +![JOSS](https://joss.theoj.org/papers/3f87f562264c4e5174d9e6ed6d8812aa/status.svg) [![License](https://img.shields.io/badge/License-BSD_2--Clause-orange.svg)](https://opensource.org/licenses/BSD-2-Clause) ![Documentation Status](https://readthedocs.org/projects/pyinterpolate/badge/?version=latest) [![CodeFactor](https://www.codefactor.io/repository/github/dataverselabs/pyinterpolate/badge)](https://www.codefactor.io/repository/github/dataverselabs/pyinterpolate) + +[![Run Unit Test via Pytest](https://github.com/DataverseLabs/pyinterpolate/actions/workflows/python-install-and-test-on-linux-always.yml/badge.svg)](https://github.com/DataverseLabs/pyinterpolate/actions/workflows/python-install-and-test-on-linux-always.yml) [![CodeQL](https://github.com/DataverseLabs/pyinterpolate/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/DataverseLabs/pyinterpolate/actions/workflows/github-code-scanning/codeql) ![Tests Coverage](https://github.com/DataverseLabs/pyinterpolate/blob/main/coverage.svg) + + + + # Pyinterpolate @@ -154,19 +160,12 @@ A world of advice, you should **always** use Virtual Environment for the install All tests are grouped in the `test` directory. If you would like to contribute, then you won't avoid testing, but it is described step-by-step here: [CONTRIBUTION.md](https://github.com/DataverseLabs/pyinterpolate/blob/main/CONTRIBUTION.md) -## Commercial and scientific projects where library has been used - -* Tick-Borne Disease Detector (Data Lions company) for the European Space Agency (2019-2020). -* B2C project related to the prediction of demand for specific flu medications (2020). -* B2G project related to the large-scale infrastructure maintenance (2020-2021). -* E-commerce service for reporting and analysis, building spatial / temporal profiles of customers (2022+). -* The external data augmentation for e-commerce services (2022+). -* Regional aggregates transformation and preprocessing for location intelligence tasks (2025+). - -## Community - -Join our community in Discord: [Discord Server Pyinterpolate](https://discord.gg/3EMuRkj) +## Use cases +* [Lyme Disease Risk Assessment Based on the Earth Observation Data and Spatial Processing Technique. ESA Φ-week 2021](https://phiweek.esa.int/detailed-programme) +* [Disaggregation of socio-economic data](https://ml-gis-service.com/index.php/2022/12/09/get-more-from-crime-rate-data-and-other-socio-economic-indicators-with-pyinterpolate/) +* [Interpolation of air pollution](https://ml-gis-service.com/index.php/2021/10/31/data-science-interpolate-air-quality-measurements-with-python/) +* [Educational - Spatial Data Science for Social Geography Course - Interpolation](https://github.com/martinfleis/sds?tab=readme-ov-file#spatial-data-science-for-social-geography) ## Bibliography @@ -178,6 +177,9 @@ Pyinterpolate was created thanks to many resources and all of them are pointed h - Goovaerts P., Kriging and Semivariogram Deconvolution in the Presence of Irregular Geographical Units, Mathematical Geology 40(1), 101-128, 2008 - Deutsch C.V., Correcting for Negative Weights in Ordinary Kriging, Computers & Geosciences Vol.22, No.7, pp. 765-773, 1996 +## Community + +Join our community in Discord: [Discord Server Pyinterpolate](https://discord.gg/3EMuRkj) ## How to cite diff --git a/coverage.svg b/coverage.svg new file mode 100644 index 00000000..318685c0 --- /dev/null +++ b/coverage.svg @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + + + coverage + coverage + 85% + 85% + + diff --git a/docs/build/doctrees/community/community/use_cases.doctree b/docs/build/doctrees/community/community/use_cases.doctree index 95648af8..75aeb7aa 100644 Binary files a/docs/build/doctrees/community/community/use_cases.doctree and b/docs/build/doctrees/community/community/use_cases.doctree differ diff --git a/docs/build/html/_sources/community/community/use_cases.rst.txt b/docs/build/html/_sources/community/community/use_cases.rst.txt index a4597643..2f3d5baa 100644 --- a/docs/build/html/_sources/community/community/use_cases.rst.txt +++ b/docs/build/html/_sources/community/community/use_cases.rst.txt @@ -1,9 +1,7 @@ Use Cases ========= -* Tick-Borne Disease Detector for the European Space Agency (2019-2020). -* B2C project related to the prediction of demand for specific flu medications (2020). -* B2G project related to the large-scale infrastructure maintenance (2020-2021). -* E-commerce service for reporting and analysis, building spatial / temporal profiles of customers (2022+). -* The external data augmentation for e-commerce services (2022+). -* As a module for the hotel price optimization system (2023+). \ No newline at end of file +* `Lyme Disease Risk Assessment Based on the Earth Observation Data and Spatial Processing Technique. ESA Φ-week 2021 `_ +* `Disaggregation of socio-economic data `_ +* `Interpolation of air pollution `_ +* `Educational - Spatial Data Science for Social Geography Course - Interpolation `_ diff --git a/docs/build/html/community/community/use_cases.html b/docs/build/html/community/community/use_cases.html index 22a245e2..c46bd66e 100644 --- a/docs/build/html/community/community/use_cases.html +++ b/docs/build/html/community/community/use_cases.html @@ -443,12 +443,10 @@

Use Cases#

diff --git a/docs/source/community/community/use_cases.rst b/docs/source/community/community/use_cases.rst index a4597643..2f3d5baa 100644 --- a/docs/source/community/community/use_cases.rst +++ b/docs/source/community/community/use_cases.rst @@ -1,9 +1,7 @@ Use Cases ========= -* Tick-Borne Disease Detector for the European Space Agency (2019-2020). -* B2C project related to the prediction of demand for specific flu medications (2020). -* B2G project related to the large-scale infrastructure maintenance (2020-2021). -* E-commerce service for reporting and analysis, building spatial / temporal profiles of customers (2022+). -* The external data augmentation for e-commerce services (2022+). -* As a module for the hotel price optimization system (2023+). \ No newline at end of file +* `Lyme Disease Risk Assessment Based on the Earth Observation Data and Spatial Processing Technique. ESA Φ-week 2021 `_ +* `Disaggregation of socio-economic data `_ +* `Interpolation of air pollution `_ +* `Educational - Spatial Data Science for Social Geography Course - Interpolation `_