release v0.9

ndtatbristol · Jun 2, 2024 · 3d2de0a · 3d2de0a
1 parent f6edc23
commit 3d2de0a
Showing 32 changed files with 275 additions and 59 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,19 @@
-# Version 0.8
+# Version 0.9, 06.2024
+
+- Add TFM median (``arim.im.tfm.tfm_for_view(..., aggregation="median")``)
+- Add `arim.datasets` to automatically fetch test datasets
+- Add unfinished forward model for contact inspection
+- [Better example scripts, bundled with test data](https://github.com/ndtatbristol/arim/tree/v0.9/examples)
+- replace "scanline" (coming from old specs of MFMC) with the more understandable "timetrace"
+
+Internal changes:
+
+- Add MIT licence
+- Add continuous integration using GitHub Action
+- [Improve CONTRIBUTING guide](https://github.com/ndtatbristol/arim/blob/master/CONTRIBUTING.md)
+
+
+# Version 0.8, 05.2019
 
 First release, featuring notably:
 
@@ -7,4 +22,4 @@ First release, featuring notably:
 
 # Version 0.7
 
-Legacy version, not production ready. Requires Cython and a C/C++ compiler to compile from source.
+Legacy version, not production ready. Requires Cython and a C/C++ compiler to compile from source.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -73,6 +73,7 @@ For academic references, please use the author-date style from the Chicago Manua
 1. Delete the cache of autosummary by deleting the directory ``docs/source/_autosummary``
 2. In the directory ``docs``, type in a terminal:
 ```
+hatch shell default
 make html
 ```
 

diff --git a/docs/requirements.txt b/docs/requirements.txt
diff --git a/docs/source/_autosummary/arim._probes.rst b/docs/source/_autosummary/arim._probes.rst
@@ -1,4 +1,4 @@
-arim.\_probes
+arim.\_probes
 =============
 
 .. automodule:: arim._probes
@@ -13,4 +13,11 @@ arim.\_probes
 
 
 
-
+
+
+
+
+
+
+
+
diff --git a/docs/source/_autosummary/arim.config.rst b/docs/source/_autosummary/arim.config.rst
@@ -1,10 +1,14 @@
-arim.config
+arim.config
 ===========
 
 .. automodule:: arim.config
 
 
 
+
+
+
+
    .. rubric:: Functions
 
    .. autosummary::
@@ -25,4 +29,7 @@ arim.config
 
 
 
-
+
+
+
+
diff --git a/docs/source/_autosummary/arim.core.rst b/docs/source/_autosummary/arim.core.rst
@@ -1,10 +1,14 @@
-arim.core
+arim.core
 =========
 
 .. automodule:: arim.core
 
 
 
+
+
+
+
    .. rubric:: Functions
 
    .. autosummary::
@@ -40,4 +44,7 @@ arim.core
 
 
 
-
+
+
+
+
diff --git a/docs/source/_autosummary/arim.datasets.rst b/docs/source/_autosummary/arim.datasets.rst
@@ -0,0 +1,23 @@
+arim.datasets
+=============
+
+.. automodule:: arim.datasets
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/source/_autosummary/arim.exceptions.rst b/docs/source/_autosummary/arim.exceptions.rst
@@ -1,4 +1,4 @@
-arim.exceptions
+arim.exceptions
 ===============
 
 .. automodule:: arim.exceptions
@@ -13,6 +13,10 @@ arim.exceptions
 
 
 
+
+
+
+
    .. rubric:: Exceptions
 
    .. autosummary::
@@ -22,4 +26,7 @@ arim.exceptions
       InvalidShape
       NotAnArray
 
-
+
+
+
+
diff --git a/docs/source/_autosummary/arim.geometry.rst b/docs/source/_autosummary/arim.geometry.rst
@@ -1,10 +1,14 @@
-arim.geometry
+arim.geometry
 =============
 
 .. automodule:: arim.geometry
 
 
 
+
+
+
+
    .. rubric:: Functions
 
    .. autosummary::
@@ -54,4 +58,7 @@ arim.geometry
 
 
 
-
+
+
+
+
diff --git a/docs/source/_autosummary/arim.helpers.rst b/docs/source/_autosummary/arim.helpers.rst
@@ -1,10 +1,14 @@
-arim.helpers
+arim.helpers
 ============
 
 .. automodule:: arim.helpers
 
 
 
+
+
+
+
    .. rubric:: Functions
 
    .. autosummary::
@@ -33,4 +37,7 @@ arim.helpers
 
 
 
-
+
+
+
+
diff --git a/docs/source/_autosummary/arim.im.das.rst b/docs/source/_autosummary/arim.im.das.rst
@@ -1,10 +1,14 @@
-arim.im.das
+arim.im.das
 ===========
 
 .. automodule:: arim.im.das
 
 
 
+
+
+
+
    .. rubric:: Functions
 
    .. autosummary::
@@ -13,6 +17,8 @@ arim.im.das
       delay_and_sum_naive
       delay_and_sum_numba
       delay_and_sum_numba_noamp
+      lanczos_interpolation
+      sinc
 
 
 
@@ -28,4 +34,7 @@ arim.im.das
 
       NotImplementedTyping
 
-
+
+
+
+
diff --git a/docs/source/_autosummary/arim.im.rst b/docs/source/_autosummary/arim.im.rst
@@ -1,4 +1,4 @@
-arim.im
+arim.im
 =======
 
 .. automodule:: arim.im
@@ -13,4 +13,11 @@ arim.im
 
 
 
-
+
+
+
+
+
+
+
+
diff --git a/docs/source/_autosummary/arim.im.tfm.rst b/docs/source/_autosummary/arim.im.tfm.rst
@@ -1,14 +1,21 @@
-arim.im.tfm
+arim.im.tfm
 ===========
 
 .. automodule:: arim.im.tfm
 
 
 
+
+
+
+
    .. rubric:: Functions
 
    .. autosummary::
 
+      angle_limit
+      angle_limit_for_view
+      angle_limit_in_contact
       contact_tfm
       extrema_lookup_times_in_rectbox
       tfm_for_view
@@ -36,4 +43,7 @@ arim.im.tfm
 
       IncompleteFrameWarning
 
-
+
+
+
+
diff --git a/docs/source/_autosummary/arim.io.brain.rst b/docs/source/_autosummary/arim.io.brain.rst
@@ -1,10 +1,14 @@
-arim.io.brain
+arim.io.brain
 =============
 
 .. automodule:: arim.io.brain
 
 
 
+
+
+
+
    .. rubric:: Functions
 
    .. autosummary::
@@ -26,4 +30,7 @@ arim.io.brain
       InvalidExpData
       NotHandledByScipy
 
-
+
+
+
+
diff --git a/docs/source/_autosummary/arim.io.native.rst b/docs/source/_autosummary/arim.io.native.rst
@@ -1,10 +1,14 @@
-arim.io.native
+arim.io.native
 ==============
 
 .. automodule:: arim.io.native
 
 
 
+
+
+
+
    .. rubric:: Functions
 
    .. autosummary::
@@ -35,4 +39,7 @@ arim.io.native
 
       InvalidConf
 
-
+
+
+
+
diff --git a/docs/source/_autosummary/arim.io.rst b/docs/source/_autosummary/arim.io.rst
@@ -1,4 +1,4 @@
-arim.io
+arim.io
 =======
 
 .. automodule:: arim.io
@@ -13,4 +13,11 @@ arim.io
 
 
 
-
+
+
+
+
+
+
+
+
-Original file line number
+Diff line change
@@ -1,4 +1,4 @@
-    arim.im
+    arim.im
     =======
     .. automodule:: arim.im
@@ @@ -13,4 +13,11 @@ arim.im @@