Roocs-utils

-------------------

Fixing formatting of doc strings and imports

Breaking Changes
^^^^^^^^^^^^^^^^
* Use of ``roocs_utils.parameter.parameterise.parameterise``:
import should now be ``from roocs_utils.parameter import parameterise``
and usage should be, for example ``parameters = parameterise(collection=ds, time=time, area=area, level=level)``

New Features
^^^^^^^^^^^^

* Added a notebook to show examples

Other Changes
^^^^^^^^^^^^^
* Updated formatting of doc strings

-------------------

Updating the documentation and improving the changelog.

Other Changes
^^^^^^^^^^^^^
* Updated doc strings to improve documentation.
* Updated documentation.

-------------------

Fixing mostly existing functionality to work more efficiently with the other packages in roocs.

Breaking Changes
^^^^^^^^^^^^^^^^
* ``environment.yml`` has been updated to bring it in line with requirements.txt.
* ``level`` coordinates would previously have been identified as ``None``. They are now identified as ``level``.

New Features
^^^^^^^^^^^^
* ``parameterise`` function added in ``roocs_utils.parameter`` to use in all roocs packages.
* ``ROOCS_CONFIG`` environment variable can be used to override default config in ``etc/roocs.ini``.
To use a local config file set ``ROOCS_CONFIG`` as the file path to this file. Several file paths can be provided
separated by a ``:``
* Inventory functionality added - this can be used to create an inventory of datasets. See ``README`` for more info.
* ``project_utils`` added with the following functions to get the project name of a dataset and the base directory for
that project.
* ``utils.common`` and ``utils.time_utils`` added.
* ``is_level`` implemented in ``xarray_utils`` to identify whether a coordinate is a level or not.

Bug Fixes
^^^^^^^^^
* ``xarray_utils.xarray_utils.get_main_variable`` updated to exclude common coordinates from the search for the
main variable. This fixes a bug where coordinates such as ``lon_bounds`` would be returned as the main variable.

Other Changes
^^^^^^^^^^^^^
* ``README`` update to explain inventory functionality.
* ``Black`` and ``flake8`` formatting applied.
* Fixed import warning with ``collections.abc``.

-------------------

* First release.