init

Author: alex98247

.coveragerc

@@ -0,0 +1,3 @@
+[run]
+omit =
+    tests/*

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,17 @@
+<!-- Thank you for sending your pull request. But first, have you included
+unit tests, and is your code PEP8 conformant?
+-->
+## Summary
+
+<!-- Explain in one sentence the goal of this PR -->
+
+Solve the issue: #___
+
+## Quick changelog
+
+- <change log 1>
+- <change log 1>
+
+## What's new?
+
+<!-- Explain in details what this PR solve or improve. You can include visuals. -->

.github/workflows/ci.yaml

@@ -0,0 +1,69 @@
+name: PySATL CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Display Python version
+        run: python -c "import sys; print(sys.version)"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements-dev.txt
+
+      - name: Run tests
+        run: pytest --random-order
+
+      - name: Tests with Coveralls
+        if: (runner.os == 'Linux' && matrix.python-version == '3.12')
+        run: |
+          pytest --random-order --cov=stattest --cov-config=.coveragerc
+
+      - name: Coveralls
+        if: (runner.os == 'Linux' && matrix.python-version == '3.12')
+        env:
+          COVERALLS_REPO_TOKEN: ${{ secrets.coverallsToken }}
+        run: |
+            # Allow failure for coveralls
+            coveralls || true
+
+      - name: Check for repository changes
+        run: |
+          if [ -n "$(git status --porcelain)" ]; then
+            echo "Repository is dirty, changes detected:"
+            git status
+            git diff
+            exit 1
+          else
+            echo "Repository is clean, no changes detected."
+          fi
+
+      - name: Sort imports (isort)
+        run: |
+          isort --check .
+
+      - name: Run Ruff
+        run: |
+          ruff check --output-format=github
+
+      - name: Run Ruff format check
+        run: |
+          ruff format --check

.github/workflows/deploy-docs.yml

@@ -0,0 +1,55 @@
+name: Build Documentation
+
+on:
+  push:
+    branches:
+      - main
+  release:
+    types: [published]
+
+
+# disable permissions for all of the available permissions
+permissions: {}
+
+
+jobs:
+  build-docs:
+    permissions:
+      contents: write  #  for mike to push
+    name: Deploy Docs through mike
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r docs/requirements-docs.txt
+
+      - name: Fetch gh-pages branch
+        run: |
+          git fetch origin gh-pages --depth=1
+
+      - name: Configure Git user
+        run: |
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+
+      - name: Build and push Mike
+        if: ${{ github.event_name == 'push' }}
+        run: |
+          mike deploy ${{ github.ref_name }} latest --push --update-aliases
+
+      - name: Build and push Mike - Release
+        if: ${{ github.event_name == 'release' }}
+        run: |
+          mike deploy ${{ github.ref_name }} stable --push --update-aliases
+
+      - name: Show mike versions
+        run: |
+          mike list

.readthedocs.yaml

@@ -0,0 +1,14 @@
+# .readthedocs.yml
+version: 2
+
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.12"
+
+python:
+  install:
+    - requirements: docs/requirements-docs.txt
+
+mkdocs:
+  configuration: mkdocs.yml

README.md

@@ -1 +1,5 @@
-# pysatl-test
+# pysatl-criterion
+
+[![Pysatl_criterion CI](https://github.com/PySATL/pysatl-criterion/workflows/PySATL%20CI/badge.svg)](https://github.com/PySATL/pysatl-experiment/actions)
+[![Coverage Status](https://coveralls.io/repos/github/PySATL/pysatl-criterion/badge.svg?branch=main)](https://coveralls.io/github/PySATL/pysatl-experiment?branch=main)
+[![Documentation](https://readthedocs.org/projects/pysatl-criterion/badge)](https://pysatl-criterion.readthedocs.io)

core/__init__.py

@@ -0,0 +1,11 @@
+from scipy.stats import expon
+
+
+def generate_expon(size, lam=1):  # TODO: refactor structure with inheritance??
+    scale = 1 / lam
+    return expon.rvs(size=size, scale=scale)
+
+
+def cdf_expon(rvs, lam=1):
+    scale = 1 / lam
+    return expon.cdf(rvs, scale=scale)

core/expon.py

@@ -0,0 +1,17 @@
+from scipy.stats import exponweib
+
+
+def generate_weibull(size, a=1, k=5):
+    return exponweib.rvs(a=a, c=k, size=size)
+
+
+def generate_weibull_cdf(rvs, a=1, k=5):
+    return exponweib.cdf(rvs, a=a, c=k)
+
+
+def generate_weibull_logcdf(rvs, a=1, k=5):
+    return exponweib.logcdf(rvs, a=a, c=k)
+
+
+def generate_weibull_logsf(rvs, a=1, k=5):
+    return exponweib.logsf(rvs, a=a, c=k)