Merge branch 'master' into Gamma_c

PlasmaControl · Dec 13, 2024 · ce98913 · ce98913
2 parents c312aa1 + 9ef0b38
commit ce98913
Show file tree

Hide file tree

Showing 13 changed files with 254 additions and 101 deletions.
diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml
@@ -58,28 +58,35 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
+      - name: Check full Python version
+        run: |
+          python --version
+          python_version=$(python --version 2>&1 | cut -d' ' -f2)
+          echo "Python version: $python_version"
+          echo "version=$python_version" >> $GITHUB_ENV
+
       - name: Restore Python environment cache
         if: env.has_changes == 'true'
         id: restore-env
         uses: actions/cache/restore@v4
         with:
-          path: .venv-${{ matrix.python-version }}
-          key: ${{ runner.os }}-venv-${{ matrix.python-version }}-${{ hashFiles('devtools/dev-requirements.txt', 'requirements.txt') }}
+          path: .venv-${{ env.version }}
+          key: ${{ runner.os }}-venv-${{ env.version }}-${{ hashFiles('devtools/dev-requirements.txt', 'requirements.txt') }}
 
       - name: Set up virtual environment if not restored from cache
         if: steps.restore-env.outputs.cache-hit != 'true' && env.has_changes == 'true'
         run: |
           gh cache list
-          python -m venv .venv-${{ matrix.python-version }}
-          source .venv-${{ matrix.python-version }}/bin/activate
+          python -m venv .venv-${{ env.version }}
+          source .venv-${{ env.version }}/bin/activate
           python -m pip install --upgrade pip
           pip install -r devtools/dev-requirements.txt
           pip install matplotlib==3.9.2
 
       - name: Benchmark with pytest-benchmark (PR)
         if: env.has_changes == 'true'
         run: |
-          source .venv-${{ matrix.python-version }}/bin/activate
+          source .venv-${{ env.version }}/bin/activate
           pwd
           lscpu
           pip list
@@ -106,7 +113,7 @@ jobs:
       - name: Benchmark with pytest-benchmark (MASTER)
         if: env.has_changes == 'true'
         run: |
-          source .venv-${{ matrix.python-version }}/bin/activate
+          source .venv-${{ env.version }}/bin/activate
           pwd
           lscpu
           pip list
@@ -122,7 +129,7 @@ jobs:
       - name: Put benchmark results in same folder
         if: env.has_changes == 'true'
         run: |
-          source .venv-${{ matrix.python-version }}/bin/activate
+          source .venv-${{ env.version }}/bin/activate
           pwd
           cd tests/benchmarks
           find .benchmarks/ -type f -printf "%T@ %p\n" | sort -n | cut -d' ' -f 2- | tail -n 1 > temp1
@@ -143,7 +150,7 @@ jobs:
       - name: Compare latest commit results to the master branch results
         if: env.has_changes == 'true'
         run: |
-          source .venv-${{ matrix.python-version }}/bin/activate
+          source .venv-${{ env.version }}/bin/activate
           cd tests/benchmarks
           pwd
           python compare_bench_results.py

diff --git a/.github/workflows/black.yml b/.github/workflows/black.yml
@@ -19,25 +19,32 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
+      - name: Check full Python version
+        run: |
+          python --version
+          python_version=$(python --version 2>&1 | cut -d' ' -f2)
+          echo "Python version: $python_version"
+          echo "version=$python_version" >> $GITHUB_ENV
+
       - name: Restore Python environment cache
         id: restore-env
         uses: actions/cache/restore@v4
         with:
-          path: .venv-${{ matrix.python-version }}
-          key: ${{ runner.os }}-venv-${{ matrix.python-version }}-${{ hashFiles('devtools/dev-requirements.txt', 'requirements.txt') }}
+          path: .venv-${{ env.version }}
+          key: ${{ runner.os }}-venv-${{ env.version }}-${{ hashFiles('devtools/dev-requirements.txt', 'requirements.txt') }}
 
       - name: Set up virtual environment if not restored from cache
         if: steps.restore-env.outputs.cache-hit != 'true'
         run: |
           gh cache list
