mapflpy 1.1.8__tar.gz → 1.2.0__tar.gz

{mapflpy-1.1.8 → mapflpy-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mapflpy
-Version: 1.1.8
+Version: 1.2.0
 Summary: Fast field line tracing for spherical vector fields
 Keywords: solar physics,space physics,heliophysics,magnetohydrodynamic,science,mas,predsci,psi,modeling,fortran
 Author: Ryder Davidson, Cooper Downs, Andres Reyes, Asher Pembroke
@@ -51,6 +51,7 @@ Requires-Dist: sphinx==8.2.3; extra == "docs"
 Requires-Dist: sphinx-book-theme==1.1.4; extra == "docs"
 Requires-Dist: sphinx-gallery==0.19.0; extra == "docs"
 Requires-Dist: sphinx-copybutton==0.5.2; extra == "docs"
+Requires-Dist: numpydoc==1.9.0; extra == "docs"
 Requires-Dist: pooch==1.8.2; extra == "docs"
 Requires-Dist: matplotlib==3.10.7; extra == "docs"
 Requires-Dist: scipy; extra == "docs"

{mapflpy-1.1.8 → mapflpy-1.2.0}/docs/source/conf.py

@@ -111,7 +111,7 @@ sort_members = True
 exclusions = ['\\._abc_impl',
               'mapflpy.fortran',
               '_load_array_to_shared_memory',
-              'scripts._.*',
+              'scripts._inter_domain_tracing_from*',
               '_version',
               ]
 
@@ -129,43 +129,38 @@ autosummary_context = dict(pkgtree=node_tree_to_dict(node_tree))
 # ------------------------------------------------------------------------------
 extensions.append("sphinx.ext.autodoc")
 
-autodoc_typehints = "description"
+autodoc_typehints = "none"
 autodoc_member_order = 'bysource'
 autodoc_default_options = {
     "show-inheritance": True,
 }
-autodoc_type_aliases = {
-    "NumberType": "NumberType",
-    "PathType": "PathType",
-    "ArrayType": "ArrayType",
-    "MagneticFieldArrayType": "MagneticFieldArrayType",
-    "DirectionType": "DirectionType",
-    "MagneticFieldLabelType": "MagneticFieldLabelType",
-    "ContextType": "ContextType",
-}
 
 # ------------------------------------------------------------------------------
-# Napoleon Configuration
-# ------------------------------------------------------------------------------
-extensions.append('sphinx.ext.napoleon')
-
-napoleon_use_ivar = True
-napoleon_preprocess_types = True
-napoleon_type_aliases = {
-    "NumberType": "~mapflpy.globals.NumberType",
-    "PathType": "~mapflpy.globals.PathType",
-    "ArrayType": "~mapflpy.globals.ArrayType",
-    "MagneticFieldArrayType": "~mapflpy.globals.MagneticFieldArrayType",
-    "DirectionType": "~mapflpy.globals.DirectionType",
-    "MagneticFieldLabelType": "~mapflpy.globals.MagneticFieldLabelType",
-    "ContextType": "~mapflpy.globals.ContextType",
-    "Traces": "~mapflpy.globals.Traces",
-    "Polarity": "~mapflpy.globals.Polarity",
-    "MagneticFieldFiles": "~mapflpy.data.MagneticFieldFiles",
-    "ndarray": "~numpy.ndarray",
-    "ChainMap": "~collections.ChainMap",
-    "Callable": "~collections.abc.Callable",
-    "MutableMapping": "~collections.abc.MutableMapping",
+# Numpydoc Configuration
+# ------------------------------------------------------------------------------
+extensions.append("numpydoc")
+
+numpydoc_xref_param_type = True
+numpydoc_show_class_members = False
+numpydoc_show_inherited_class_members = False
+numpydoc_xref_ignore = {"optional", "default", "of", "or"}
+numpydoc_xref_aliases = {
+    "NumberType": "mapflpy.globals.NumberType",
+    "PathType": "mapflpy.globals.PathType",
+    "ArrayType": "mapflpy.globals.ArrayType",
+    "MagneticFieldArrayType": "mapflpy.globals.MagneticFieldArrayType",
+    "DirectionType": "mapflpy.globals.DirectionType",
+    "MagneticFieldLabelType": "mapflpy.globals.MagneticFieldLabelType",
+    "ContextType": "mapflpy.globals.ContextType",
+    "Traces": "mapflpy.globals.Traces",
+    "Polarity": "mapflpy.globals.Polarity",
+    "MagneticFieldFiles": "mapflpy.data.MagneticFieldFiles",
+    "ndarray": "numpy.ndarray",
+    "ChainMap": "collections.ChainMap",
+    "Callable": "collections.abc.Callable",
+    "MutableMapping": "collections.abc.MutableMapping",
+    "ArrayLike": "numpy.typing.ArrayLike",
+    "Sequence": "collections.abc.Sequence",
 }
 
 # ------------------------------------------------------------------------------

{mapflpy-1.1.8 → mapflpy-1.2.0}/environment.yml

@@ -30,12 +30,14 @@ dependencies:
   - ruff
   - coverage
   - nox
+  - pre-commit
 
   # -------- Docs --------
   - sphinx
   - sphinx-book-theme
   - sphinx-gallery
   - sphinx-copybutton
+  - numpydoc
   - matplotlib
   - pooch
   - scipy

{mapflpy-1.1.8 → mapflpy-1.2.0}/mapflpy/globals.py

@@ -30,7 +30,7 @@ __all__ = [
 # It contains the geometry of the traces, their start and end positions,
 # and whether they were traced to a boundary.
 #------------------------------------------------------------------------------
-Traces = namedtuple('Traces', ['geometry', 'start_pos', 'end_pos', 'traced_to_boundary'])
+Traces = namedtuple('Traces', ['geometry', 'start_pos', 'end_pos', 'traced_to_boundary', 'integral'])
 Traces.__doc__ = (
     """Named tuple for storing magnetic fieldline trace information.
     
@@ -45,9 +45,39 @@ Traces.__doc__ = (
         Array of shape (N, 3) containing the ending positions of each fieldline.
     traced_to_boundary : ndarray
         Boolean array of shape (N,) indicating whether each fieldline was traced to a boundary.
+    integral : ndarray
+        Array of shape (N,) containing the field aligned integral. By default the integral
+        is just the field line length, but certain mapflpy options can change this behavior, 
+        currently `integrate_along_fl_`, `scalar_input_file_`, `weight_integral_by_area_`, and 
+        max_along_fl_`.
     """
 )
 
+# ------------------------------------------------------------------------------
+# Named tuple for storing mapping information produced by some of the mapping
+# scripts in `mapflpy.scripts`
+# ------------------------------------------------------------------------------
+Mapping = namedtuple('Mapping', ['r', 't', 'p', 'traced_to_boundary', 'integral'])
+Mapping.__doc__ = (
+    """Named tuple for storing magnetic fieldline mapping information.
+
+    Attributes
+    ----------
+    r : ndarray
+        Array containing the radial positions of the mapping endpoints [R_sun]).
+    t : ndarray
+        Array containing the theta (co-latitude) positions of the mapping endpoints [radians].
+    p : ndarray
+        Array containing the phi (longitude) positions of the mapping endpoints [radians].
+    traced_to_boundary : ndarray
+        Boolean array indicating whether each fieldline was traced to a boundary.
+    integral : ndarray
+        Array containing the values of the field line integral. By default the integral
+        is just the field line length, but certain mapflpy options can change this behavior, 
+        currently `integrate_along_fl_`, `scalar_input_file_`, `weight_integral_by_area_`, and 
+        `max_along_fl_`.
+    """
+)
 
 # ------------------------------------------------------------------------------
 # Type aliases for improved code readability.
@@ -182,6 +212,8 @@ DEFAULT_FIELDS = MappingProxyType({
 DEFAULT_PARAMS = MappingProxyType({
     'integrate_along_fl_': False,
     'scalar_input_file_': '',
+    'weight_integral_by_area_': False,
+    'max_along_fl_': False,
     'verbose_': False,
     'cubic_': False,
     'trace_fwd_': False,