Passover

.gitignore

@@ -264,3 +264,10 @@ package.json
 # repo specific
 examples/using_pfsspy/aia_map.fits
 docs/sg_execution_times.rst
+docs/manual/source/numerical-methods.aux
+docs/manual/source/numerical-methods.bbl
+docs/manual/source/numerical-methods.fdb_latexmk
+docs/manual/source/numerical-methods.fls
+docs/manual/source/numerical-methods.out
+docs/manual/source/numerical-methods.pdf
+docs/manual/source/numerical-methods.synctex.gz

.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 repos:
     # This should be before any formatting hooks like isort
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.2.1"
+    rev: "v0.2.2"
     hooks:
       - id: ruff
         args: ["--fix"]

.ruff.toml

@@ -5,24 +5,18 @@ exclude = [
   "__pycache__",
   "build",
   "sunkit-magex/version.py",
+  "examples/testing/",
 ]
 
 [lint]
 select = ["E", "F", "W", "UP", "PT"]
 extend-ignore = [
   # pycodestyle (E, W)
-  "E501", # LineTooLong                             # TODO! fix
+  "E501", # LineTooLong
   # pytest (PT)
   "PT001", # Always use pytest.fixture()
   "PT004", # Fixtures which don't return anything should have leading _
-  "PT007", # Parametrize should be lists of tuples  # TODO! fix
-  "PT011", # Too broad exception assert             # TODO! fix
   "PT023", # Always use () on pytest decorators
-
-  # pfsspy
-  # TODO: Fix these
-  "E741",
-  "F811",
 ]
 
 [lint.flake8-tidy-imports]

README.rst

@@ -4,11 +4,9 @@ Potential field source surface modelling
 License
 -------
 
-This project is Copyright (c) The SunPy Community and licensed under
-the terms of the GNU GPL v3+ license. This package is based upon
-the `Openastronomy packaging guide <https://github.com/OpenAstronomy/packaging-guide>`_
-which is licensed under the BSD 3-clause licence. See the licenses folder for
-more information.
+This project is Copyright (c) The SunPy Community and licensed under the terms of the GNU GPL v3+ license.
+This package is based upon the `Openastronomy packaging guide <https://github.com/OpenAstronomy/packaging-guide>`_ which is licensed under the BSD 3-clause license.
+See the licenses folder for more information.
 
 Contributing
 ------------

docs/conf.py

@@ -5,13 +5,11 @@
 # http://www.sphinx-doc.org/en/master/config
 
 import os
+from sphinx_gallery.sorting import ExplicitOrder
+from sunkit_magex import __version__
 
 # -- Project information -----------------------------------------------------
-
-# The full version, including alpha/beta/rc tags
-from sunkit_magex import __version__
 release = __version__
-
 project = "sunkit-magex"
 copyright = "2024, The SunPy Community"
 author = "The SunPy Community"
@@ -64,13 +62,9 @@
 }
 
 # -- Options for HTML output -------------------------------------------------
-
 html_theme = "sunpy"
 
 # -- Sphinx Gallery ----------------------------------------------------------
-
-from sphinx_gallery.sorting import ExplicitOrder  # noqa
-
 sphinx_gallery_conf = {
     "ignore_pattern": ".*helpers.py",
     "examples_dirs": "../examples",
@@ -85,7 +79,5 @@
 
 # -- Other options ----------------------------------------------------------
 default_role = 'py:obj'
-
 os.environ["JSOC_EMAIL"] = '[email protected]'
-
 nitpicky = True

docs/index.rst

@@ -1,5 +1,6 @@
+==========================
 sunkit-magex Documentation
---------------------------
+==========================
 
 This is the documentation for sunkit-magex.
 
@@ -9,7 +10,7 @@ This is the documentation for sunkit-magex.
 
    installing
    generated/gallery/index
-   pfsspy
+   reference/index
    performance
    numerical_method
    synoptic_fits

docs/installing.rst

@@ -1,15 +1,17 @@
+==========
 Installing
-----------
-sunkit_magex can be installed from PyPI using
+==========
 
-.. code::
+``sunkit_magex`` can be installed from PyPI using
+
+.. code:: shell
 
     pip install sunkit-magex
 
-This will install sunkit_magex and all of its dependencies. In addition to the core
-dependencies, there are two optional dependencies (numba, streamtracer) that
-improve code performance. These can be installed with
+This will install sunkit_magex and all of its dependencies.
+In addition to the core dependencies, there are two optional dependencies (numba, streamtracer) that can improve code performance.
+These can be installed with
 
-.. code::
+.. code:: shell
 
     pip install sunkit-magex[performance]

docs/manual/source/numerical-methods.blg

@@ -0,0 +1,46 @@
+This is BibTeX, Version 0.99d (TeX Live 2023/Arch Linux)
+Capacity: max_strings=200000, hash_size=200000, hash_prime=170003
+The top-level auxiliary file: numerical-methods.aux
+The style file: abbrvnat.bst
+Database file #1: refs.bib
+You've used 1 entry,
+            2773 wiz_defined-function locations,
+            600 strings with 4742 characters,
+and the built_in function-call counts, 540 in all, are:
+= -- 46
+> -- 30
+< -- 0
++ -- 10
+- -- 9
+* -- 50
+:= -- 89
+add.period$ -- 4
+call.type$ -- 1
+change.case$ -- 6
+chr.to.int$ -- 1
+cite$ -- 2
+duplicate$ -- 21
+empty$ -- 41
+format.name$ -- 10
+if$ -- 107
+int.to.chr$ -- 1
+int.to.str$ -- 1
+missing$ -- 1
+newline$ -- 14
+num.names$ -- 4
+pop$ -- 9
+preamble$ -- 1
+purify$ -- 5
+quote$ -- 0
+skip$ -- 15
+stack$ -- 0
+substring$ -- 23
+swap$ -- 2
+text.length$ -- 0
+text.prefix$ -- 0
+top$ -- 0
+type$ -- 11
+warning$ -- 0
+while$ -- 4
+width$ -- 0
+write$ -- 22