-          python -m venv .venv-${{ matrix.python-version }}
-          source .venv-${{ matrix.python-version }}/bin/activate
+          python -m venv .venv-${{ env.version }}
+          source .venv-${{ env.version }}/bin/activate
           python -m pip install --upgrade pip
           pip install -r devtools/dev-requirements.txt
 
       - name: Check files using the black formatter
         run: |
-          source .venv-${{ matrix.python-version }}/bin/activate
+          source .venv-${{ env.version }}/bin/activate
           black --version
           black --check desc/ tests/ || black_return_code=$?
           echo "BLACK_RETURN_CODE=$black_return_code" >> $GITHUB_ENV

diff --git a/.github/workflows/cache_dependencies.yml b/.github/workflows/cache_dependencies.yml
@@ -24,21 +24,28 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
+      - name: Check full Python version
+        run: |
+          python --version
+          python_version=$(python --version 2>&1 | cut -d' ' -f2)
+          echo "Python version: $python_version"
+          echo "version=$python_version" >> $GITHUB_ENV
+
       - name: Delete old cached file with same python version
         run: |
           echo "Current Cached files list"
           gh cache list
-          echo "Deleting cached files with pattern: ${{ runner.os }}-venv-${{ matrix.python-version }}-"
-          for cache_key in $(gh cache list --json key -q ".[] | select(.key | startswith(\"${{ runner.os }}-venv-${{ matrix.python-version }}-\")) | .key"); do
+          echo "Deleting cached files with pattern: ${{ runner.os }}-venv-${{ env.version }}-"
+          for cache_key in $(gh cache list --json key -q ".[] | select(.key | startswith(\"${{ runner.os }}-venv-${{ env.version }}-\")) | .key"); do
             echo "Deleting cache with key: $cache_key"
             gh cache delete "$cache_key"
           done
 
       # Update the matplotlib version if needed later
       - name: Set up virtual environment
         run: |
-          python -m venv .venv-${{ matrix.python-version }}
-          source .venv-${{ matrix.python-version }}/bin/activate
+          python -m venv .venv-${{ env.version }}
+          source .venv-${{ env.version }}/bin/activate
           python -m pip install --upgrade pip
           pip install -r devtools/dev-requirements.txt
           pip install matplotlib==3.9.2
@@ -47,12 +54,13 @@ jobs:
         id: cache-env
         uses: actions/cache@v4
         with:
-          path: .venv-${{ matrix.python-version }}
-          key: ${{ runner.os }}-venv-${{ matrix.python-version }}-${{ hashFiles('devtools/dev-requirements.txt', 'requirements.txt') }}
+          path: .venv-${{ env.version }}
+          key: ${{ runner.os }}-venv-${{ env.version }}-${{ hashFiles('devtools/dev-requirements.txt', 'requirements.txt') }}
 
       - name: Verify virtual environment activation
         run: |
-          source .venv-${{ matrix.python-version }}/bin/activate
+          source .venv-${{ env.version }}/bin/activate
+          which python
           python --version
           pip --version
           pip list
diff --git a/.github/workflows/jax_tests.yml b/.github/workflows/jax_tests.yml
@@ -15,10 +15,11 @@ jobs:
         jax-version: [0.4.12, 0.4.13, 0.4.14, 0.4.16, 0.4.17,
                       0.4.18, 0.4.19, 0.4.20, 0.4.21, 0.4.22, 0.4.23,
                       0.4.24, 0.4.25, 0.4.26, 0.4.27, 0.4.28, 0.4.29,
-                      0.4.30, 0.4.31, 0.4.33, 0.4.34, 0.4.35]
+                      0.4.30, 0.4.31, 0.4.33, 0.4.34, 0.4.35, 0.4.37]
                       # 0.4.32 is not available on PyPI
                       # earlier jax versions are not compatible with other
                       # dependencies as of 2024-10-04
