wavy.wconfig
============

.. py:module:: wavy.wconfig


Attributes
----------

.. autoapisummary::

   wavy.wconfig.logger


Functions
---------

.. autoapisummary::

   wavy.wconfig.__get_confdir__
   wavy.wconfig.load_or_default
   wavy.wconfig.load_minimal
   wavy.wconfig.load_dir


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

.. py:data:: logger

.. py:function:: __get_confdir__()

   Configuration directory is specified through:

   .env
   WAVY_CONFIG environment variable
   XDG configuration directory (wavy)


.. py:function:: load_or_default(name)

   Load the YAML configuration file from the current directory or use default. The approach is threefold and shown in order:

   1. check if env 'WAVY_CONFIG' is set or specified in .env
   2. check if a config folder exists using xdg
   3. fall back on default files within the package

   e.g.:

   .. code::

       c = load_or_default('model_cfg.yaml')



.. py:function:: load_minimal(name)

.. py:function:: load_dir(name)