Manage separate databases and caches for different user projects.
Squirrel based applications can either use the user’s global database which
lives in Pyrocko’s global cache directory (by default under
'$HOME/.pyrocko/cache/squirrel') or a project specific local database which
can be conveniently created in the top level directory of a user’s project
'squirrel'. The choice of database and associated
cache directory locations is referred to here as the Squirrel environment. This
module provides functions to create local environments and to look for a usable
environment in the hierarchy of a user’s project directory.
Get default Squirrel environment relevant for a given file system path.
path – Directory path to use as starting point for detection of the Squirrel environment. By default, the current working directory is used as starting point. When searching for a usable environment the directory
'squirrel'in the current (or starting point) directory is used if it exists, otherwise the parent directories are search upwards for the existence of such a directory. If no such directory is found, the user’s global Squirrel environment, usually
'$HOME/.pyrocko/cache/squirrel', is used.
Environmentobject containing the detected database and cache directory paths.
Initialize empty Squirrel environment.
path – Path to the directory where the new environment’s
'.squirrel'directory should be created. If set to
None, the current working directory is used.
'.squirrel'directory already exists at the given location,