marge3d.utils
=============

.. py:module:: marge3d.utils


Functions
---------

.. autoapisummary::

   marge3d.utils.numerical_order


Module Contents
---------------

.. py:function:: numerical_order(n_steps, err)

   Compute numerical order from two vectors containing the error and the number of time-steps.

   :Parameters: * **n_steps** (*np.1darray or list*) -- Different number of steps to compute the error.
                * **err** (*np.1darray*) -- Different error values associated to the number of steps.

   :returns: * **beta** (*float*) -- Order coefficient computed through linear regression.
             * **rmse** (*float*) -- The root mean square error of the linear regression.