Skip to content

Commit

Permalink
add github action
Browse files Browse the repository at this point in the history
  • Loading branch information
matthiasprobst committed Mar 9, 2024
1 parent 32ac089 commit ff2bdb5
Show file tree
Hide file tree
Showing 5 changed files with 74 additions and 0 deletions.
48 changes: 48 additions & 0 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# github action including pymongo see https://github.com/marketplace/actions/mongodb-in-github-actions

name: Tests

on:
push:
branches:
- main
- dev

jobs:
test:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ ubuntu-latest, macos-latest, windows-latest ]
python-version: [ '3.8', '3.9' , '3.10', '3.11', '3.12']

steps:
- name: Checkout repo
uses: actions/checkout@v3

- name: Set Up Python ${{ matrix.python-version }}
uses: actions/setup-python@v3
with:
python-version: ${{ matrix.python-version }}


- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install setuptools
pip install -r requirements-dev.txt
- name: Run pytest coverage
run: pytest --cov --cov-report=xml

- name: Upload coverage to Codecov
uses: codecov/codecov-action@v3
with:
token: ${{ secrets.CODECOV_TOKEN }}
file: ./coverage.xml
- uses: actions/cache@v3
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements-dev.txt') }}
restore-keys: |
${{ runner.os }}-pip-
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
@ -1,47 +0,0 @@
# build
*.egg*
build/
Expand Down Expand Up @@ -45,3 +46,4 @@ default.yaml

examples/*.json
examples/*.jsonld
*.bak
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# synpivimage


![Tests](https://github.com/matthiasprobst/synpivimage/actions/workflows/tests.yml/badge.svg)
![DOCS](https://codecov.io/gh/matthiasprobst/synpivimage/branch/dev/graph/badge.svg)
![pyvers](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11%20%7C%203.12-blue)

Tool to build synthetic Particle Image Velocimetry (PIV) images based on commonly accepted literature.

It uses the commonly used assumptions and DOES NOT include optical aberrations, such as lens distortion or such. Noise
Expand Down
6 changes: 6 additions & 0 deletions requirements-dev.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
-e .
-r requirements.txt
xmltodict
pyyaml>6.0.0
pytest>=7.1.2
pytest-cov
13 changes: 13 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
numpy
pandas
pathlib
h5py
xarray
tifffile
pyyaml
tqdm
matplotlib
python-dotenv
opencv-python
PyQt5
scipy

0 comments on commit ff2bdb5

Please sign in to comment.