Skip to content

Modernize type hints to 3.10 style #153

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ttricco merged 11 commits into from
Aug 12, 2026
Merged

Modernize type hints to 3.10 style #153

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
1ad07f3
migrate to 3.10+ type hints
ttricco Jul 12, 2026
9b7724b
lint
ttricco Aug 11, 2026
4fe15c8
Merge branch 'main' into modernize_type_hints
ttricco Aug 11, 2026
97fc583
lint
ttricco Aug 11, 2026
44409d1
consistency between type hints and docstrings
ttricco Aug 12, 2026
e8054d9
adhere to numpy docstring format guide
ttricco Aug 12, 2026
eeb2aab
update reqs to numpy and pandas 2.0
ttricco Aug 12, 2026
6bb9480
type hint cleaning
ttricco Aug 12, 2026
30aa826
type hint lint
ttricco Aug 12, 2026
c56d74a
flake8 lint
ttricco Aug 12, 2026
a42fb8a
fix typo
ttricco Aug 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,12 @@ description = "SPH analysis and visualization"
authors = [{name = "Terrence S. Tricco", email = "tstricco@mun.ca"}]
readme = "README.md"
dynamic = ["version"]
requires-python = ">=3.8"
requires-python = ">=3.10"
dependencies = [
"matplotlib>=3.6",
"numba>=0.55.1",
"pandas>=1.4",
"pandas>=2.0",
"numpy>=2.0",
"scipy>=1.8.0",
"seaborn>=0.11",
]
Expand Down
4 changes: 2 additions & 2 deletions sarracen/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
try:
from .readers.read_shamrock_vtk import read_shamrock_vtk
except ModuleNotFoundError as e:
# temporary workaround for no VTK in Python 3.8 on Mac ARM
if e.name == "vtk":
def read_shamrock_vtk(*args, **kwargs):
def read_shamrock_vtk(filename: str,
pmass: float) -> 'SarracenDataFrame':
raise ImportError("vtk is not installed.")
else:
raise
Expand Down
136 changes: 66 additions & 70 deletions sarracen/disc/surface_density.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,25 @@
from ..sarracen_dataframe import SarracenDataFrame
from .utils import _get_mass, _get_origin
from .utils import _bin_particles_by_radius, _get_bin_midpoints
from typing import TypeAlias

from typing import Tuple, Union

ProfileResult: TypeAlias = np.ndarray | tuple[np.ndarray, np.ndarray]
SDResult: TypeAlias = (ProfileResult |
tuple[np.ndarray, np.ndarray, np.ndarray] |
tuple[np.ndarray, np.ndarray, np.ndarray, np.ndarray])
AngularMomentumResult: TypeAlias = tuple[np.ndarray, ...]


def azimuthal_average(data: 'SarracenDataFrame',
target: str,
r_in: Union[float, None] = None,
r_out: Union[float, None] = None,
r_in: float | None = None,
r_out: float | None = None,
bins: int = 300,
log: bool = False,
geometry: str = 'cylindrical',
origin: Union[list, None] = None,
retbins: bool = False) -> Union[np.ndarray,
Tuple[np.ndarray,
np.ndarray]]:
origin: list[float] | None = None,
retbins: bool = False) -> ProfileResult:
"""
Calculates the 1D azimuthally-averaged profile for a target quantity.

Expand All @@ -44,18 +48,18 @@ def azimuthal_average(data: 'SarracenDataFrame',
geometry : str, optional
Coordinate system to use to calculate the particle radii. Can be
either *spherical* or *cylindrical*. Defaults to *cylindrical*.
origin : array-like, optional
origin : array_like, optional
The x, y and z centre point around which to compute radii. Defaults to
[0, 0, 0].
retbins : bool, optional
Whether to return the midpoints of the bins or not. Defaults to False.

Returns
-------
array
ndarray
A NumPy array of length bins containing the averaged profile.
array, optional
The midpoint values of each bin. Only returned if *retbins=True*.
ndarray, optional
The midpoint values of each bin. Only returned if `retbins=True`.

Raises
------
Expand All @@ -76,22 +80,13 @@ def azimuthal_average(data: 'SarracenDataFrame',


def surface_density(data: 'SarracenDataFrame',
r_in: Union[float, None] = None,
r_out: Union[float, None] = None,
r_in: float | None = None,
r_out: float | None = None,
bins: int = 300,
log: bool = False,
geometry: str = 'cylindrical',
origin: Union[list, None] = None,
retbins: bool = False) -> Union[np.ndarray,
Tuple[np.ndarray,
np.ndarray],
Tuple[np.ndarray,
np.ndarray,
np.ndarray],
Tuple[np.ndarray,
np.ndarray,
np.ndarray,
np.ndarray]]:
origin: list[float] | None = None,
retbins: bool = False) -> SDResult:
"""
Calculates the 1D azimuthally-averaged surface density profile.

