Skip to content

Latest commit

 

History

History
20 lines (14 loc) · 753 Bytes

configuration.rst

File metadata and controls

20 lines (14 loc) · 753 Bytes

Configuration

In order to configure alkymi, the :ref:`alkymi_config` singleton can be used. To set a value, simply retrieve the singleton instance and set the appropriate configuration field:

# Example of turning off caching
config = AlkymiConfig.get()
config.cache = False

The following settings are currently configurable:

  • cache: Whether to enable alkymi caching globally. Setting this to false will disable caching to disk for all recipes (default True).
  • cache_path: A user-provided location to place the cache (defaults to current working dir).
  • allow_pickling: Whether to allow pickling for serialization, deserialization and checksumming (default True).