Updates for github

.github/workflows/pull_request.yml

@@ -0,0 +1,62 @@
+# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions
+name: Pull Request
+
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+
+jobs:
+  lint_code:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11"]
+    steps:
+    - 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 .[dev]
+    - name: Analysing the code with pre-commit lint checks
+      run: |
+        pre-commit run -a
+
+
+  test_code_and_coverage_report_python3p11:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11"]
+    steps:
+    - uses: actions/checkout@v4
+    - 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 .[dev]
+    - name: Test code
+      run: |
+        mkdir test_report
+        tox
+    - name: html to pdf
+      uses: fifsky/html-to-pdf-action@master
+      with:
+        htmlFile: test_report/cov_report/index.html
+        outputFile: test_report/cov_report/cov_report.pdf
+        pdfOptions: '{"format": "A4", "margin": {"top": "10mm", "left": "10mm", "right": "10mm", "bottom": "10mm"}}'
+    - name: Archive code coverage results
+      uses: actions/upload-artifact@v4
+      with:
+        name: code-coverage-report
+        path: test_report/cov_report/cov_report.pdf

.github/workflows/push_branch.yml

@@ -0,0 +1,27 @@
+# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions
+name: Push to branch
+
+on:
+  push:
+    branches:
+      - '*'
+
+jobs:
+  test_code:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.12"]
+    steps:
+    - uses: actions/checkout@v4
+    - 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 .[dev]
+    - name: Test code
+      run: |
+        tox

.pre-commit-config.yaml

@@ -3,3 +3,4 @@ repos:
     rev: stable
     hooks:
       - id: black
+        args: [--target-version, py311]

LICENSE

@@ -1,7 +1,7 @@
-                   GNU LESSER GENERAL PUBLIC LICENSE
+GNU LESSER GENERAL PUBLIC LICENSE
                        Version 3, 29 June 2007
 
- Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.
 

README.rst

@@ -3,6 +3,13 @@ curepy
 
 Retrievall UNcertainties in PYthon
 
+============
+Beta Version
+============
+
+WARNING: This software is a beta version, results should be used with caution.
+Please share any feedback you have after using the tool.
+
 Usage
 =====
 

docs/conf.py

@@ -21,19 +21,20 @@
 import os
 import sys
 
-#sys.path.insert(0, os.path.abspath(".."))
+# sys.path.insert(0, os.path.abspath(".."))
 
 # SH added to run apidoc on build
 this_directory = os.path.dirname(__file__)
 
 module_path = os.path.abspath(os.path.join(this_directory, "..", "..", "curepy"))
 
+
 def run_apidoc(_):
     ignore_paths = [
-    "./../../*/tests/",
-    "setup.py",
-    "versioneer.py",
-]
+        "./../../*/tests/",
+        "setup.py",
+        "versioneer.py",
+    ]
 
     argv = [
         "-f",
@@ -150,7 +151,9 @@ def setup(app):
 # theme further.  For a list of options available for each theme, see the
 # documentation.
 #
-# html_theme_options = {}
+html_theme_options = {
+    "announcement": "<strong>Beta Version:</strong> This software is a beta version, results should be used with caution. Please share any feedback you have after using the tool.",
+}
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

docs/index.rst

@@ -1,7 +1,11 @@
 Welcome to curepy's documentation!
 =========================================================
 
-*curepy* is a Python package for propagating uncertainties through inverse problems.
+The **curepy** module is a Python software package to propagate uncertainties through inverse problems. 
+
+**curepy** can be used to solve inverse problems with input measurements and uncertainties inputted manually, or using an **obsarray** dataset.
+It can also be used to analyse the outputs of these inverse problems to quantify uncertainties and compare results.
+This documentation provides general information on how to use the module (with some examples), as well as a detailed API of the included classes and function.
 
 .. grid:: 2
     :gutter: 2

pyproject.toml

@@ -48,3 +48,6 @@ versionfile_source = "curepy/_version.py"
 versionfile_build = "curepy/_version.py"
 tag_prefix = "v"
 parentdir_prefix_version = "curepy-"
+
+[tool.black]
+target-version = ['py311']