Initial commit

.github/workflows/run_tests.yml

@@ -0,0 +1,55 @@
+name: test
+
+on:
+  push:
+    branches:
+      - main
+      - master
+    paths:
+      - "**.py"
+      - ".github/workflows/*test*.yml"
+      - "pyproject.toml"
+      - "poetry.lock"
+      - "requirements/requirements*.txt"
+  pull_request:
+    paths:
+      - "**.py"
+      - ".github/workflows/*test*.yml"
+      - "pyproject.toml"
+      - "poetry.lock"
+      - "requirements/requirements*.txt"
+
+jobs:
+  test:
+    name: test Python ${{ matrix.python }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python: ["3.9", "3.10", "3.11", "3.12"]
+        include:
+          - os: "macos-latest"
+            python: "3.10"
+    steps:
+      - uses: actions/checkout@main
+      - uses: actions/setup-python@main
+        with:
+          python-version: ${{ matrix.python }}
+      - uses: actions/cache@main
+        id: cache
+        with:
+          path: ${{ env.pythonLocation }}
+          key: test-${{ runner.os }}-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml', 'requirements/*') }}
+      - run: pip install -U pip
+      - run: pip install -r requirements/requirements-dev.txt
+      - run: pip install ./
+      - run: python --version
+      - run: python -m pip --version
+      - run: pytest --version
+      - run: python -m pip cache info
+      #- run: mypy searvey
+      #- run: make cov
+      - run: make test
+      # We only run on a single matrix case in order to speed up CI runtime
+      #- run: make exec_notebooks
+      #  if: ${{ matrix.os == 'ubuntu-latest' && matrix.python == '3.10' }}

Makefile

@@ -0,0 +1,37 @@
+.PHONY: list docs
+
+list:
+	@LC_ALL=C $(MAKE) -pRrq -f $(lastword $(MAKEFILE_LIST)) : 2>/dev/null | awk -v RS= -F: '/^# File/,/^# Finished Make data base/ {if ($$1 !~ "^[#.]") {print $$1}}' | sort | grep -E -v -e '^[^[:alnum:]]' -e '^$@$$'
+
+init:
+	poetry install --with dev --sync
+	pre-commit install
+
+style:
+	pre-commit run black -a
+
+lint:
+	pre-commit run ruff -a
+
+mypy:
+	dmypy run searvey
+
+test:
+	python -m pytest -vlx
+
+cov:
+	coverage erase
+	python -m pytest --cov=searvey --cov-report term-missing --durations=10 --record-mode=none
+
+clean_notebooks:
+	pre-commit run nbstripout -a
+
+exec_notebooks:
+	python -m nbconvert --to notebook --execute  --ExecutePreprocessor.kernel_name=python3 --stdout examples/* >/dev/null
+
+docs:
+	make -C docs html
+
+deps:
+	pre-commit run poetry-lock -a
+	pre-commit run poetry-export -a

README.md

@@ -1 +1,3 @@
-# pyposeidon-viz
+# pyposeidon-viz
+
+Visualizations for pyposeidon