Merge pull request #317 from linien-org/release/v0.7.0

Release v0.7.0

.flake8

@@ -1,5 +1,5 @@
-[flake8]
-max-line-length = 88
-per-file-ignores =
-extend-ignore = E203, E402, E731, W503
-    tests/*: D103, D100
+[flake8]
+max-line-length = 88
+per-file-ignores =
+extend-ignore = E203, E402, E731, W503
+    tests/*: D103, D100

.github/workflows/publish-pypi.yml

@@ -1,4 +1,4 @@
-name: PublishPackages
+name: Publish Packages
 
 on:
   workflow_dispatch:

.github/workflows/pyinstaller-windows.yml

@@ -2,6 +2,11 @@ name: Pyinstaller Windows
 
 on:
   workflow_dispatch:
+  push:
+    paths:
+      - linien-common/**
+      - linien-client/**
+      - linien-gui/**
 
 jobs:
   build:

.github/workflows/pytest.yml

@@ -2,6 +2,12 @@ name: Run PyTest
 
 on:
   workflow_dispatch:
+  push:
+    paths:
+      - gateware/**
+      - linien-common/**
+      - linien-server/**
+      - tests/**
 
 permissions:
   contents: read

.pre-commit-config.yaml

@@ -3,7 +3,7 @@ repos:
     rev: 23.1.0
     hooks:
       - id: black
-        exclude: ^(gateware/logic/|gateware/lowlevel/|linien/server/csrmap.py)
+        exclude: ^(gateware/logic/|gateware/lowlevel/|gateware/linien_module.py|linien-server/linien_server/csrmap.py)
 
   - repo: https://github.com/pycqa/isort
     rev: 5.12.0

CITATION.cff

@@ -0,0 +1,54 @@
+cff-version: 1.2.0
+message: If you are using Linien as part of a scientific publication, please cite our article.
+authors:
+  - given-names: Benjamin
+    family-names: Wiegand
+    email: [email protected]
+    affiliation: Institut für Physik, Humboldt-Universität zu Berlin
+    orcid: "https://orcid.org/0000-0001-6549-2307"
+  - family-names: Leykauf
+    given-names: Bastian
+    email: [email protected]
+    affiliation: Institut für Physik, Humboldt-Universität zu Berlin
+    orcid: "https://orcid.org/0000-0002-4630-0602"
+  - family-names: Jördens
+    given-names: Robert
+    affiliation: '"QUARTIQ GmbH'
+    orcid: "https://orcid.org/0000-0001-5333-0562"
+preferred-citation:
+  type: article
+  title: >-
+    Linien: A versatile, user-friendly, open-source FPGA-based tool for frequency
+    stabilization and spectroscopy parameter optimization
+  authors:
+    - given-names: Benjamin
+      family-names: Wiegand
+      email: [email protected]
+      affiliation: >-
+        Institut für Physik, Humboldt-Universität zu
+        Berlin
+      orcid: "https://orcid.org/0000-0001-6549-2307"
+    - family-names: Leykauf
+      given-names: Bastian
+      email: [email protected]
+      affiliation: >-
+        Institut für Physik, Humboldt-Universität zu
+        Berlin
+      orcid: "https://orcid.org/0000-0002-4630-0602"
+    - family-names: Jördens
+      given-names: Robert
+      affiliation: '"QUARTIQ GmbH'
+      orcid: "https://orcid.org/0000-0001-5333-0562"
+    - family-names: Krutzik
+      given-names: Markus
+      affiliation: >-
+        Institut für Physik, Humboldt-Universität zu
+        Berlin & Ferdinand-Braun-Institut gGmbH,
+        Leibniz-Institut für Höchstfrequenztechnik
+  doi: "10.1063/5.0090384"
+  url: "https://doi.org/10.1063/5.0090384"
+  journal: "Review of Scientific Instruments"
+  volume: 93
+  issue: 6
+  start: "063001"
+  year: 2022

README.md

@@ -33,7 +33,7 @@ Features
 -   **Logging**: Use
     [linien-influxdb](https://github.com/linien-org/linien-influxdb)
     to log the lock status to influxdb.
--   **Second integrator** on (slow) analog output 0
+-   **Second integrator** for slow control of piezo in an ECDL
 -   **Additional analog outputs** may be used using the GUI or python client (ANALOG_OUT 1, 2 and 3)
 -   **16 GPIO outputs** may be programmed (e.g. for controlling other devices)
 
@@ -350,7 +350,7 @@ except:
 Updating Linien
 ---------------
 
-Before installing a new version of Linien, open the previously installed client and click the "Shutdown server" button. Don't worry, your settings and parameters will be saved. Then you may install the latest client on your local PC as described in the [getting started](#getting-started) section above. The next time you connect to RedPitaya, Linien will install the matching server version.
+Before installing a new version of Linien, open the previously installed client and click the "Shutdown server" button. Don't worry, your settings and parameters will be saved. Then you may install the latest client on your local PC as described in the [getting started](#getting-started-install-linien) section above. The next time you connect to RedPitaya, Linien will install the matching server version.
 
 
 Development
@@ -439,9 +439,10 @@ License
 -------
 Linien ‒ User-friendly locking of lasers using RedPitaya (STEMlab 125-14) that just works.
 
-Copyright © 2014-2015 Robert Jördens
-Copyright © 2018-2022 Benjamin Wiegand
-Copyright © 2021-2023 Bastian Leykauf
+Copyright © 2014-2015 Robert Jördens\
+Copyright © 2018-2022 Benjamin Wiegand\
+Copyright © 2021-2023 Bastian Leykauf\
+Copyright © 2022 Christian Freier
 
 Linien is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
 

gateware/bit2bin.py

@@ -32,7 +32,7 @@ def bit2bin(bit, bin, flip=False):
     bitfile = open(bit, "rb")
 
     (l,) = struct.unpack(">H", bitfile.read(2))
-    if l != 9:
+    if l != 9:  # noqa E741
         raise ValueError("Missing <0009> header, not a bit file")
 
     bitfile.read(l)

gateware/build_fpga_image.sh

@@ -15,4 +15,5 @@ fi
 export PATH=$VIVADOPATH:$PATH
 
 rm linien-server/linien_server/linien.bin -f
-python3 gateware/fpga_image_helper.py
+# run with -m option to avoid errors related to relative imports without breaking pytest
+python3 -m gateware.fpga_image_helper

gateware/fpga_image_helper.py

@@ -22,9 +22,9 @@
 
 REPO_ROOT_DIR = Path(__file__).resolve().parents[1]
 
-from bit2bin import bit2bin
-from hw_platform import Platform
-from linien_module import RootModule
+from .bit2bin import bit2bin
+from .hw_platform import Platform
+from .linien_module import RootModule
 
 
 def py_csrconstants(map, fil):