Merge pull request #11 from lpin0002/developer

Developer
LiamCPinchbeck · Sep 2, 2024 · 5beeb1c · 5beeb1c
2 parents ebdb403 + fc71858
commit 5beeb1c
Show file tree

Hide file tree

Showing 17 changed files with 979 additions and 911 deletions.
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -0,0 +1,43 @@
+name: Publish Python Package
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'  # Replace with your desired Python version
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+
+      - name: Build the package
+        run: |
+          python -m build
+
+      - name: Publish to Test PyPI
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.DEFINITELY_NOT_TEST_PYPI_API_TOKEN }}
+        run: |
+          python -m twine upload --repository testpypi dist/*
+        id: testpypi_upload
+
+      - name: Publish to PyPI
+        if: ${{ steps.testpypi_upload.conclusion == 'success' }}
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.DEFINITELY_NOT_PYPI_API_TOKEN }}
+        run: |
+          python -m twine upload dist/*
diff --git a/docs/conf.py b/docs/conf.py
@@ -15,7 +15,7 @@
 project = 'GammaBayes'
 copyright = '2023, Liam Pinchbeck'
 author = 'Liam Pinchbeck'
-release = '0.0.42'
+release = '0.1.7'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

diff --git a/docs/index.rst b/docs/index.rst
@@ -20,12 +20,11 @@ Welcome to GammaBayes's documentation!
    tutorials/Simulations
    tutorials/DarkMatter
    tutorials/ParameterClasses
-   tutorials/NuisanceParameterMarginalisation
+   tutorials/HyperparameterInference
    tutorials/MultiObservationNuisanceParameterMarginalisation
-   tutorials/HyperparmeterInference
-   tutorials/UsefulUtils
-   tutorials/PlannedDevelopments
-   tutorials/API
+..    tutorials/UsefulUtils
+..    tutorials/PlannedDevelopments
+..    tutorials/API
 
 
 

diff --git a/docs/tutorials/API.ipynb b/docs/tutorials/API.ipynb
diff --git a/docs/tutorials/BinningGeometries.ipynb b/docs/tutorials/BinningGeometries.ipynb
@@ -84,14 +84,14 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# `GammaBinning` attributes"
+    "## `GammaBinning` attributes"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## `axes`"
+    "### `axes`"
    ]
   },
   {
@@ -134,7 +134,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## `lon_res` and `lat_res`"
+    "### `lon_res` and `lat_res`"
    ]
   },
   {
@@ -168,7 +168,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## `axes_mesh`"
+    "### `axes_mesh`"
    ]
   },
   {
@@ -202,7 +202,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## `axes_dim`"
+    "### `axes_dim`"
    ]
   },
   {
@@ -236,7 +236,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## `spatial_axes`"
+    "### `spatial_axes`"
    ]
   },
   {
@@ -275,7 +275,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## `spatial_centre`"
+    "### `spatial_centre`"
    ]
   },
   {
@@ -312,14 +312,14 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# `GammaBinning` methods"
+    "## `GammaBinning` methods"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## `to_dict`"
+    "### `to_dict`"
    ]
   },
   {
@@ -362,7 +362,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## `from_params`"
+    "### `from_params`"
    ]
   },
   {
@@ -428,14 +428,14 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# `GammaBinning` behaviours"
+    "## `GammaBinning` behaviours"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Equality"
+    "### Equality"
    ]
   },
   {
@@ -469,7 +469,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Containment"
+    "### Containment"
    ]
   },
   {
@@ -575,7 +575,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Next tutorial"
+    "#### Next tutorial"
    ]
   },
   {

diff --git a/docs/tutorials/DataClasses.ipynb b/docs/tutorials/DataClasses.ipynb
@@ -16,6 +16,13 @@
     "I can see how this may be a further complication to the time-poor researcher hence few classes must depend on this data structure but I do think it is handy and it is the default for most of the simulation classes within the pipeline."
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## `GammaObs`"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -866,7 +873,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# `GammaObsCube`"
+    "## `GammaObsCube`"
    ]
   },
   {

diff --git a/docs/tutorials/Exposure.ipynb b/docs/tutorials/Exposure.ipynb
@@ -209,7 +209,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Multiple exposures"
+    "## Multiple exposures"
    ]
   },
   {

diff --git a/docs/tutorials/HighLevelInference.ipynb b/docs/tutorials/HighLevelInference.ipynb
@@ -550,7 +550,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# The cool stuff"
+    "## The cool stuff"
    ]
   },
   {

diff --git a/docs/tutorials/HyperParameterInference.ipynb b/docs/tutorials/HyperParameterInference.ipynb
diff --git a/docs/tutorials/InstrumentResponseFunctions.ipynb b/docs/tutorials/InstrumentResponseFunctions.ipynb
@@ -48,7 +48,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# `IRF_LogLikelihood`"
+    "## `IRF_LogLikelihood`"
    ]
   },
   {
@@ -175,7 +175,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Point Spread Function"
+    "### Point Spread Function"
    ]
   },
   {
@@ -278,7 +278,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Energy Dispersion"
+    "### Energy Dispersion"
    ]
   },
   {
@@ -377,7 +377,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Effective Area"
+    "### Effective Area"
    ]
   },
   {
@@ -454,7 +454,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## As an observational likelihood"
+    "### As an observational likelihood"
    ]
   },
   {

diff --git a/docs/tutorials/LowLevelOverview|Theory.ipynb → docs/tutorials/LowLevelOverview.ipynb b/docs/tutorials/LowLevelOverview|Theory.ipynb → docs/tutorials/LowLevelOverview.ipynb
@@ -37,7 +37,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# The posterior and evidence"
+    "## The posterior and evidence"
    ]
   },
   {
@@ -175,7 +175,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# The likelihood and nuisance marginalisation"
+    "## The likelihood and nuisance marginalisation"
    ]
   },
   {
@@ -268,7 +268,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# An overview"
+    "## An overview"
    ]
   },
   {

diff --git a/docs/tutorials/MultiObservationNuisanceParameterMarginalisation.ipynb b/docs/tutorials/MultiObservationNuisanceParameterMarginalisation.ipynb
@@ -0,0 +1,30 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Multi-observation inference"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "...under construction..."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": []
+  }
+ ],
+ "metadata": {
+  "language_info": {
+   "name": "python"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}