Skip to content

Commit 070af11

Browse files
authored
Add xarray-lmfit extension for curve fitting to ecosystem documentation (#10262)
1 parent 0759405 commit 070af11

File tree

4 files changed

+10
-2
lines changed

4 files changed

+10
-2
lines changed

doc/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -338,6 +338,7 @@
338338
"sparse": ("https://sparse.pydata.org/en/latest/", None),
339339
"xarray-tutorial": ("https://tutorial.xarray.dev/", None),
340340
"zarr": ("https://zarr.readthedocs.io/en/stable/", None),
341+
"xarray-lmfit": ("https://xarray-lmfit.readthedocs.io/stable", None),
341342
}
342343

343344
# based on numpy doc/source/conf.py

doc/user-guide/ecosystem.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@ Extend xarray capabilities
8989
- `X-regression <https://github.com/kuchaale/X-regression>`_: Multiple linear regression from Statsmodels library coupled with Xarray library.
9090
- `xskillscore <https://github.com/xarray-contrib/xskillscore>`_: Metrics for verifying forecasts.
9191
- `xyzpy <https://xyzpy.readthedocs.io>`_: Easily generate high dimensional data, including parallelization.
92+
- `xarray-lmfit <https://github.com/kmnhan/xarray-lmfit>`_: xarray extension for curve fitting using `lmfit <https://lmfit.github.io/lmfit-py/>`_.
9293

9394
Visualization
9495
~~~~~~~~~~~~~

xarray/core/dataarray.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6410,7 +6410,7 @@ def curvefit(
64106410
"""
64116411
Curve fitting optimization for arbitrary functions.
64126412
6413-
Wraps `scipy.optimize.curve_fit` with `apply_ufunc`.
6413+
Wraps :py:func:`scipy.optimize.curve_fit` with :py:func:`~xarray.apply_ufunc`.
64146414
64156415
Parameters
64166416
----------
@@ -6550,6 +6550,9 @@ def curvefit(
65506550
--------
65516551
DataArray.polyfit
65526552
scipy.optimize.curve_fit
6553+
xarray.DataArray.xlm.modelfit
6554+
External method from `xarray-lmfit <https://xarray-lmfit.readthedocs.io/>`_
6555+
with more curve fitting functionality.
65536556
"""
65546557
# For DataArray, use the original implementation by converting to a dataset first
65556558
return self._to_temp_dataset().curvefit(

xarray/core/dataset.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9566,7 +9566,7 @@ def curvefit(
95669566
"""
95679567
Curve fitting optimization for arbitrary functions.
95689568
9569-
Wraps `scipy.optimize.curve_fit` with `apply_ufunc`.
9569+
Wraps :py:func:`scipy.optimize.curve_fit` with :py:func:`~xarray.apply_ufunc`.
95709570
95719571
Parameters
95729572
----------
@@ -9626,6 +9626,9 @@ def curvefit(
96269626
--------
96279627
Dataset.polyfit
96289628
scipy.optimize.curve_fit
9629+
xarray.Dataset.xlm.modelfit
9630+
External method from `xarray-lmfit <https://xarray-lmfit.readthedocs.io/>`_
9631+
with more curve fitting functionality.
96299632
"""
96309633
from xarray.computation.fit import curvefit as curvefit_impl
96319634

0 commit comments

Comments
 (0)