+                      # 0.4.36 has a bug that causes tests to fail
         group: [1, 2]
     steps:
       - uses: actions/checkout@v4
@@ -44,7 +45,6 @@ jobs:
         run: |
           pwd
           lscpu
-          pip list
           python -m pytest -m unit \
             --durations=0 \
             --mpl \

diff --git a/.github/workflows/notebook_tests.yml b/.github/workflows/notebook_tests.yml
@@ -51,28 +51,35 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
+      - name: Check full Python version
+        run: |
+          python --version
+          python_version=$(python --version 2>&1 | cut -d' ' -f2)
+          echo "Python version: $python_version"
+          echo "version=$python_version" >> $GITHUB_ENV
+
       - name: Restore Python environment cache
         if: env.has_changes == 'true'
         id: restore-env
         uses: actions/cache/restore@v4
         with:
-          path: .venv-${{ matrix.python-version }}
-          key: ${{ runner.os }}-venv-${{ matrix.python-version }}-${{ hashFiles('devtools/dev-requirements.txt', 'requirements.txt') }}
+          path: .venv-${{ env.version }}
+          key: ${{ runner.os }}-venv-${{ env.version }}-${{ hashFiles('devtools/dev-requirements.txt', 'requirements.txt') }}
 
       - name: Set up virtual environment if not restored from cache
         if: steps.restore-env.outputs.cache-hit != 'true' && env.has_changes == 'true'
         run: |
           gh cache list
-          python -m venv .venv-${{ matrix.python-version }}
-          source .venv-${{ matrix.python-version }}/bin/activate
+          python -m venv .venv-${{ env.version }}
+          source .venv-${{ env.version }}/bin/activate
           python -m pip install --upgrade pip
           pip install -r devtools/dev-requirements.txt
           pip install matplotlib==3.9.2
 
       - name: Test notebooks with pytest and nbmake
         if: env.has_changes == 'true'
         run: |
-          source .venv-${{ matrix.python-version }}/bin/activate
+          source .venv-${{ env.version }}/bin/activate
           pwd
           lscpu
           pip list

diff --git a/.github/workflows/regression_tests.yml b/.github/workflows/regression_tests.yml
@@ -50,20 +50,27 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
+      - name: Check full Python version
+        run: |
+          python --version
+          python_version=$(python --version 2>&1 | cut -d' ' -f2)
+          echo "Python version: $python_version"
+          echo "version=$python_version" >> $GITHUB_ENV
+
       - name: Restore Python environment cache
         if: env.has_changes == 'true'
         id: restore-env
         uses: actions/cache/restore@v4
         with:
-          path: .venv-${{ matrix.python-version }}
-          key: ${{ runner.os }}-venv-${{ matrix.python-version }}-${{ hashFiles('devtools/dev-requirements.txt', 'requirements.txt') }}
+          path: .venv-${{ env.version }}
+          key: ${{ runner.os }}-venv-${{ env.version }}-${{ hashFiles('devtools/dev-requirements.txt', 'requirements.txt') }}
 
       - name: Set up virtual environment if not restored from cache
         if: steps.restore-env.outputs.cache-hit != 'true' && env.has_changes == 'true'
         run: |
           gh cache list
-          python -m venv .venv-${{ matrix.python-version }}
-          source .venv-${{ matrix.python-version }}/bin/activate
+          python -m venv .venv-${{ env.version }}
+          source .venv-${{ env.version }}/bin/activate
           python -m pip install --upgrade pip
           pip install -r devtools/dev-requirements.txt
           pip install matplotlib==3.9.2
@@ -77,7 +84,7 @@ jobs:
       - name: Test with pytest
         if: env.has_changes == 'true'
         run: |
