diff --git a/README.rst b/README.rst index 7ef9d47..9a46fcd 100644 --- a/README.rst +++ b/README.rst @@ -8,10 +8,13 @@ iterative Hertz model for a spherical indenter (modified by Sneddon) for the `nanite `_ AFM force-indentation analysis package. +This model is an optional component of nanite and is only of academic +interest. + Installation ------------ -To install the latest release, simply run: +To install the latest release: :: diff --git a/src/nanite_model_sneddon_spher/model_sneddon_spherical.pyx b/src/nanite_model_sneddon_spher/model_sneddon_spherical.pyx index 6a8a4ec..e15bbb8 100644 --- a/src/nanite_model_sneddon_spher/model_sneddon_spherical.pyx +++ b/src/nanite_model_sneddon_spher/model_sneddon_spherical.pyx @@ -22,6 +22,8 @@ def hertz_spherical(delta, double E, double R, double nu, double contact_point=0, double baseline=0): r"""Hertz model for Spherical indenter - modified by Sneddon + This model is only available after installing the + `nanite_model_sneddon_spher` Python package. .. math::