Merge branch 'main' into fix/support_slice_elements

Author: giadarol

.github/workflows/dependencies.yaml

@@ -20,10 +20,12 @@ concurrency:
   group: ${{ github.workflow }}
 
 env:
+  # Note: the last version in this list is used to for sphinx-docs and pypi-releases
   PYTHON_VERSIONS: |
     3.9
     3.10
     3.11
+    3.13
     3.12
 
 jobs:
@@ -43,12 +45,17 @@ jobs:
           cd requirements
           for VER in $PYTHON_VERSIONS
           do
+            echo "::group::Updating dependencies for python $VER..."
             python$VER -m pip install pip-tools==7.4.1
             python$VER -m piptools compile --upgrade --no-annotate -o examples-requirements-py$VER.txt --all-extras ../pyproject.toml examples.in
             python$VER -m piptools compile --upgrade --no-annotate -o tests-requirements-py$VER.txt examples-requirements-py$VER.txt tests.in
+            echo "::endgroup::"
           done
-          # use last version for docs 
+          # use last version for docs and releases
+          echo "::group::Updating dependencies for docs and release using python $VER..."
+          echo "$VER" > .python-version
           python$VER -m piptools compile --upgrade --no-annotate -o docs-requirements.txt examples-requirements-py$VER.txt docs.in
+          echo "::endgroup::"
 
       - name: Open PR
         uses: peter-evans/[email protected]

.github/workflows/release.yaml

@@ -12,7 +12,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
         with:
-          python-version: '3.12'
+          python-version-file: 'requirements/.python-version'
       - run: |
           # Assert git and python versions match
           pip install -e .
@@ -32,7 +32,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
         with:
-          python-version: '3.12'
+          python-version-file: 'requirements/.python-version'
       - run: |
           pip install build
       - name: Build
@@ -70,7 +70,7 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-python@v5
         with:
-          python-version: '3.12'
+          python-version-file: 'requirements/.python-version'
       - name: Install dependencies
         run: |
           pip install -r requirements/docs-requirements.txt
@@ -108,7 +108,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
         with:
-          python-version: '3.12'
+          python-version-file: 'requirements/.python-version'
       - run: |
           pip install build
       - name: Build

.github/workflows/release_trigger.yaml

@@ -22,7 +22,7 @@ jobs:
           ssh-key: ${{ secrets.RELEASE_TRIGGER_WORKFLOW_KEY }}
       - uses: actions/setup-python@v5
         with:
-          python-version: '3.12'
+          python-version-file: 'requirements/.python-version'
       - run: |
           # Determine version
           pip install -e .

.github/workflows/test.yaml

@@ -6,8 +6,9 @@ jobs:
   pytest:
     runs-on: ubuntu-24.04
     strategy:
+      fail-fast: false
       matrix:
-        python-version: [ '3.9', '3.10', '3.11', '3.12' ]
+        python-version: [ '3.9', '3.10', '3.11', '3.12' ] # , '3.13'
         dep-versions: [ '' ]  # 'numpy1'
         exclude:
           - python-version: '3.12'
@@ -35,7 +36,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
         with:
-          python-version: '3.12'
+          python-version-file: 'requirements/.python-version'
       - name: Install dependencies
         run: |
           pip install -r requirements/docs-requirements.txt
@@ -50,7 +51,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
         with:
-          python-version: '3.12'
+          python-version-file: 'requirements/.python-version'
       - uses: pre-commit/[email protected]
         with:
           extra_args: --all-files --hook-stage=manual
@@ -64,7 +65,7 @@ jobs:
 #          fetch-depth: 0
 #      - uses: actions/setup-python@v5
 #        with:
-#          python-version: '3.12'
+#          python-version-file: 'requirements/.python-version'
 #      - run: |
 #          # Determine version
 #          pip install -e .

.pre-commit-config.yaml

@@ -1,14 +1,14 @@
 repos:
   - repo: https://github.com/psf/black
-    rev: 24.10.0
+    rev: 25.1.0
     hooks:
       - id: black
       - id: black-jupyter
         types: [jupyter]
         args: [--line-length=85]  # notebooks (for sphinx docs)
 
   - repo: https://github.com/pycqa/pylint
-    rev: v3.3.3
+    rev: v3.3.7
     hooks:
       - id: pylint
 

README.md

@@ -12,7 +12,7 @@ A plotting library for [Xsuite](https://github.com/xsuite) and simmilar accelera
 ## Usage
 
 ```bash
-pip install xplt[full]
+pip install xplt[recommended]
 ```
 
 Read the docs at https://xsuite.github.io/xplt

docs/quickstart.md

@@ -4,11 +4,15 @@
 ## Installation
 
 ```bash
-pip install xplt[full]
+pip install xplt[recommended]
 ```
 
-It is recommended to install the library with all optional dependencies, to make use its full functionality.
-For a minimal installation without `[full]`, certain features like automatic unit conversion and resolving or support for pandas dataframes are disabled. 
+The following extras are available:
+- `xplt[minimal]` Minimal installation, certain features like unit conversion and unit resolving are disabled
+- `xplt[recommended]` Recommended default
+- `xplt[full]` Includes optional dependencies, adds support for pandas data frames
+
+Currently, `pip install xplt` defaults to `xplt[minimal]`. Once [PEP 771](https://peps.python.org/pep-0771/) is established, this will change to `xplt[recommended]` instead.
 
 
 ## Gallery

pyproject.toml

@@ -20,27 +20,37 @@ classifiers = [
     "Framework :: Matplotlib",
     "Programming Language :: Python :: 3",
 ]
+dynamic = ["version"]
 
 requires-python = ">=3.9"
 dependencies = [
     "matplotlib>=3.6",
     "numpy>=1.17.0",
     "scipy>=1.2.0",
 ]
-dynamic = ["version"]
 
-[project.urls]
-homepage = "https://github.com/eltos/xplt"
-documentation = "https://xsuite.github.io/xplt"
-repository = "https://github.com/xsuite/xplt"
+# PEP 771
+#default-optional-dependency-keys = [
+#    "recommended",
+#]
 
 [project.optional-dependencies]
+minimal= []
+recommended = [
+    "pint>=0.24.1",
+]
 full = [
-    "pandas",
     "pint>=0.24.1",
+    "pandas",
 ]
 
 
+[project.urls]
+homepage = "https://github.com/eltos/xplt"
+documentation = "https://xsuite.github.io/xplt"
+repository = "https://github.com/xsuite/xplt"
+
+
 # Build tools
 
 [build-system]

requirements/.python-version

@@ -0,0 +1 @@
+3.12