-          source .venv-${{ matrix.python-version }}/bin/activate
+          source .venv-${{ env.version }}/bin/activate
           pwd
           lscpu
           pip list

diff --git a/.github/workflows/unit_tests.yml b/.github/workflows/unit_tests.yml
@@ -56,20 +56,27 @@ jobs:
         with:
           python-version: ${{ matrix.combos.python_version }}
 
+      - name: Check full Python version
+        run: |
+          python --version
+          python_version=$(python --version 2>&1 | cut -d' ' -f2)
+          echo "Python version: $python_version"
+          echo "version=$python_version" >> $GITHUB_ENV
+
       - name: Restore Python environment cache
         if: env.has_changes == 'true'
         id: restore-env
         uses: actions/cache/restore@v4
         with:
-          path: .venv-${{ matrix.combos.python_version }}
-          key: ${{ runner.os }}-venv-${{ matrix.combos.python_version }}-${{ hashFiles('devtools/dev-requirements.txt', 'requirements.txt') }}
+          path: .venv-${{ env.version }}
+          key: ${{ runner.os }}-venv-${{ env.version }}-${{ hashFiles('devtools/dev-requirements.txt', 'requirements.txt') }}
 
       - name: Set up virtual environment if not restored from cache
         if: steps.restore-env.outputs.cache-hit != 'true' && env.has_changes == 'true'
         run: |
           gh cache list
-          python -m venv .venv-${{ matrix.combos.python_version }}
-          source .venv-${{ matrix.combos.python_version }}/bin/activate
+          python -m venv .venv-${{ env.version }}
+          source .venv-${{ env.version }}/bin/activate
           python -m pip install --upgrade pip
           pip install -r devtools/dev-requirements.txt
           pip install matplotlib==3.9.2
@@ -80,13 +87,20 @@ jobs:
         with:
           swap-size-gb: 10
 
-      - name: Test with pytest
+      - name: Action Details
         if: env.has_changes == 'true'
         run: |
-          source .venv-${{ matrix.combos.python_version }}/bin/activate
+          source .venv-${{ env.version }}/bin/activate
+          which python
+          python --version
           pwd
           lscpu
           pip list
+
+      - name: Test with pytest
+        if: env.has_changes == 'true'
+        run: |
+          source .venv-${{ env.version }}/bin/activate
           python -m pytest -v -m unit \
             --durations=0 \
             --cov-report xml:cov.xml \

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,8 @@ Changelog
 New Feature
 
 - Adds a new profile class ``PowerProfile`` for raising profiles to a power.
+- Adds an option ``scaled_termination`` (defaults to True) to all of the desc optimizers to measure the norms for ``xtol`` and ``gtol`` in the scaled norm provided by ``x_scale`` (which defaults to using an adaptive scaling based on the Jacobian or Hessian). This should make things more robust when optimizing parameters with widely different magnitudes. The old behavior can be recovered by passing ``options={"scaled_termination": False}``.
+- ``desc.objectives.Omnigenity`` is now vectorized and able to optimize multiple surfaces at the same time. Previously it was required to use a different objective for each surface.
 
 Bug Fixes
 
@@ -31,7 +33,7 @@ New Features
 - Adds ``eq_fixed`` flag to ``ToroidalFlux`` to allow for the equilibrium/QFM surface to vary during optimization, useful for single-stage optimizations.
 - Adds tutorial notebook showcasing QFM surface capability.
 - Adds ``rotate_zeta`` function to ``desc.compat`` to rotate an ``Equilibrium`` around Z axis.
-- Adds an option ``scaled_termination`` (defaults to True) to all of the desc optimizers to measure the norms for ``xtol`` and ``gtol`` in the scaled norm provided by ``x_scale`` (which defaults to using an adaptive scaling based on the Jacobian or Hessian). This should make things more robust when optimizing parameters with widely different magnitudes. The old behavior can be recovered by passing ``options={"scaled_termination": False}``.
+
 
 Bug Fixes