one.params

Funtions for modifying, loading and saving ONE and Alyx database parameters Scenarios:

  • Load ONE with a cache dir: tries to load the Web client params from the dir

  • Load ONE with http address - gets cache dir from the URL map

The ONE params comprise two files: a caches file that contains a map of Alyx db URLs to cache directories, and a separate parameter file for each url containing the client parameters. The caches file also sets the default client for when no url is provided.

TODO Rename ‘client’ kwarg

Functions

default

Default WebClient parameters

get

Returns the AlyxClient parameters

get_cache_dir

get_default_client

Returns the default AlyxClient URL, or None if no default is set.

get_params_dir

get_rest_dir

Return path to REST cache directory

save

setup

default()[source]

Default WebClient parameters

setup(client=None, silent=False, make_default=None)[source]
get(client=None, silent=False)[source]

Returns the AlyxClient parameters

Parameters
  • silent (bool) – If true, defaults are chosen if no parameters found

  • client (str) – The database URL to retrieve parameters for. If None, the default is loaded

Returns

Return type

A Params object for the AlyxClient

get_default_client()[source]

Returns the default AlyxClient URL, or None if no default is set.

save(par, client)[source]
get_cache_dir() → pathlib.Path[source]
get_params_dir() → pathlib.Path[source]
get_rest_dir(client=None) → pathlib.Path[source]

Return path to REST cache directory

Parameters

client (str) – Location of rest cache for a given database URL. If None, the root REST cache directory is returned

Returns

Return type

The REST cache directory path