towards release

Author: JoschD

.github/workflows/coverage.yml

@@ -9,6 +9,7 @@ on:  # Runs on all push events to master branch and any push related to a pull r
 
 jobs:
   coverage:
+      if: false  # disabled for now
       uses: pylhc/.github/.github/workflows/coverage.yml@master
       with:
         src-dir: omc3_gui 

.github/workflows/cron.yml

@@ -8,4 +8,5 @@ on:
 
 jobs:
     tests:
+      if: false  # disabled for now
       uses: pylhc/.github/.github/workflows/cron.yml@master

.github/workflows/tests.yml

@@ -12,4 +12,5 @@ on:  # Runs on any push event to any branch except master (the coverage workflow
 
 jobs:
   tests:
+    if: false  # disabled for now
     uses: pylhc/.github/.github/workflows/tests.yml@master

.zenodo.json

@@ -9,29 +9,11 @@
             "affiliation": "CERN",
             "orcid": "0000-0001-7864-5448"
         },
-        {
-            "name": "Felix Soubelet",
-            "affiliation": "University of Liverpool & CERN",
-            "orcid": "0000-0001-8012-1440"
-        },
-        {
-            "name": "Andreas Wegscheider",
-            "affiliation": "CERN"
-        },
         {
             "name": "Jaime Maria Coello De Portugal - Martinez Vazquez",
             "affiliation": "CERN",
             "orcid": "0000-0002-6899-3809"
         },
-        {
-            "name": "Maël Le Garrec",
-            "affiliation": "CERN",
-            "orcid": "0000-0002-8146-2340"
-        },
-        {
-            "name": "Tobias Persson",
-            "affiliation": "CERN"
-        },
         {
             "name": "Rogelio Tomas Garcia",
             "affiliation": "CERN",

CHANGELOG.md

@@ -1,11 +1,35 @@
 # OMC3-GUI Changelog
 
+#### 2025-04-04 - v1.0.0 - Segment-by-Segment GUI
+
+- Maintenance:
+  - `pyproject.toml` used instead of `setup.py`.
+  - Deactivated testing workflows as there are no tests.
+  - Documentation
+
+- Initial release of the Segment-by-Segment GUI:
+  - Implements plotting for the Segment-by-Segment propagation of the 
+    omc3 backend. Requires `omc3 >= 0.24.0`.
+  - Plotting for the SegmentDiffs of `AlphaPhase`, `BetaPhase`, `Dispersion`
+    and `Coupling`.
+  - Saving and loading of the optics measurements from `.json` files.
+  - Create virtual `copy` of the measurements.
+
+- General plotting functionality with `pyqtgraph`:
+  - `PlotWidget` to replicate the look-and-feel of the Java-GUI plots.
+  - `DualPlotWidget` to handle two plots in one widget (as often the case in our GUIs for two planes).
+  - Plotting for pandas Dataframes.
+  - Plotting for model elements as vertical lines.
+
+- General reusable Tools:
+  - Dataclass UI: Widgets to display and edit dataclasses in UI.
+  - Widgets, threads, item models, file dialogs
 
 #### 2023-06-20 - v0.0.0 - Inital commit
 
-- `setup.py` and packaging functionality 
-- Automated CI
-    - Multiple versions of python
-    - Accuracy tests
-    - Unit tests
-    - Release automation
+- `setup.py` and packaging functionality
+- Automated CI:
+  - Multiple versions of python
+  - Accuracy tests
+  - Unit tests
+  - Release automation

Makefile

@@ -40,9 +40,9 @@ Codes can then be run with either `python -m omc3_gui.SCRIPT --FLAG ARGUMENT` or
 #### Main Scripts
 
 Main scripts to be executed lie in the [`/omc3_gui`](omc3_gui) directory. These include:
-- `.py` Nothing here yet.
+- `sbs_gui.py` GUI for Segment-by-Segment analysis.
 
 
 ## License
 
-This project is licensed under the `GNU GENERAL PUBLIC LICENSE v3 License` - see the [LICENSE](LICENSE) file for details.
+This project is licensed under the `MIT License` - see the [LICENSE](LICENSE) file for details.

README.md

@@ -47,11 +47,6 @@ html:
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
 
-josch:
-	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) ~/Software/Documentation/omc3_gui-doc
-	@echo
-	@echo "Build finished. The HTML pages are in ~/Software/Documentation/omc3_gui-doc."
-
 dirhtml:
 	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
 	@echo

doc/Makefile

@@ -272,4 +272,24 @@ em.sig-param span.default_value {
     padding-top: 10px;
     padding-bottom: 5px;
   }
-}
+}
+
+/* Custom styles for bibliography */
+.citation {
+    display: block!important;
+}
+
+.citation .label {
+    display: block;
+    font-weight: bold;
+    margin-bottom: 0.5em;
+}
+
+.citation p {
+    margin: 0;
+    padding-left: 1em;
+}
+
+.citation cite {
+    display: block;
+}

doc/_static/css/custom.css

@@ -0,0 +1,4 @@
+Bibliography
+************
+
+This bibliography is inentionally left blank.