Merge pull request #43 from bqth29/fixes

Fixes for version 1.2.1 release

.github/scripts/metadata_checker/metadata_checker.py

@@ -320,7 +320,7 @@ def check_license_date(
 
 
 def get_month_abbreviation(month_number: int) -> str:
-    with calendar.different_locale(("en-US", None)) as encoding:
+    with calendar.different_locale(("en_US", None)) as encoding:
         abbreviation = calendar.month_abbr[month_number]
         if encoding is not None:
             abbreviation = abbreviation.decode(encoding)

.github/workflows/test.yml

@@ -49,6 +49,7 @@ jobs:
           coverage json
 
       - name: Metadata check
+        if: ${{ matrix.python-version == '3.8' && matrix.os == 'ubuntu-latest' }}
         run: |
           python .github/scripts/metadata_checker
 

CITATION.cff

@@ -10,5 +10,5 @@ authors:
   given-names: Lorenzo
 title: "Simulated Bifurcation (SB) algorithm for Python"
 version: 1.2.1
-date-released: 2023-08-11
+date-released: 2023-11-23
 url: "https://github.com/bqth29/simulated-bifurcation-algorithm"

CODE_OF_CONDUCT.md

@@ -105,7 +105,7 @@ Violating these terms may lead to a permanent ban.
 ### 4. Permanent Ban
 
 **Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
+standards, including sustained inappropriate behavior, harassment of an
 individual, or aggression toward or disparagement of classes of individuals.
 
 **Consequence**: A permanent ban from any sort of public interaction within

README.md

@@ -263,7 +263,7 @@ If you are using this code for your own projects please cite our work:
 ```bibtex
 @software{Ageron_Simulated_Bifurcation_SB_2023,
     author = {Ageron, Romain and Bouquet, Thomas and Pugliese, Lorenzo},
-    month = aug,
+    month = nov,
     title = {{Simulated Bifurcation (SB) algorithm for Python}},
     url = {https://github.com/bqth29/simulated-bifurcation-algorithm},
     version = {1.2.1},

src/simulated_bifurcation/__init__.py

@@ -49,7 +49,7 @@
     `BinaryPolynomial`, `BinaryQuadraticPolynomial`, `IntegerPolynomial`,
     `IntegerQuadraticPolynomial`, `SpinPolynomial`, and
     `SpinQuadraticPolynomial` will be removed in simulated-bifurcation
-    1.3.0.  From version 1.3.0 onwards, polynomials will no longer have a
+    1.3.0. From version 1.3.0 onwards, polynomials will no longer have a
     definition domain. The domain only needs to be specified when creating
     an Ising model, and conversely when converting spins back into the
     original domain.

src/simulated_bifurcation/ising_core.py

@@ -324,7 +324,7 @@ def minimize(
             violate these constraints.
         Non-deterministic behaviour:
             The SB algorithm uses a randomized initialization, and this
-            package  is implemented with a PyTorch backend. To ensure a
+            package is implemented with a PyTorch backend. To ensure a
             consistent initialization when running the same script multiple
             times, use `torch.manual_seed`. However, results may not be
             reproducible between CPU and GPU executions, even when using

src/simulated_bifurcation/polynomial/integer_polynomial.py

@@ -63,7 +63,7 @@ class IntegerQuadraticPolynomial(BaseMultivariateQuadraticPolynomial):
     `ΣΣ Q(i,j)x(i)x(j) + Σ l(i)x(i) + c`
     or `x.T Q x + l.T x + c` in matrix notation,
     where `Q` is a square matrix, `l` is a vector and `c` is a constant.
-    The `x(i)`'s values  must be non-negative integers with a fixed
+    The `x(i)`'s values must be non-negative integers with a fixed
     bit-width. For instance 7-bits integers are the integers between 0 and
     127 inclusive.