Expand All @@ -115,17 +110,22 @@ def surface_density(data: 'SarracenDataFrame',
geometry : str, optional
Coordinate system to use to calculate the particle radii. Can be
either *spherical* or *cylindrical*. Defaults to *cylindrical*.
origin : array-like, optional
origin : array_like, optional
The x, y and z centre point around which to compute radii. Defaults to
[0, 0, 0].
retbins : bool, optional
Whether to return the midpoints of the bins or not. Defaults to False.

Returns
-------
array
ndarray or tuple of ndarray
A NumPy array of length bins containing the surface density profile.
array, optional
For gas-only data, this is the gas surface density profile. For
one-fluid data, the gas and dust surface desity profiles are returned.
For multiple small dust grains, the gas surface density profile is
returned, along with the total dust profile and per-grain dust
profiles.
ndarray, optional
The midpoint values of each bin. Only returned if *retbins=True*.

Raises
Expand Down Expand Up @@ -194,7 +194,7 @@ def surface_density(data: 'SarracenDataFrame',
else:
return sigma_gas, sigma_dust

elif ndustsmall > 1: # multiple grain sizes
else: # multiple grain sizes
if 'dustfrac_total' not in data.columns:
data.calc_one_fluid_quantities()

Expand All @@ -221,28 +221,27 @@ def surface_density(data: 'SarracenDataFrame',

def _calc_angular_momentum(data: 'SarracenDataFrame',
rbins: pd.Series,
origin: list,
unit_vector: bool) -> Tuple[pd.Series,
pd.Series,
origin: list[float],
unit_vector: bool) -> tuple[pd.Series, pd.Series,
pd.Series]:
"""
Utility function to calculate angular momentum of the disc.

Parameters
----------
data: SarracenDataFrame
data : SarracenDataFrame
Particle data, in a SarracenDataFrame.
rbins: Series
rbins : Series
The radial bin to which each particle belongs.
origin: list
origin : list of float
The x, y and z centre point around which to compute radii.
unit_vector: bool
unit_vector : bool
Whether to convert the angular momentum to unit vectors.
Default is True.

Returns
-------
Lx, Ly, Lz: Series
Lx, Ly, Lz : Series
The x, y and z components of the angular momentum per bin.
"""

Expand Down Expand Up @@ -276,15 +275,14 @@ def _calc_angular_momentum(data: 'SarracenDataFrame',


def angular_momentum(data: 'SarracenDataFrame',
r_in: Union[float, None] = None,
r_out: Union[float, None] = None,
r_in: float | None = None,
r_out: float | None = None,
bins: int = 300,
log: bool = False,
geometry: str = 'cylindrical',
origin: Union[list, None] = None,
origin: list[float] | None = None,
retbins: bool = False,
unit_vector: bool = True) -> Union[Tuple[np.ndarray,
...]]:
unit_vector: bool = True) -> AngularMomentumResult:
"""
Calculates the angular momentum profile of the disc.

Expand All @@ -308,21 +306,22 @@ def angular_momentum(data: 'SarracenDataFrame',
geometry : str, optional
Coordinate system to use to calculate the particle radii. Can be
either *spherical* or *cylindrical*. Defaults to *cylindrical*.
origin : array-like, optional
origin : array_like, optional
The x, y and z centre point around which to compute radii. Defaults to
[0, 0, 0].
retbins : bool, optional
Whether to return the midpoints of the bins or not. Defaults to False.
unit_vector: bool, optional
unit_vector : bool, optional
Whether to convert the angular momentum to unit vectors.
Default is True.

Returns
-------
array
A NumPy array of length bins containing the angular momentum profile.
array, optional
The midpoint values of each bin. Only returned if *retbins=True*.
tuple of ndarray
Three NumPy arrays of length bins containing the Lx, Ly and Lz angular
momentum profiles.
ndarray, optional
The midpoint values of each bin. Only returned if `retbins=True`.

Raises
------
Expand Down Expand Up @@ -350,17 +349,17 @@ def angular_momentum(data: 'SarracenDataFrame',

def _calc_scale_height(data: 'SarracenDataFrame',
rbins: pd.Series,
origin: list) -> pd.Series:
origin: list[float]) -> pd.Series:
"""
Utility function to calculate the scale height of the disc.

Parameters
----------
data: SarracenDataFrame
data : SarracenDataFrame
Particle data, in a SarracenDataFrame.
rbins: Series
rbins : Series
The radial bin to which each particle belongs.
origin : array-like, optional
origin : array_like, optional
The x, y and z centre point around which to compute radii. Defaults to
[0, 0, 0].

Expand All @@ -380,15 +379,13 @@ def _calc_scale_height(data: 'SarracenDataFrame',


def scale_height(data: 'SarracenDataFrame',
r_in: Union[float, None] = None,
r_out: Union[float, None] = None,
r_in: float | None = None,
r_out: float | None = None,
bins: int = 300,
log: bool = False,
geometry: str = 'cylindrical',
origin: Union[list, None] = None,
retbins: bool = False) -> Union[np.ndarray,
Tuple[np.ndarray,
np.ndarray]]:
origin: list[float] | None = None,
retbins: bool = False) -> ProfileResult:
"""
Calculates the scale height, H/R, of the disc.

Expand All @@ -415,18 +412,18 @@ def scale_height(data: 'SarracenDataFrame',
geometry : str, optional
Coordinate system to use to calculate the particle radii. Can be
either *spherical* or *cylindrical*. Defaults to *cylindrical*.
origin : array-like, optional
origin : array_like, optional
The x, y and z centre point around which to compute radii. Defaults to
[0, 0, 0].
retbins : bool, optional
Whether to return the midpoints of the bins or not. Defaults to False.

Returns
-------
array
ndarray
A NumPy array of length bins scale height, H, profile.
array, optional
The midpoint values of each bin. Only returned if *retbins=True*.
ndarray, optional
The midpoint values of each bin. Only returned if `retbins=True`.

Raises
------
Expand All @@ -452,14 +449,13 @@ def scale_height(data: 'SarracenDataFrame',


def honH(data: 'SarracenDataFrame',
r_in: Union[float, None] = None,
r_out: Union[float, None] = None,
r_in: float | None = None,
r_out: float | None = None,
bins: int = 300,
log: bool = False,
geometry: str = 'cylindrical',
origin: Union[list, None] = None,
retbins: bool = False) -> Union[np.ndarray, Tuple[np.ndarray,
np.ndarray]]:
origin: list[float] | None = None,
retbins: bool = False) -> ProfileResult:
"""
Calculates <h>/H, the averaged smoothing length divided by the scale
height.
Expand All @@ -484,18 +480,18 @@ def honH(data: 'SarracenDataFrame',
geometry : str, optional
Coordinate system to use to calculate the particle radii. Can be
either *spherical* or *cylindrical*. Defaults to *cylindrical*.
origin : array-like, optional
origin : array_like, optional
The x, y and z centre point around which to compute radii. Defaults to
[0, 0, 0].
retbins : bool, optional
Whether to return the midpoints of the bins or not. Defaults to False.

Returns
-------
array
ndarray
A NumPy array of length bins containing the <h>/H profile.
array, optional
The midpoint values of each bin. Only returned if *retbins=True*.
ndarray, optional
The midpoint values of each bin. Only returned if `retbins=True`.

Raises
------
Expand Down
Loading
Loading