Fix formatting and such in notebooks following ruff

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
pyxem · Jan 1, 2025 · b0c5536 · b0c5536
1 parent 33d9229
commit b0c5536
Show file tree

Hide file tree

Showing 10 changed files with 265 additions and 224 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -16,6 +16,13 @@
 ## You should have received a copy of the GNU General Public License
 ## along with kikuchipy.  If not, see <http://www.gnu.org/licenses/>.##
 repos:
+  # # https://docs.astral.sh/ruff/configuration
+  # - repo: https://github.com/astral-sh/ruff-pre-commit
+  #   rev: v0.6.8
+  #   hooks:
+  #     - id: ruff
+  #       args: [ --fix ]
+  #     - id: ruff-format
   # https://black.readthedocs.io/en/stable/index.html
   - repo: https://github.com/psf/black-pre-commit-mirror
     rev: 24.10.0

diff --git a/doc/tutorials/esteem2022_diffraction_workshop.ipynb b/doc/tutorials/esteem2022_diffraction_workshop.ipynb
diff --git a/doc/tutorials/geometrical_ebsd_simulations.ipynb b/doc/tutorials/geometrical_ebsd_simulations.ipynb
@@ -42,7 +42,6 @@
     "import hyperspy.api as hs\n",
     "import kikuchipy as kp\n",
     "from orix.crystal_map import Phase\n",
-    "from orix.quaternion import Rotation\n",
     "\n",
     "\n",
     "# Plotting parameters\n",
@@ -479,7 +478,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.12.6"
+   "version": "3.12.7"
   }
  },
  "nbformat": 4,

diff --git a/doc/tutorials/hough_indexing.ipynb b/doc/tutorials/hough_indexing.ipynb
@@ -45,12 +45,11 @@
     "%matplotlib inline\n",
     "\n",
     "import matplotlib.pyplot as plt\n",
-    "import numpy as np\n",
     "\n",
     "from diffpy.structure import Atom, Lattice, Structure\n",
     "from diffsims.crystallography import ReciprocalLatticeVector\n",
     "import kikuchipy as kp\n",
-    "from orix import io, plot\n",
+    "from orix import plot\n",
     "from orix.crystal_map import Phase, PhaseList\n",
     "from orix.vector import Vector3d\n",
     "\n",
@@ -526,6 +525,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "# from orix import io\n",
     "# io.save(\"xmap_ni.h5\", xmap)\n",
     "# io.save(\n",
     "#    \"xmap_ni.ang\",\n",
@@ -584,7 +584,7 @@
     "fig, axes = plt.subplots(ncols=2, nrows=2, figsize=(10, 5), layout=\"tight\")\n",
     "for ax, to_plot in zip(axes.ravel(), [\"pq\", \"cm\", \"fit\", \"nmatch\"]):\n",
     "    ax.hist(xmap.prop[to_plot], bins=100)\n",
-    "    ax.set(xlabel=to_plot, ylabel=\"Frequency\");"
+    "    _ = ax.set(xlabel=to_plot, ylabel=\"Frequency\")"
    ]
   },
   {
@@ -806,7 +806,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.12.6"
+   "version": "3.12.7"
   }
  },
  "nbformat": 4,

diff --git a/doc/tutorials/hybrid_indexing.ipynb b/doc/tutorials/hybrid_indexing.ipynb
diff --git a/doc/tutorials/mandm2021_sunday_short_course.ipynb b/doc/tutorials/mandm2021_sunday_short_course.ipynb
diff --git a/doc/tutorials/pattern_matching.ipynb b/doc/tutorials/pattern_matching.ipynb
diff --git a/doc/tutorials/reference_frames.ipynb b/doc/tutorials/reference_frames.ipynb
@@ -531,7 +531,7 @@
    "outputs": [],
    "source": [
     "R = Rotation.random(10)\n",
-    "O = Orientation(R, mp.phase.point_group)"
+    "Or = Orientation(R, mp.phase.point_group)"
    ]
   },
   {
@@ -547,7 +547,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "s2 = mp.get_patterns(O, det2, energy=20, compute=True)"
+    "s2 = mp.get_patterns(Or, det2, energy=20, compute=True)"
    ]
   },
   {
@@ -586,7 +586,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from pyebsdindex import ebsd_index, pcopt"
+    "from pyebsdindex import ebsd_index"
    ]
   },
   {
@@ -662,19 +662,19 @@
     "    )\n",
     "    data, *_ = indexer.index_pats(s2.data)\n",
     "    R_hi = Rotation(data[0][\"quat\"]) * R_sample[vendor]\n",
-    "    O_hi = Orientation(R_hi, mp.phase.point_group)\n",
+    "    Or_hi = Orientation(R_hi, mp.phase.point_group)\n",
     "\n",
     "    print(\n",
-    "        f\"Average misorientation angle to ground truth: {O_hi.angle_with(O, degrees=True).mean():.4f}\"\n",
+    "        f\"Average misorientation angle to ground truth: {Or_hi.angle_with(Or, degrees=True).mean():.4f}\"\n",
     "    )\n",
-    "    fig = O.scatter(\n",
+    "    fig = Or.scatter(\n",
     "        \"ipf\",\n",
     "        direction=v_sample,\n",
     "        c=\"C0\",\n",
     "        s=200,\n",
     "        return_figure=True,\n",
     "    )\n",
-    "    O_hi.scatter(\"ipf\", figure=fig, c=\"C1\", s=100)\n",
+    "    Or_hi.scatter(\"ipf\", figure=fig, c=\"C1\", s=100)\n",
     "    plt.pause(0.5)  # Show IPFs before continuing with next vendor"
    ]
   },
@@ -703,7 +703,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.12.6"
+   "version": "3.12.7"
   }
  },
  "nbformat": 4,

diff --git a/doc/tutorials/visualizing_patterns.ipynb b/doc/tutorials/visualizing_patterns.ipynb
@@ -33,14 +33,10 @@
     "%matplotlib inline\n",
     "\n",
     "import matplotlib.pyplot as plt\n",
-    "import numpy as np\n",
     "import pyvista as pv\n",
-    "import skimage.exposure as ske\n",
-    "import skimage.transform as skt\n",
     "\n",
     "import hyperspy.api as hs\n",
     "import kikuchipy as kp\n",
-    "from orix import io, plot, quaternion, vector\n",
     "\n",
     "\n",
     "# See https://docs.pyvista.org/user-guide/jupyter/index.html\n",
@@ -337,7 +333,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.12.6"
+   "version": "3.12.7"
   },
   "widgets": {
    "application/vnd.jupyter.widget-state+json": {

diff --git a/pyproject.toml b/pyproject.toml
@@ -169,3 +169,15 @@ filterwarnings = [
 profile = "black"
 filter_files = true
 force_sort_within_sections = true
+
+[tool.ruff.lint]
+select = [
+    # Pyflakes
+    "F",
+    # Pycodestyle
+    "E",
+    "W",
+    # isort
+    "I"
+]
+extend-ignore = ["E501"]