Merge pull request #80 from bleykauf/feature/use-ruff

Replace isort/flake8/black with ruff

Author: bleykauf

.pre-commit-config.yaml

@@ -1,10 +1,7 @@
 repos:
-  - repo: https://github.com/psf/black
-    rev: 25.1.0
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.9
     hooks:
-      - id: black
-
-  - repo: https://github.com/pycqa/isort
-    rev: 6.0.1
-    hooks:
-      - id: isort
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format

README.md

@@ -3,7 +3,6 @@
 ![Test Status](https://github.com/bleykauf/aisim/actions/workflows/workflow.yml/badge.svg)
 ![Test Coverage](https://raw.githubusercontent.com/bleykauf/aisim/master/docs/coverage.svg)
 [![Documentation Status](https://readthedocs.org/projects/aisim/badge/?version=latest)](https://aisim.readthedocs.io/en/latest/?badge=latest)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
 AISim ‒ Simulations for light-pulse atom interferometry
 =======================================================

aisim/prop.py

@@ -266,9 +266,9 @@ def _index_shift(self):
         return index_shift_matrix
 
     def _prop_matrix(self, atoms):
-        assert (
-            atoms.state_kets.shape[1] == 2 * self.n_pulses
-        ), "Number of states must be twice the number of pulses."
+        assert atoms.state_kets.shape[1] == 2 * self.n_pulses, (
+            "Number of states must be twice the number of pulses."
+        )
 
         u_two_level = super()._prop_matrix(atoms)
         u = self._block_diag(u_two_level, self.n_pulses)

docs/CONTRIBUTING.rst

@@ -7,7 +7,7 @@ We welcome everybody to help by reporting bugs or making suggestions via our
 
 Code style
 ----------
-We use the `black <https://black.readthedocs.io/en/stable/index.html>`__code style.
+We use the `ruff <https://github.com/astral-sh/ruff>`__code formatter and linter.
 
 Testing
 -------

docs/examples/basic-usage.ipynb

@@ -13,8 +13,6 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "%matplotlib inline\n",
-    "\n",
     "import numpy as np\n",
     "\n",
     "import aisim as ais"
@@ -173,7 +171,7 @@
     {
      "data": {
       "text/plain": [
-       "[0.465166693003362, 0.0, 0.0, 0.0, 0.0, 0.534833306996638]"
+       "[0.4726310895777855, 0.0, 0.0, 0.0, 0.0, 0.5273689104222146]"
       ]
      },
      "execution_count": 6,
@@ -210,12 +208,12 @@
     {
      "data": {
       "text/plain": [
-       "[0.10469171680133398,\n",
+       "[0.11123080212838952,\n",
        " 0.0,\n",
-       " 0.39920486834428104,\n",
-       " 0.36047497620202806,\n",
+       " 0.38155435087015555,\n",
+       " 0.36140028744939595,\n",
        " 0.0,\n",
-       " 0.13562843865235696]"
+       " 0.14581455955205894]"
       ]
      },
      "execution_count": 8,
@@ -259,7 +257,7 @@
     {
      "data": {
       "text/plain": [
-       "[0.013478798496272988, 0.746201046050036]"
+       "[0.012668168137841305, 0.7302864701817102]"
       ]
      },
      "execution_count": 10,

docs/examples/multiport-ai.ipynb

@@ -298,7 +298,7 @@
     {
      "data": {
       "text/plain": [
-       "<matplotlib.legend.Legend at 0x14bca3a10>"
+       "<matplotlib.legend.Legend at 0x107865550>"
       ]
      },
      "execution_count": 11,

docs/examples/rabi-oscillations.ipynb

@@ -26,26 +26,20 @@ dynamic = ["version"]
 
 [project.optional-dependencies]
 dev = [
-    "black>=24.10.0",
-    "flake8>=7.1.1",
-    "flake8-pyproject>=1.2.3",
-    "isort>=5.13.2",
+    "ruff>=0.9.9",
     "pre-commit>=4.1.0",
     "pytest>=8.3.4",
     "setuptools_scm>=8.1.0",
 ]
-docs = ["sphinx", "nbsphinx", "pygments>=2.4", "sphinx_rtd_theme"]
+docs = [
+    "sphinx>=8.2.1",
+    "nbsphinx>=0.9.6",
+    "pygments>=2.4",
+    "sphinx_rtd_theme>=3.0.2",
+]
 
 [tool.setuptools_scm]
 
 [project.urls]
 homepage = "https://github.com/bleykauf/aisim/"
 repository = "https://github.com/bleykauf/aisim/"
-
-[tool.flake8]
-max-line-length = 88
-extend-ignore = "E203"
-docstring-convention = "numpy"
-
-[tool.isort]
-profile = "black"