Htc plus

.github/workflows/cron.yml

@@ -17,7 +17,7 @@ jobs:
       matrix:
         os: [ubuntu-22.04, ubuntu-24.04, macos-latest, windows-latest]
         # We escape with quotes so it doesn't get interpreted as float (e.g. 3.10 -> 3.1 by GA's parser)
-        python-version: ["3.10", "3.11", "3.12", "3.13"]  # add new versions when they are released
+        python-version: ["3.11", "3.12", "3.13"]  # add new versions when they are released
       fail-fast: false
 
     steps:

.github/workflows/tests.yml

@@ -17,7 +17,7 @@ jobs:
       matrix:
         os: [ubuntu-22.04, ubuntu-24.04, macos-latest, windows-latest]
         # We escape with quotes so it doesn't get interpreted as float (e.g. 3.10 -> 3.1 by GA's parser)
-        python-version: ["3.10", "3.11", "3.12", "3.13"]  # add new versions when they are released
+        python-version: ["3.11", "3.12", "3.13"]  # add new versions when they are released
       fail-fast: false
 
     steps:

docs/api.rst

@@ -1,8 +1,10 @@
+.. _api-top:
+
 API Reference
 =============
 
 .. toctree::
     :maxdepth: 2
     :glob:
-    
+
     api/*

docs/api/utils.rst

@@ -15,14 +15,10 @@ Utils
    :members:
    :noindex:
 
-.. automodule:: pyhdtoolkit.utils.htc_monitor
+.. automodule:: pyhdtoolkit.utils.htcondor
    :members:
    :noindex:
 
 .. automodule:: pyhdtoolkit.utils.logging
    :members:
    :noindex:
-
-.. .. automodule:: pyhdtoolkit.utils._misc
-..    :members:
-..    :noindex:

docs/index.rst

@@ -86,6 +86,7 @@ Contents
 
     quickstart
     gallery/index
+    scripts
     api
     contributing
     release
@@ -121,7 +122,7 @@ The following people have contributed to the development of PyhDToolkit by contr
 License
 -------
 
-The package is licensed under the `MIT license <https://github.com/fsoubelet/PyhDToolkit/blob/master/LICENSE>`_. 
+The package is licensed under the `MIT license <https://github.com/fsoubelet/PyhDToolkit/blob/master/LICENSE>`_.
 
 Indices and tables
 ------------------

docs/release.rst

@@ -3,6 +3,14 @@ Release Notes
 
 The full list of releases can be found in the GitHub repository's `releases page <https://github.com/fsoubelet/PyhDToolkit/releases>`_.
 
+Version 1.8.0
+-------------
+
+.. toctree::
+    :maxdepth: 2
+
+    releases/v1.8.0
+
 Version 1.7.0
 -------------
 

docs/releases/v1.8.0.rst

@@ -0,0 +1,35 @@
+.. _release_1.8.0:
+
+Release `1.8.0` brings some project maintenance and a complete refactor of the `HTCondor`-related utilities from the package.
+
+Removals
+~~~~~~~~
+
+* The `pyhdtoolkit.utils.htc_monitor` module has been removed, and its functionality split.
+
+Additions
+~~~~~~~~~
+
+* A new module, `pyhdtoolkit.utils.htcondor`, has been created to host all `HTCondor`-related utilities. The previous `htc_monitor` module's functionality has been moved here, with some improvements.
+* A new command-line script, `htcondor-monitor`, has been added to provide an easy way to monitor `HTCondor` clusters from the terminal. It contains the entrypoint from the previous `pyhdtoolkit.utils.htc_monitor` module, adapted to the new module structure.
+* The new script allows passing command-line options to customize its behavior (see its documentation and help message for details).
+* The new scripts provides a progress bar while waiting between `condor_q` calls.
+* The new script is declared as `htc-monitor` in the project metadata. It can be called simply as `htc-monitor` at the command line in an environment where `PyhDToolkit` is installed.
+
+Enhancements
+~~~~~~~~~~~~
+
+* The regex parsing in the `HTCondor` utilities has been made more robust.
+* The whole package now consistently makes use of postponed evaluations of annotations (see PEP 563).
+
+Documentation
+~~~~~~~~~~~~~
+
+* The documentation has been adapted to reflect the new module structure and command-line script.
+
+Maintenance
+~~~~~~~~~~~
+
+* Updated Continuous Integration workflows to switch to `uv`, speeding up CI runs.
+
+See `v1.8.0 release notes on GitHub <https://github.com/fsoubelet/PyhDToolkit/releases/tag/1.8.0>`_ and the `full changes since v1.7.0 <https://github.com/fsoubelet/PyhDToolkit/compare/1.7.0...1.8.0>`_.

docs/script/htc_monitor.rst

@@ -0,0 +1,8 @@
+.. _pyhdtoolkit-script-htcmonitor:
+
+HTCondor Monitor
+================
+
+.. automodule:: pyhdtoolkit.scripts.htc_monitor
+   :members:
+   :noindex:

docs/scripts.rst

@@ -0,0 +1,17 @@
+.. _scripts-top:
+
+Command Line Scripts
+====================
+
+We provide a set of small command line utilities within `PyhDToolkit`.
+Please note that scripts might require optional dependencies to be installed.
+
+Each script is registered in the project's metadata and will be callable from the command line with a simplified name after installing the package in your environment.
+For more information on each script such as required extras, registered name, options and examples, please refer to their dedicated documentation page.
+The following scripts are currently available:
+
+.. toctree::
+    :maxdepth: 2
+    :glob:
+
+    script/*

pyhdtoolkit/cpymadtools/_generators.py

@@ -10,6 +10,8 @@
 gallery <gallery>`.
 """
 
+from __future__ import annotations
+
 # ----- Utlites ----- #
 
 

pyhdtoolkit/cpymadtools/constants.py

@@ -8,6 +8,8 @@
 to help with consistency.
 """
 
+from __future__ import annotations
+
 _MAX_SECTOR_VALUE: int = 8
 
 # fmt: off

pyhdtoolkit/models/beam.py

@@ -8,6 +8,8 @@
 data structures relative to particle beams.
 """
 
+from __future__ import annotations
+
 from math import sqrt
 
 from pydantic import BaseModel

pyhdtoolkit/models/htc.py

@@ -8,7 +8,12 @@
 data obtained by querying the ``HTCondor`` queue.
 """
 
-from pendulum import DateTime
+from __future__ import annotations
+
+# Do not move DateTime import into a TYPE_CHECKING block, since
+# we need it defined to rebuild the pydantic model for validation
+# (this is required when using from __future__ import annotations)
+from pendulum import DateTime  # noqa: TC002
 from pydantic import BaseModel, ConfigDict
 
 
@@ -55,10 +60,15 @@ class HTCTaskSummary(BaseModel):
     model_config = ConfigDict(arbitrary_types_allowed=True)
 
     owner: str
-    batch_name: int
+    batch_name: int  # only keep the part after 'ID:'
     submitted: DateTime
-    done: int | str
-    run: int | str
-    idle: int | str
+    done: int | str  # can be "-" if jobs in other state
+    run: int | str  # can be "-" if jobs in other state
+    idle: int | str  # can be "-" if jobs in other state
     total: int
     job_ids: str
+
+
+# This is necessary to make pydantic recognize the DateTime type
+# from pendulum when using from __future__ import annotations
+HTCTaskSummary.model_rebuild()

pyhdtoolkit/models/madx.py

@@ -9,6 +9,8 @@
 through `cpymad`.
 """
 
+from __future__ import annotations
+
 from enum import Enum
 
 from pydantic import BaseModel, PositiveFloat, PositiveInt

pyhdtoolkit/optics/beam.py

@@ -8,6 +8,8 @@
 simple beam parameter calculations.
 """
 
+from __future__ import annotations
+
 import numpy as np
 from scipy import constants
 

pyhdtoolkit/optics/rdt.py

@@ -8,6 +8,8 @@
 resonance driving terms.
 """
 
+from __future__ import annotations
+
 
 def rdt_to_order_and_type(rdt: int | str) -> str:
     """

pyhdtoolkit/optics/twiss.py

@@ -7,6 +7,8 @@
 Module implementing various calculations based on the ``TWISS`` optics parameters.
 """
 
+from __future__ import annotations
+
 import numpy as np