Merge pull request #1 from hz-b/dev/feature/ci-badge

Adding CI status badge

.github/workflows/python-package.yml

@@ -16,7 +16,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.9", "3.10", "3.11"]
+        python-version: [ "3.9", "3.10", "3.11", "3.12" ]
+        numpy-version: [ "numpy<2.0", "numpy>=2.0" ]
     steps:
     - name: Checkout
       uses: actions/checkout@v4
@@ -30,13 +31,15 @@ jobs:
           path: bact-math-utils
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v3
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
+        numpy-version: ${{ matrix.numpy-version }} 
         cache: 'pip'
         cache-dependency-path: |
            **/setup.cfg
            **/requirements*.txt
+           **/pyproject.toml
 
     - name: Install pip
       run: |
@@ -56,7 +59,7 @@ jobs:
         if [ -f $t_dir/requirements.txt ]; then pip install -r $t_dir/requirements.txt; fi
         # need to install myself ?
         # make it a path otherwise pip serach pypi repo
-        pip install $t_dir/
+        pip install '${{ matrix.numpy-version }}' $t_dir/
         
     - name: Lint with flake8
       run: |

README.md

@@ -0,0 +1,9 @@
+[![CI](https://github.com/hz-b/bact-analysis/actions/workflows/python-package.yml/badge.svg)](https://github.com/hz-b/bact-analysis/actions/workflows/python-package.yml)
+
+# Analysis tools for accelerator optimisation problems
+
+Collection of tools for evaluating measurements of
+accelerator lattice e.g.
+
+* Linear optics from closed orbits (LOCO)
+* Beam based alignment (bba)

setup.cfg

@@ -9,7 +9,7 @@ author = Pierre Schnizer
 author_email = pierre.schnizer@helmholtz-berlin.de
 license = GPL
 description = Berlin accelerator comissioning tools
-long_description = file: README.rst
+long_description = file: README.md
 classifiers =
     Development Status :: 2 - Pre-Alpha
     Intended Audience :: Science/Research