repo
stringlengths
7
55
path
stringlengths
4
127
func_name
stringlengths
1
88
original_string
stringlengths
75
19.8k
language
stringclasses
1 value
code
stringlengths
75
19.8k
code_tokens
list
docstring
stringlengths
3
17.3k
docstring_tokens
list
sha
stringlengths
40
40
url
stringlengths
87
242
partition
stringclasses
1 value
brian-rose/climlab
climlab/process/process.py
get_axes
def get_axes(process_or_domain): """Returns a dictionary of all Axis in a domain or dictionary of domains. :param process_or_domain: a process or a domain object :type process_or_domain: :class:`~climlab.process.process.Process` or :class:`~climlab.domain.domain._Domain...
python
def get_axes(process_or_domain): """Returns a dictionary of all Axis in a domain or dictionary of domains. :param process_or_domain: a process or a domain object :type process_or_domain: :class:`~climlab.process.process.Process` or :class:`~climlab.domain.domain._Domain...
[ "def", "get_axes", "(", "process_or_domain", ")", ":", "if", "isinstance", "(", "process_or_domain", ",", "Process", ")", ":", "dom", "=", "process_or_domain", ".", "domains", "else", ":", "dom", "=", "process_or_domain", "if", "isinstance", "(", "dom", ",", ...
Returns a dictionary of all Axis in a domain or dictionary of domains. :param process_or_domain: a process or a domain object :type process_or_domain: :class:`~climlab.process.process.Process` or :class:`~climlab.domain.domain._Domain` :raises: :exc: `TypeE...
[ "Returns", "a", "dictionary", "of", "all", "Axis", "in", "a", "domain", "or", "dictionary", "of", "domains", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/process/process.py#L820-L857
train
brian-rose/climlab
climlab/process/process.py
Process.add_subprocesses
def add_subprocesses(self, procdict): """Adds a dictionary of subproceses to this process. Calls :func:`add_subprocess` for every process given in the input-dictionary. It can also pass a single process, which will be given the name *default*. :param procdict: a dictionary w...
python
def add_subprocesses(self, procdict): """Adds a dictionary of subproceses to this process. Calls :func:`add_subprocess` for every process given in the input-dictionary. It can also pass a single process, which will be given the name *default*. :param procdict: a dictionary w...
[ "def", "add_subprocesses", "(", "self", ",", "procdict", ")", ":", "if", "isinstance", "(", "procdict", ",", "Process", ")", ":", "try", ":", "name", "=", "procdict", ".", "name", "except", ":", "name", "=", "'default'", "self", ".", "add_subprocess", "(...
Adds a dictionary of subproceses to this process. Calls :func:`add_subprocess` for every process given in the input-dictionary. It can also pass a single process, which will be given the name *default*. :param procdict: a dictionary with process names as keys :type procdict:...
[ "Adds", "a", "dictionary", "of", "subproceses", "to", "this", "process", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/process/process.py#L191-L210
train
brian-rose/climlab
climlab/process/process.py
Process.add_subprocess
def add_subprocess(self, name, proc): """Adds a single subprocess to this process. :param string name: name of the subprocess :param proc: a Process object :type proc: :class:`~climlab.process.process.Process` :raises: :exc:`ValueError` ...
python
def add_subprocess(self, name, proc): """Adds a single subprocess to this process. :param string name: name of the subprocess :param proc: a Process object :type proc: :class:`~climlab.process.process.Process` :raises: :exc:`ValueError` ...
[ "def", "add_subprocess", "(", "self", ",", "name", ",", "proc", ")", ":", "if", "isinstance", "(", "proc", ",", "Process", ")", ":", "self", ".", "subprocess", ".", "update", "(", "{", "name", ":", "proc", "}", ")", "self", ".", "has_process_type_list"...
Adds a single subprocess to this process. :param string name: name of the subprocess :param proc: a Process object :type proc: :class:`~climlab.process.process.Process` :raises: :exc:`ValueError` if ``proc`` is not a process ...
[ "Adds", "a", "single", "subprocess", "to", "this", "process", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/process/process.py#L212-L282
train
brian-rose/climlab
climlab/process/process.py
Process.remove_subprocess
def remove_subprocess(self, name, verbose=True): """Removes a single subprocess from this process. :param string name: name of the subprocess :param bool verbose: information whether warning message should be printed [default: True] :Example: ...
python
def remove_subprocess(self, name, verbose=True): """Removes a single subprocess from this process. :param string name: name of the subprocess :param bool verbose: information whether warning message should be printed [default: True] :Example: ...
[ "def", "remove_subprocess", "(", "self", ",", "name", ",", "verbose", "=", "True", ")", ":", "try", ":", "self", ".", "subprocess", ".", "pop", "(", "name", ")", "except", "KeyError", ":", "if", "verbose", ":", "print", "(", "'WARNING: {} not found in subp...
Removes a single subprocess from this process. :param string name: name of the subprocess :param bool verbose: information whether warning message should be printed [default: True] :Example: Remove albedo subprocess from energy balance model:...
[ "Removes", "a", "single", "subprocess", "from", "this", "process", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/process/process.py#L284-L330
train
brian-rose/climlab
climlab/process/process.py
Process.set_state
def set_state(self, name, value): """Sets the variable ``name`` to a new state ``value``. :param string name: name of the state :param value: state variable :type value: :class:`~climlab.domain.field.Field` or *array* :raises: :exc:`ValueError` ...
python
def set_state(self, name, value): """Sets the variable ``name`` to a new state ``value``. :param string name: name of the state :param value: state variable :type value: :class:`~climlab.domain.field.Field` or *array* :raises: :exc:`ValueError` ...
[ "def", "set_state", "(", "self", ",", "name", ",", "value", ")", ":", "if", "isinstance", "(", "value", ",", "Field", ")", ":", "# populate domains dictionary with domains from state variables", "self", ".", "domains", ".", "update", "(", "{", "name", ":", "va...
Sets the variable ``name`` to a new state ``value``. :param string name: name of the state :param value: state variable :type value: :class:`~climlab.domain.field.Field` or *array* :raises: :exc:`ValueError` if state variable ``va...
[ "Sets", "the", "variable", "name", "to", "a", "new", "state", "value", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/process/process.py#L332-L387
train
brian-rose/climlab
climlab/process/process.py
Process._add_field
def _add_field(self, field_type, name, value): """Adds a new field to a specified dictionary. The field is also added as a process attribute. field_type can be 'input', 'diagnostics' """ try: self.__getattribute__(field_type).update({name: value}) except: raise Va...
python
def _add_field(self, field_type, name, value): """Adds a new field to a specified dictionary. The field is also added as a process attribute. field_type can be 'input', 'diagnostics' """ try: self.__getattribute__(field_type).update({name: value}) except: raise Va...
[ "def", "_add_field", "(", "self", ",", "field_type", ",", "name", ",", "value", ")", ":", "try", ":", "self", ".", "__getattribute__", "(", "field_type", ")", ".", "update", "(", "{", "name", ":", "value", "}", ")", "except", ":", "raise", "ValueError"...
Adds a new field to a specified dictionary. The field is also added as a process attribute. field_type can be 'input', 'diagnostics'
[ "Adds", "a", "new", "field", "to", "a", "specified", "dictionary", ".", "The", "field", "is", "also", "added", "as", "a", "process", "attribute", ".", "field_type", "can", "be", "input", "diagnostics" ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/process/process.py#L396-L405
train
brian-rose/climlab
climlab/process/process.py
Process.add_diagnostic
def add_diagnostic(self, name, value=None): """Create a new diagnostic variable called ``name`` for this process and initialize it with the given ``value``. Quantity is accessible in two ways: * as a process attribute, i.e. ``proc.name`` * as a member of the diagnostics...
python
def add_diagnostic(self, name, value=None): """Create a new diagnostic variable called ``name`` for this process and initialize it with the given ``value``. Quantity is accessible in two ways: * as a process attribute, i.e. ``proc.name`` * as a member of the diagnostics...
[ "def", "add_diagnostic", "(", "self", ",", "name", ",", "value", "=", "None", ")", ":", "self", ".", "_diag_vars", ".", "append", "(", "name", ")", "self", ".", "__setattr__", "(", "name", ",", "value", ")" ]
Create a new diagnostic variable called ``name`` for this process and initialize it with the given ``value``. Quantity is accessible in two ways: * as a process attribute, i.e. ``proc.name`` * as a member of the diagnostics dictionary, i.e. ``proc.diagnostics['nam...
[ "Create", "a", "new", "diagnostic", "variable", "called", "name", "for", "this", "process", "and", "initialize", "it", "with", "the", "given", "value", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/process/process.py#L407-L441
train
brian-rose/climlab
climlab/process/process.py
Process.add_input
def add_input(self, name, value=None): '''Create a new input variable called ``name`` for this process and initialize it with the given ``value``. Quantity is accessible in two ways: * as a process attribute, i.e. ``proc.name`` * as a member of the input dictionary, ...
python
def add_input(self, name, value=None): '''Create a new input variable called ``name`` for this process and initialize it with the given ``value``. Quantity is accessible in two ways: * as a process attribute, i.e. ``proc.name`` * as a member of the input dictionary, ...
[ "def", "add_input", "(", "self", ",", "name", ",", "value", "=", "None", ")", ":", "self", ".", "_input_vars", ".", "append", "(", "name", ")", "self", ".", "__setattr__", "(", "name", ",", "value", ")" ]
Create a new input variable called ``name`` for this process and initialize it with the given ``value``. Quantity is accessible in two ways: * as a process attribute, i.e. ``proc.name`` * as a member of the input dictionary, i.e. ``proc.input['name']`` Us...
[ "Create", "a", "new", "input", "variable", "called", "name", "for", "this", "process", "and", "initialize", "it", "with", "the", "given", "value", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/process/process.py#L443-L460
train
brian-rose/climlab
climlab/process/process.py
Process.remove_diagnostic
def remove_diagnostic(self, name): """ Removes a diagnostic from the ``process.diagnostic`` dictionary and also delete the associated process attribute. :param str name: name of diagnostic quantity to be removed :Example: Remove diagnostic variable 'icelat' from energy ...
python
def remove_diagnostic(self, name): """ Removes a diagnostic from the ``process.diagnostic`` dictionary and also delete the associated process attribute. :param str name: name of diagnostic quantity to be removed :Example: Remove diagnostic variable 'icelat' from energy ...
[ "def", "remove_diagnostic", "(", "self", ",", "name", ")", ":", "#_ = self.diagnostics.pop(name)", "#delattr(type(self), name)", "try", ":", "delattr", "(", "self", ",", "name", ")", "self", ".", "_diag_vars", ".", "remove", "(", "name", ")", "except", ":", "p...
Removes a diagnostic from the ``process.diagnostic`` dictionary and also delete the associated process attribute. :param str name: name of diagnostic quantity to be removed :Example: Remove diagnostic variable 'icelat' from energy balance model:: >>> import cli...
[ "Removes", "a", "diagnostic", "from", "the", "process", ".", "diagnostic", "dictionary", "and", "also", "delete", "the", "associated", "process", "attribute", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/process/process.py#L472-L503
train
brian-rose/climlab
climlab/process/process.py
Process.to_xarray
def to_xarray(self, diagnostics=False): """ Convert process variables to ``xarray.Dataset`` format. With ``diagnostics=True``, both state and diagnostic variables are included. Otherwise just the state variables are included. Returns an ``xarray.Dataset`` object with all spatial axes,...
python
def to_xarray(self, diagnostics=False): """ Convert process variables to ``xarray.Dataset`` format. With ``diagnostics=True``, both state and diagnostic variables are included. Otherwise just the state variables are included. Returns an ``xarray.Dataset`` object with all spatial axes,...
[ "def", "to_xarray", "(", "self", ",", "diagnostics", "=", "False", ")", ":", "if", "diagnostics", ":", "dic", "=", "self", ".", "state", ".", "copy", "(", ")", "dic", ".", "update", "(", "self", ".", "diagnostics", ")", "return", "state_to_xarray", "("...
Convert process variables to ``xarray.Dataset`` format. With ``diagnostics=True``, both state and diagnostic variables are included. Otherwise just the state variables are included. Returns an ``xarray.Dataset`` object with all spatial axes, including 'bounds' axes indicating cell bou...
[ "Convert", "process", "variables", "to", "xarray", ".", "Dataset", "format", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/process/process.py#L505-L583
train
brian-rose/climlab
climlab/process/process.py
Process.diagnostics
def diagnostics(self): """Dictionary access to all diagnostic variables :type: dict """ diag_dict = {} for key in self._diag_vars: try: #diag_dict[key] = getattr(self,key) # using self.__dict__ doesn't count diagnostics defined ...
python
def diagnostics(self): """Dictionary access to all diagnostic variables :type: dict """ diag_dict = {} for key in self._diag_vars: try: #diag_dict[key] = getattr(self,key) # using self.__dict__ doesn't count diagnostics defined ...
[ "def", "diagnostics", "(", "self", ")", ":", "diag_dict", "=", "{", "}", "for", "key", "in", "self", ".", "_diag_vars", ":", "try", ":", "#diag_dict[key] = getattr(self,key)", "# using self.__dict__ doesn't count diagnostics defined as properties", "diag_dict", "[", "k...
Dictionary access to all diagnostic variables :type: dict
[ "Dictionary", "access", "to", "all", "diagnostic", "variables" ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/process/process.py#L586-L600
train
brian-rose/climlab
climlab/process/process.py
Process.input
def input(self): """Dictionary access to all input variables That can be boundary conditions and other gridded quantities independent of the `process` :type: dict """ input_dict = {} for key in self._input_vars: try: input_dict[...
python
def input(self): """Dictionary access to all input variables That can be boundary conditions and other gridded quantities independent of the `process` :type: dict """ input_dict = {} for key in self._input_vars: try: input_dict[...
[ "def", "input", "(", "self", ")", ":", "input_dict", "=", "{", "}", "for", "key", "in", "self", ".", "_input_vars", ":", "try", ":", "input_dict", "[", "key", "]", "=", "getattr", "(", "self", ",", "key", ")", "except", ":", "pass", "return", "inpu...
Dictionary access to all input variables That can be boundary conditions and other gridded quantities independent of the `process` :type: dict
[ "Dictionary", "access", "to", "all", "input", "variables" ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/process/process.py#L602-L617
train
brian-rose/climlab
climlab/solar/orbital/table.py
_get_Berger_data
def _get_Berger_data(verbose=True): '''Read in the Berger and Loutre orbital table as a pandas dataframe, convert to xarray ''' # The first column of the data file is used as the row index, and represents kyr from present orbit91_pd, path = load_data_source(local_path = local_path, r...
python
def _get_Berger_data(verbose=True): '''Read in the Berger and Loutre orbital table as a pandas dataframe, convert to xarray ''' # The first column of the data file is used as the row index, and represents kyr from present orbit91_pd, path = load_data_source(local_path = local_path, r...
[ "def", "_get_Berger_data", "(", "verbose", "=", "True", ")", ":", "# The first column of the data file is used as the row index, and represents kyr from present", "orbit91_pd", ",", "path", "=", "load_data_source", "(", "local_path", "=", "local_path", ",", "remote_source_list"...
Read in the Berger and Loutre orbital table as a pandas dataframe, convert to xarray
[ "Read", "in", "the", "Berger", "and", "Loutre", "orbital", "table", "as", "a", "pandas", "dataframe", "convert", "to", "xarray" ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/solar/orbital/table.py#L14-L36
train
brian-rose/climlab
climlab/utils/data_source.py
load_data_source
def load_data_source(local_path, remote_source_list, open_method, open_method_kwargs=dict(), remote_kwargs=dict(), verbose=True): '''Flexible data retreiver to download and cache the data files locally. Usage example (this makes a local...
python
def load_data_source(local_path, remote_source_list, open_method, open_method_kwargs=dict(), remote_kwargs=dict(), verbose=True): '''Flexible data retreiver to download and cache the data files locally. Usage example (this makes a local...
[ "def", "load_data_source", "(", "local_path", ",", "remote_source_list", ",", "open_method", ",", "open_method_kwargs", "=", "dict", "(", ")", ",", "remote_kwargs", "=", "dict", "(", ")", ",", "verbose", "=", "True", ")", ":", "try", ":", "path", "=", "loc...
Flexible data retreiver to download and cache the data files locally. Usage example (this makes a local copy of the ozone data file): :Example: .. code-block:: python from climlab.utils.data_source import load_data_source from xarray import open_dataset ozonename ...
[ "Flexible", "data", "retreiver", "to", "download", "and", "cache", "the", "data", "files", "locally", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/utils/data_source.py#L4-L84
train
brian-rose/climlab
climlab/radiation/transmissivity.py
tril
def tril(array, k=0): '''Lower triangle of an array. Return a copy of an array with elements above the k-th diagonal zeroed. Need a multi-dimensional version here because numpy.tril does not broadcast for numpy verison < 1.9.''' try: tril_array = np.tril(array, k=k) except: # hav...
python
def tril(array, k=0): '''Lower triangle of an array. Return a copy of an array with elements above the k-th diagonal zeroed. Need a multi-dimensional version here because numpy.tril does not broadcast for numpy verison < 1.9.''' try: tril_array = np.tril(array, k=k) except: # hav...
[ "def", "tril", "(", "array", ",", "k", "=", "0", ")", ":", "try", ":", "tril_array", "=", "np", ".", "tril", "(", "array", ",", "k", "=", "k", ")", "except", ":", "# have to loop", "tril_array", "=", "np", ".", "zeros_like", "(", "array", ")", "s...
Lower triangle of an array. Return a copy of an array with elements above the k-th diagonal zeroed. Need a multi-dimensional version here because numpy.tril does not broadcast for numpy verison < 1.9.
[ "Lower", "triangle", "of", "an", "array", ".", "Return", "a", "copy", "of", "an", "array", "with", "elements", "above", "the", "k", "-", "th", "diagonal", "zeroed", ".", "Need", "a", "multi", "-", "dimensional", "version", "here", "because", "numpy", "."...
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/radiation/transmissivity.py#L209-L223
train
brian-rose/climlab
climlab/radiation/transmissivity.py
Transmissivity.flux_up
def flux_up(self, fluxUpBottom, emission=None): '''Compute downwelling radiative flux at interfaces between layers. Inputs: * fluxDownTop: flux down at top * emission: emission from atmospheric levels (N) defaults to zero if not given Returns: ...
python
def flux_up(self, fluxUpBottom, emission=None): '''Compute downwelling radiative flux at interfaces between layers. Inputs: * fluxDownTop: flux down at top * emission: emission from atmospheric levels (N) defaults to zero if not given Returns: ...
[ "def", "flux_up", "(", "self", ",", "fluxUpBottom", ",", "emission", "=", "None", ")", ":", "if", "emission", "is", "None", ":", "emission", "=", "np", ".", "zeros_like", "(", "self", ".", "absorptivity", ")", "E", "=", "np", ".", "concatenate", "(", ...
Compute downwelling radiative flux at interfaces between layers. Inputs: * fluxDownTop: flux down at top * emission: emission from atmospheric levels (N) defaults to zero if not given Returns: * vector of downwelling radiative flux between levels (N+...
[ "Compute", "downwelling", "radiative", "flux", "at", "interfaces", "between", "layers", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/radiation/transmissivity.py#L121-L140
train
brian-rose/climlab
climlab/radiation/transmissivity.py
Transmissivity.flux_down
def flux_down(self, fluxDownTop, emission=None): '''Compute upwelling radiative flux at interfaces between layers. Inputs: * fluxUpBottom: flux up from bottom * emission: emission from atmospheric levels (N) defaults to zero if not given Returns: ...
python
def flux_down(self, fluxDownTop, emission=None): '''Compute upwelling radiative flux at interfaces between layers. Inputs: * fluxUpBottom: flux up from bottom * emission: emission from atmospheric levels (N) defaults to zero if not given Returns: ...
[ "def", "flux_down", "(", "self", ",", "fluxDownTop", ",", "emission", "=", "None", ")", ":", "if", "emission", "is", "None", ":", "emission", "=", "np", ".", "zeros_like", "(", "self", ".", "absorptivity", ")", "E", "=", "np", ".", "concatenate", "(", ...
Compute upwelling radiative flux at interfaces between layers. Inputs: * fluxUpBottom: flux up from bottom * emission: emission from atmospheric levels (N) defaults to zero if not given Returns: * vector of upwelling radiative flux between levels (N+1...
[ "Compute", "upwelling", "radiative", "flux", "at", "interfaces", "between", "layers", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/radiation/transmissivity.py#L149-L167
train
brian-rose/climlab
climlab/radiation/rrtm/rrtmg_lw.py
RRTMG_LW._compute_heating_rates
def _compute_heating_rates(self): '''Prepare arguments and call the RRTGM_LW driver to calculate radiative fluxes and heating rates''' (ncol, nlay, icld, permuteseed, irng, idrv, cp, play, plev, tlay, tlev, tsfc, h2ovmr, o3vmr, co2vmr, ch4vmr, n2ovmr, o2vmr, ...
python
def _compute_heating_rates(self): '''Prepare arguments and call the RRTGM_LW driver to calculate radiative fluxes and heating rates''' (ncol, nlay, icld, permuteseed, irng, idrv, cp, play, plev, tlay, tlev, tsfc, h2ovmr, o3vmr, co2vmr, ch4vmr, n2ovmr, o2vmr, ...
[ "def", "_compute_heating_rates", "(", "self", ")", ":", "(", "ncol", ",", "nlay", ",", "icld", ",", "permuteseed", ",", "irng", ",", "idrv", ",", "cp", ",", "play", ",", "plev", ",", "tlay", ",", "tlev", ",", "tsfc", ",", "h2ovmr", ",", "o3vmr", ",...
Prepare arguments and call the RRTGM_LW driver to calculate radiative fluxes and heating rates
[ "Prepare", "arguments", "and", "call", "the", "RRTGM_LW", "driver", "to", "calculate", "radiative", "fluxes", "and", "heating", "rates" ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/radiation/rrtm/rrtmg_lw.py#L79-L126
train
brian-rose/climlab
climlab/radiation/rrtm/utils.py
_prepare_general_arguments
def _prepare_general_arguments(RRTMGobject): '''Prepare arguments needed for both RRTMG_SW and RRTMG_LW with correct dimensions.''' tlay = _climlab_to_rrtm(RRTMGobject.Tatm) tlev = _climlab_to_rrtm(interface_temperature(**RRTMGobject.state)) play = _climlab_to_rrtm(RRTMGobject.lev * np.ones_like(tlay)) ...
python
def _prepare_general_arguments(RRTMGobject): '''Prepare arguments needed for both RRTMG_SW and RRTMG_LW with correct dimensions.''' tlay = _climlab_to_rrtm(RRTMGobject.Tatm) tlev = _climlab_to_rrtm(interface_temperature(**RRTMGobject.state)) play = _climlab_to_rrtm(RRTMGobject.lev * np.ones_like(tlay)) ...
[ "def", "_prepare_general_arguments", "(", "RRTMGobject", ")", ":", "tlay", "=", "_climlab_to_rrtm", "(", "RRTMGobject", ".", "Tatm", ")", "tlev", "=", "_climlab_to_rrtm", "(", "interface_temperature", "(", "*", "*", "RRTMGobject", ".", "state", ")", ")", "play",...
Prepare arguments needed for both RRTMG_SW and RRTMG_LW with correct dimensions.
[ "Prepare", "arguments", "needed", "for", "both", "RRTMG_SW", "and", "RRTMG_LW", "with", "correct", "dimensions", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/radiation/rrtm/utils.py#L7-L37
train
brian-rose/climlab
climlab/radiation/rrtm/utils.py
interface_temperature
def interface_temperature(Ts, Tatm, **kwargs): '''Compute temperature at model layer interfaces.''' # Actually it's not clear to me how the RRTM code uses these values lev = Tatm.domain.axes['lev'].points lev_bounds = Tatm.domain.axes['lev'].bounds # Interpolate to layer interfaces f = interp1...
python
def interface_temperature(Ts, Tatm, **kwargs): '''Compute temperature at model layer interfaces.''' # Actually it's not clear to me how the RRTM code uses these values lev = Tatm.domain.axes['lev'].points lev_bounds = Tatm.domain.axes['lev'].bounds # Interpolate to layer interfaces f = interp1...
[ "def", "interface_temperature", "(", "Ts", ",", "Tatm", ",", "*", "*", "kwargs", ")", ":", "# Actually it's not clear to me how the RRTM code uses these values", "lev", "=", "Tatm", ".", "domain", ".", "axes", "[", "'lev'", "]", ".", "points", "lev_bounds", "=", ...
Compute temperature at model layer interfaces.
[ "Compute", "temperature", "at", "model", "layer", "interfaces", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/radiation/rrtm/utils.py#L41-L52
train
brian-rose/climlab
climlab/dynamics/meridional_moist_diffusion.py
moist_amplification_factor
def moist_amplification_factor(Tkelvin, relative_humidity=0.8): '''Compute the moisture amplification factor for the moist diffusivity given relative humidity and reference temperature profile.''' deltaT = 0.01 # slope of saturation specific humidity at 1000 hPa dqsdTs = (qsat(Tkelvin+deltaT/2, 100...
python
def moist_amplification_factor(Tkelvin, relative_humidity=0.8): '''Compute the moisture amplification factor for the moist diffusivity given relative humidity and reference temperature profile.''' deltaT = 0.01 # slope of saturation specific humidity at 1000 hPa dqsdTs = (qsat(Tkelvin+deltaT/2, 100...
[ "def", "moist_amplification_factor", "(", "Tkelvin", ",", "relative_humidity", "=", "0.8", ")", ":", "deltaT", "=", "0.01", "# slope of saturation specific humidity at 1000 hPa", "dqsdTs", "=", "(", "qsat", "(", "Tkelvin", "+", "deltaT", "/", "2", ",", "1000.", "...
Compute the moisture amplification factor for the moist diffusivity given relative humidity and reference temperature profile.
[ "Compute", "the", "moisture", "amplification", "factor", "for", "the", "moist", "diffusivity", "given", "relative", "humidity", "and", "reference", "temperature", "profile", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/dynamics/meridional_moist_diffusion.py#L145-L151
train
brian-rose/climlab
climlab/solar/insolation.py
daily_insolation
def daily_insolation(lat, day, orb=const.orb_present, S0=const.S0, day_type=1): """Compute daily average insolation given latitude, time of year and orbital parameters. Orbital parameters can be interpolated to any time in the last 5 Myears with ``climlab.solar.orbital.OrbitalTable`` (see example above). ...
python
def daily_insolation(lat, day, orb=const.orb_present, S0=const.S0, day_type=1): """Compute daily average insolation given latitude, time of year and orbital parameters. Orbital parameters can be interpolated to any time in the last 5 Myears with ``climlab.solar.orbital.OrbitalTable`` (see example above). ...
[ "def", "daily_insolation", "(", "lat", ",", "day", ",", "orb", "=", "const", ".", "orb_present", ",", "S0", "=", "const", ".", "S0", ",", "day_type", "=", "1", ")", ":", "# Inputs can be scalar, numpy vector, or xarray.DataArray.", "# If numpy, convert to xarray so...
Compute daily average insolation given latitude, time of year and orbital parameters. Orbital parameters can be interpolated to any time in the last 5 Myears with ``climlab.solar.orbital.OrbitalTable`` (see example above). Longer orbital tables are available with ``climlab.solar.orbital.LongOrbitalTable``...
[ "Compute", "daily", "average", "insolation", "given", "latitude", "time", "of", "year", "and", "orbital", "parameters", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/solar/insolation.py#L46-L160
train
brian-rose/climlab
climlab/solar/insolation.py
solar_longitude
def solar_longitude( day, orb=const.orb_present, days_per_year = None ): """Estimates solar longitude from calendar day. Method is using an approximation from :cite:`Berger_1978` section 3 (lambda = 0 at spring equinox). **Function-call arguments** \n :param array day: Indicator of time...
python
def solar_longitude( day, orb=const.orb_present, days_per_year = None ): """Estimates solar longitude from calendar day. Method is using an approximation from :cite:`Berger_1978` section 3 (lambda = 0 at spring equinox). **Function-call arguments** \n :param array day: Indicator of time...
[ "def", "solar_longitude", "(", "day", ",", "orb", "=", "const", ".", "orb_present", ",", "days_per_year", "=", "None", ")", ":", "if", "days_per_year", "is", "None", ":", "days_per_year", "=", "const", ".", "days_per_year", "ecc", "=", "orb", "[", "'ecc'",...
Estimates solar longitude from calendar day. Method is using an approximation from :cite:`Berger_1978` section 3 (lambda = 0 at spring equinox). **Function-call arguments** \n :param array day: Indicator of time of year. :param dict orb: a dictionary with three members (as pr...
[ "Estimates", "solar", "longitude", "from", "calendar", "day", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/solar/insolation.py#L163-L215
train
brian-rose/climlab
climlab/domain/domain.py
single_column
def single_column(num_lev=30, water_depth=1., lev=None, **kwargs): """Creates domains for a single column of atmosphere overlying a slab of water. Can also pass a pressure array or pressure level axis object specified in ``lev``. If argument ``lev`` is not ``None`` then function tries to build a level axi...
python
def single_column(num_lev=30, water_depth=1., lev=None, **kwargs): """Creates domains for a single column of atmosphere overlying a slab of water. Can also pass a pressure array or pressure level axis object specified in ``lev``. If argument ``lev`` is not ``None`` then function tries to build a level axi...
[ "def", "single_column", "(", "num_lev", "=", "30", ",", "water_depth", "=", "1.", ",", "lev", "=", "None", ",", "*", "*", "kwargs", ")", ":", "if", "lev", "is", "None", ":", "levax", "=", "Axis", "(", "axis_type", "=", "'lev'", ",", "num_points", "...
Creates domains for a single column of atmosphere overlying a slab of water. Can also pass a pressure array or pressure level axis object specified in ``lev``. If argument ``lev`` is not ``None`` then function tries to build a level axis and ``num_lev`` is ignored. **Function-call argument** \n ...
[ "Creates", "domains", "for", "a", "single", "column", "of", "atmosphere", "overlying", "a", "slab", "of", "water", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/domain/domain.py#L411-L458
train
brian-rose/climlab
climlab/domain/domain.py
zonal_mean_surface
def zonal_mean_surface(num_lat=90, water_depth=10., lat=None, **kwargs): """Creates a 1D slab ocean Domain in latitude with uniform water depth. Domain has a single heat capacity according to the specified water depth. **Function-call argument** \n :param int num_lat: number of latitude point...
python
def zonal_mean_surface(num_lat=90, water_depth=10., lat=None, **kwargs): """Creates a 1D slab ocean Domain in latitude with uniform water depth. Domain has a single heat capacity according to the specified water depth. **Function-call argument** \n :param int num_lat: number of latitude point...
[ "def", "zonal_mean_surface", "(", "num_lat", "=", "90", ",", "water_depth", "=", "10.", ",", "lat", "=", "None", ",", "*", "*", "kwargs", ")", ":", "if", "lat", "is", "None", ":", "latax", "=", "Axis", "(", "axis_type", "=", "'lat'", ",", "num_points...
Creates a 1D slab ocean Domain in latitude with uniform water depth. Domain has a single heat capacity according to the specified water depth. **Function-call argument** \n :param int num_lat: number of latitude points [default: 90] :param float water_depth: depth of the slab ocean in meter...
[ "Creates", "a", "1D", "slab", "ocean", "Domain", "in", "latitude", "with", "uniform", "water", "depth", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/domain/domain.py#L461-L499
train
brian-rose/climlab
climlab/domain/domain.py
surface_2D
def surface_2D(num_lat=90, num_lon=180, water_depth=10., lon=None, lat=None, **kwargs): """Creates a 2D slab ocean Domain in latitude and longitude with uniform water depth. Domain has a single heat capacity according to the specified water depth. **Function-call argument** \n :param i...
python
def surface_2D(num_lat=90, num_lon=180, water_depth=10., lon=None, lat=None, **kwargs): """Creates a 2D slab ocean Domain in latitude and longitude with uniform water depth. Domain has a single heat capacity according to the specified water depth. **Function-call argument** \n :param i...
[ "def", "surface_2D", "(", "num_lat", "=", "90", ",", "num_lon", "=", "180", ",", "water_depth", "=", "10.", ",", "lon", "=", "None", ",", "lat", "=", "None", ",", "*", "*", "kwargs", ")", ":", "if", "lat", "is", "None", ":", "latax", "=", "Axis",...
Creates a 2D slab ocean Domain in latitude and longitude with uniform water depth. Domain has a single heat capacity according to the specified water depth. **Function-call argument** \n :param int num_lat: number of latitude points [default: 90] :param int num_lon: number of longitud...
[ "Creates", "a", "2D", "slab", "ocean", "Domain", "in", "latitude", "and", "longitude", "with", "uniform", "water", "depth", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/domain/domain.py#L501-L553
train
brian-rose/climlab
climlab/domain/domain.py
_Domain._make_axes_dict
def _make_axes_dict(self, axes): """Makes an axes dictionary. .. note:: In case the input is ``None``, the dictionary :code:`{'empty': None}` is returned. **Function-call argument** \n :param axes: axes input :type axes: dict or single instance ...
python
def _make_axes_dict(self, axes): """Makes an axes dictionary. .. note:: In case the input is ``None``, the dictionary :code:`{'empty': None}` is returned. **Function-call argument** \n :param axes: axes input :type axes: dict or single instance ...
[ "def", "_make_axes_dict", "(", "self", ",", "axes", ")", ":", "if", "type", "(", "axes", ")", "is", "dict", ":", "axdict", "=", "axes", "elif", "type", "(", "axes", ")", "is", "Axis", ":", "ax", "=", "axes", "axdict", "=", "{", "ax", ".", "axis_t...
Makes an axes dictionary. .. note:: In case the input is ``None``, the dictionary :code:`{'empty': None}` is returned. **Function-call argument** \n :param axes: axes input :type axes: dict or single instance of :class:`~climlab....
[ "Makes", "an", "axes", "dictionary", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/domain/domain.py#L129-L157
train
brian-rose/climlab
climlab/process/implicit.py
ImplicitProcess._compute
def _compute(self): """Computes the state variable tendencies in time for implicit processes. To calculate the new state the :func:`_implicit_solver()` method is called for daughter classes. This however returns the new state of the variables, not just the tendencies. Therefore, the adj...
python
def _compute(self): """Computes the state variable tendencies in time for implicit processes. To calculate the new state the :func:`_implicit_solver()` method is called for daughter classes. This however returns the new state of the variables, not just the tendencies. Therefore, the adj...
[ "def", "_compute", "(", "self", ")", ":", "newstate", "=", "self", ".", "_implicit_solver", "(", ")", "adjustment", "=", "{", "}", "tendencies", "=", "{", "}", "for", "name", ",", "var", "in", "self", ".", "state", ".", "items", "(", ")", ":", "adj...
Computes the state variable tendencies in time for implicit processes. To calculate the new state the :func:`_implicit_solver()` method is called for daughter classes. This however returns the new state of the variables, not just the tendencies. Therefore, the adjustment is calculated w...
[ "Computes", "the", "state", "variable", "tendencies", "in", "time", "for", "implicit", "processes", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/process/implicit.py#L23-L57
train
brian-rose/climlab
climlab/utils/walk.py
walk_processes
def walk_processes(top, topname='top', topdown=True, ignoreFlag=False): """Generator for recursive tree of climlab processes Starts walking from climlab process ``top`` and generates a complete list of all processes and sub-processes that are managed from ``top`` process. ``level`` indicades the rank o...
python
def walk_processes(top, topname='top', topdown=True, ignoreFlag=False): """Generator for recursive tree of climlab processes Starts walking from climlab process ``top`` and generates a complete list of all processes and sub-processes that are managed from ``top`` process. ``level`` indicades the rank o...
[ "def", "walk_processes", "(", "top", ",", "topname", "=", "'top'", ",", "topdown", "=", "True", ",", "ignoreFlag", "=", "False", ")", ":", "if", "not", "ignoreFlag", ":", "flag", "=", "topdown", "else", ":", "flag", "=", "True", "proc", "=", "top", "...
Generator for recursive tree of climlab processes Starts walking from climlab process ``top`` and generates a complete list of all processes and sub-processes that are managed from ``top`` process. ``level`` indicades the rank of specific process in the process hierarchy: .. note:: * level 0:...
[ "Generator", "for", "recursive", "tree", "of", "climlab", "processes" ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/utils/walk.py#L3-L71
train
brian-rose/climlab
climlab/utils/walk.py
process_tree
def process_tree(top, name='top'): """Creates a string representation of the process tree for process top. This method uses the :func:`walk_processes` method to create the process tree. :param top: top process for which process tree string should be created :typ...
python
def process_tree(top, name='top'): """Creates a string representation of the process tree for process top. This method uses the :func:`walk_processes` method to create the process tree. :param top: top process for which process tree string should be created :typ...
[ "def", "process_tree", "(", "top", ",", "name", "=", "'top'", ")", ":", "str1", "=", "''", "for", "name", ",", "proc", ",", "level", "in", "walk_processes", "(", "top", ",", "name", ",", "ignoreFlag", "=", "True", ")", ":", "indent", "=", "' '", "*...
Creates a string representation of the process tree for process top. This method uses the :func:`walk_processes` method to create the process tree. :param top: top process for which process tree string should be created :type top: :class:`~climlab.proce...
[ "Creates", "a", "string", "representation", "of", "the", "process", "tree", "for", "process", "top", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/utils/walk.py#L74-L111
train
brian-rose/climlab
climlab/radiation/greygas.py
GreyGas._compute_fluxes
def _compute_fluxes(self): ''' All fluxes are band by band''' self.emission = self._compute_emission() self.emission_sfc = self._compute_emission_sfc() fromspace = self._from_space() self.flux_down = self.trans.flux_down(fromspace, self.emission) self.flux_reflected_up = ...
python
def _compute_fluxes(self): ''' All fluxes are band by band''' self.emission = self._compute_emission() self.emission_sfc = self._compute_emission_sfc() fromspace = self._from_space() self.flux_down = self.trans.flux_down(fromspace, self.emission) self.flux_reflected_up = ...
[ "def", "_compute_fluxes", "(", "self", ")", ":", "self", ".", "emission", "=", "self", ".", "_compute_emission", "(", ")", "self", ".", "emission_sfc", "=", "self", ".", "_compute_emission_sfc", "(", ")", "fromspace", "=", "self", ".", "_from_space", "(", ...
All fluxes are band by band
[ "All", "fluxes", "are", "band", "by", "band" ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/radiation/greygas.py#L129-L146
train
brian-rose/climlab
climlab/radiation/greygas.py
GreyGas.flux_components_top
def flux_components_top(self): '''Compute the contributions to the outgoing flux to space due to emissions from each level and the surface.''' N = self.lev.size flux_up_bottom = self.flux_from_sfc emission = np.zeros_like(self.emission) this_flux_up = (np.ones_like(self.T...
python
def flux_components_top(self): '''Compute the contributions to the outgoing flux to space due to emissions from each level and the surface.''' N = self.lev.size flux_up_bottom = self.flux_from_sfc emission = np.zeros_like(self.emission) this_flux_up = (np.ones_like(self.T...
[ "def", "flux_components_top", "(", "self", ")", ":", "N", "=", "self", ".", "lev", ".", "size", "flux_up_bottom", "=", "self", ".", "flux_from_sfc", "emission", "=", "np", ".", "zeros_like", "(", "self", ".", "emission", ")", "this_flux_up", "=", "(", "n...
Compute the contributions to the outgoing flux to space due to emissions from each level and the surface.
[ "Compute", "the", "contributions", "to", "the", "outgoing", "flux", "to", "space", "due", "to", "emissions", "from", "each", "level", "and", "the", "surface", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/radiation/greygas.py#L185-L204
train
brian-rose/climlab
climlab/radiation/greygas.py
GreyGas.flux_components_bottom
def flux_components_bottom(self): '''Compute the contributions to the downwelling flux to surface due to emissions from each level.''' N = self.lev.size atmComponents = np.zeros_like(self.Tatm) flux_down_top = np.zeros_like(self.Ts) # same comment as above... would be ni...
python
def flux_components_bottom(self): '''Compute the contributions to the downwelling flux to surface due to emissions from each level.''' N = self.lev.size atmComponents = np.zeros_like(self.Tatm) flux_down_top = np.zeros_like(self.Ts) # same comment as above... would be ni...
[ "def", "flux_components_bottom", "(", "self", ")", ":", "N", "=", "self", ".", "lev", ".", "size", "atmComponents", "=", "np", ".", "zeros_like", "(", "self", ".", "Tatm", ")", "flux_down_top", "=", "np", ".", "zeros_like", "(", "self", ".", "Ts", ")",...
Compute the contributions to the downwelling flux to surface due to emissions from each level.
[ "Compute", "the", "contributions", "to", "the", "downwelling", "flux", "to", "surface", "due", "to", "emissions", "from", "each", "level", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/radiation/greygas.py#L206-L218
train
brian-rose/climlab
climlab/surface/turbulent.py
LatentHeatFlux._compute
def _compute(self): '''Overides the _compute method of EnergyBudget''' tendencies = self._temperature_tendencies() if 'q' in self.state: # in a model with active water vapor, this flux should affect # water vapor tendency, NOT air temperature tendency! tenden...
python
def _compute(self): '''Overides the _compute method of EnergyBudget''' tendencies = self._temperature_tendencies() if 'q' in self.state: # in a model with active water vapor, this flux should affect # water vapor tendency, NOT air temperature tendency! tenden...
[ "def", "_compute", "(", "self", ")", ":", "tendencies", "=", "self", ".", "_temperature_tendencies", "(", ")", "if", "'q'", "in", "self", ".", "state", ":", "# in a model with active water vapor, this flux should affect", "# water vapor tendency, NOT air temperature tenden...
Overides the _compute method of EnergyBudget
[ "Overides", "the", "_compute", "method", "of", "EnergyBudget" ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/surface/turbulent.py#L187-L199
train
brian-rose/climlab
climlab/utils/legendre.py
Pn
def Pn(x): """Calculate Legendre polyomials P0 to P28 and returns them in a dictionary ``Pn``. :param float x: argument to calculate Legendre polynomials :return Pn: dictionary which contains order of Legendre polynomials (from 0 to 28) as keys and the corresponding ...
python
def Pn(x): """Calculate Legendre polyomials P0 to P28 and returns them in a dictionary ``Pn``. :param float x: argument to calculate Legendre polynomials :return Pn: dictionary which contains order of Legendre polynomials (from 0 to 28) as keys and the corresponding ...
[ "def", "Pn", "(", "x", ")", ":", "Pn", "=", "{", "}", "Pn", "[", "'0'", "]", "=", "P0", "(", "x", ")", "Pn", "[", "'1'", "]", "=", "P1", "(", "x", ")", "Pn", "[", "'2'", "]", "=", "P2", "(", "x", ")", "Pn", "[", "'3'", "]", "=", "P3...
Calculate Legendre polyomials P0 to P28 and returns them in a dictionary ``Pn``. :param float x: argument to calculate Legendre polynomials :return Pn: dictionary which contains order of Legendre polynomials (from 0 to 28) as keys and the corresponding evaluation ...
[ "Calculate", "Legendre", "polyomials", "P0", "to", "P28", "and", "returns", "them", "in", "a", "dictionary", "Pn", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/utils/legendre.py#L6-L36
train
brian-rose/climlab
climlab/utils/legendre.py
Pnprime
def Pnprime(x): """Calculates first derivatives of Legendre polynomials and returns them in a dictionary ``Pnprime``. :param float x: argument to calculate first derivate of Legendre polynomials :return Pn: dictionary which contains order of Legendre polynomials (fro...
python
def Pnprime(x): """Calculates first derivatives of Legendre polynomials and returns them in a dictionary ``Pnprime``. :param float x: argument to calculate first derivate of Legendre polynomials :return Pn: dictionary which contains order of Legendre polynomials (fro...
[ "def", "Pnprime", "(", "x", ")", ":", "Pnprime", "=", "{", "}", "Pnprime", "[", "'0'", "]", "=", "0", "Pnprime", "[", "'1'", "]", "=", "P1prime", "(", "x", ")", "Pnprime", "[", "'2'", "]", "=", "P2prime", "(", "x", ")", "Pnprime", "[", "'3'", ...
Calculates first derivatives of Legendre polynomials and returns them in a dictionary ``Pnprime``. :param float x: argument to calculate first derivate of Legendre polynomials :return Pn: dictionary which contains order of Legendre polynomials (from 0 to 4 and even numbe...
[ "Calculates", "first", "derivatives", "of", "Legendre", "polynomials", "and", "returns", "them", "in", "a", "dictionary", "Pnprime", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/utils/legendre.py#L38-L61
train
brian-rose/climlab
climlab/model/ebm.py
EBM.inferred_heat_transport
def inferred_heat_transport(self): """Calculates the inferred heat transport by integrating the TOA energy imbalance from pole to pole. The method is calculating .. math:: H(\\varphi) = 2 \pi R^2 \int_{-\pi/2}^{\\varphi} cos\phi \ R_{TOA} d\phi where :math:`R_{TOA...
python
def inferred_heat_transport(self): """Calculates the inferred heat transport by integrating the TOA energy imbalance from pole to pole. The method is calculating .. math:: H(\\varphi) = 2 \pi R^2 \int_{-\pi/2}^{\\varphi} cos\phi \ R_{TOA} d\phi where :math:`R_{TOA...
[ "def", "inferred_heat_transport", "(", "self", ")", ":", "phi", "=", "np", ".", "deg2rad", "(", "self", ".", "lat", ")", "energy_in", "=", "np", ".", "squeeze", "(", "self", ".", "net_radiation", ")", "return", "(", "1E-15", "*", "2", "*", "np", ".",...
Calculates the inferred heat transport by integrating the TOA energy imbalance from pole to pole. The method is calculating .. math:: H(\\varphi) = 2 \pi R^2 \int_{-\pi/2}^{\\varphi} cos\phi \ R_{TOA} d\phi where :math:`R_{TOA}` is the net radiation at top of atmosphere. ...
[ "Calculates", "the", "inferred", "heat", "transport", "by", "integrating", "the", "TOA", "energy", "imbalance", "from", "pole", "to", "pole", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/model/ebm.py#L312-L337
train
brian-rose/climlab
climlab/radiation/rrtm/_rrtmg_lw/setup.py
rrtmg_lw_gen_source
def rrtmg_lw_gen_source(ext, build_dir): '''Add RRTMG_LW fortran source if Fortran 90 compiler available, if no compiler is found do not try to build the extension.''' thispath = config.local_path module_src = [] for item in modules: fullname = join(thispath,'rrtmg_lw_v4.85','gcm_model','mod...
python
def rrtmg_lw_gen_source(ext, build_dir): '''Add RRTMG_LW fortran source if Fortran 90 compiler available, if no compiler is found do not try to build the extension.''' thispath = config.local_path module_src = [] for item in modules: fullname = join(thispath,'rrtmg_lw_v4.85','gcm_model','mod...
[ "def", "rrtmg_lw_gen_source", "(", "ext", ",", "build_dir", ")", ":", "thispath", "=", "config", ".", "local_path", "module_src", "=", "[", "]", "for", "item", "in", "modules", ":", "fullname", "=", "join", "(", "thispath", ",", "'rrtmg_lw_v4.85'", ",", "'...
Add RRTMG_LW fortran source if Fortran 90 compiler available, if no compiler is found do not try to build the extension.
[ "Add", "RRTMG_LW", "fortran", "source", "if", "Fortran", "90", "compiler", "available", "if", "no", "compiler", "is", "found", "do", "not", "try", "to", "build", "the", "extension", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/radiation/rrtm/_rrtmg_lw/setup.py#L77-L98
train
brian-rose/climlab
climlab/process/time_dependent_process.py
TimeDependentProcess.compute
def compute(self): """Computes the tendencies for all state variables given current state and specified input. The function first computes all diagnostic processes. They don't produce any tendencies directly but they may affect the other processes (such as change in solar distri...
python
def compute(self): """Computes the tendencies for all state variables given current state and specified input. The function first computes all diagnostic processes. They don't produce any tendencies directly but they may affect the other processes (such as change in solar distri...
[ "def", "compute", "(", "self", ")", ":", "# First reset tendencies to zero -- recomputing them is the point of this method", "for", "varname", "in", "self", ".", "tendencies", ":", "self", ".", "tendencies", "[", "varname", "]", "*=", "0.", "if", "not", "self", "."...
Computes the tendencies for all state variables given current state and specified input. The function first computes all diagnostic processes. They don't produce any tendencies directly but they may affect the other processes (such as change in solar distribution). Subsequently, all ten...
[ "Computes", "the", "tendencies", "for", "all", "state", "variables", "given", "current", "state", "and", "specified", "input", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/process/time_dependent_process.py#L162-L243
train
brian-rose/climlab
climlab/process/time_dependent_process.py
TimeDependentProcess._compute_type
def _compute_type(self, proctype): """Computes tendencies due to all subprocesses of given type ``'proctype'``. Also pass all diagnostics up to parent process.""" tendencies = {} for varname in self.state: tendencies[varname] = 0. * self.state[varname] for proc in sel...
python
def _compute_type(self, proctype): """Computes tendencies due to all subprocesses of given type ``'proctype'``. Also pass all diagnostics up to parent process.""" tendencies = {} for varname in self.state: tendencies[varname] = 0. * self.state[varname] for proc in sel...
[ "def", "_compute_type", "(", "self", ",", "proctype", ")", ":", "tendencies", "=", "{", "}", "for", "varname", "in", "self", ".", "state", ":", "tendencies", "[", "varname", "]", "=", "0.", "*", "self", ".", "state", "[", "varname", "]", "for", "proc...
Computes tendencies due to all subprocesses of given type ``'proctype'``. Also pass all diagnostics up to parent process.
[ "Computes", "tendencies", "due", "to", "all", "subprocesses", "of", "given", "type", "proctype", ".", "Also", "pass", "all", "diagnostics", "up", "to", "parent", "process", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/process/time_dependent_process.py#L245-L270
train
brian-rose/climlab
climlab/process/time_dependent_process.py
TimeDependentProcess._compute
def _compute(self): """Where the tendencies are actually computed... Needs to be implemented for each daughter class Returns a dictionary with same keys as self.state""" tendencies = {} for name, value in self.state.items(): tendencies[name] = value * 0. ret...
python
def _compute(self): """Where the tendencies are actually computed... Needs to be implemented for each daughter class Returns a dictionary with same keys as self.state""" tendencies = {} for name, value in self.state.items(): tendencies[name] = value * 0. ret...
[ "def", "_compute", "(", "self", ")", ":", "tendencies", "=", "{", "}", "for", "name", ",", "value", "in", "self", ".", "state", ".", "items", "(", ")", ":", "tendencies", "[", "name", "]", "=", "value", "*", "0.", "return", "tendencies" ]
Where the tendencies are actually computed... Needs to be implemented for each daughter class Returns a dictionary with same keys as self.state
[ "Where", "the", "tendencies", "are", "actually", "computed", "..." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/process/time_dependent_process.py#L272-L281
train
brian-rose/climlab
climlab/process/time_dependent_process.py
TimeDependentProcess._build_process_type_list
def _build_process_type_list(self): """Generates lists of processes organized by process type. Following object attributes are generated or updated: :ivar dict process_types: a dictionary with entries: ``'diagnostic'``, ``'explicit'``, ...
python
def _build_process_type_list(self): """Generates lists of processes organized by process type. Following object attributes are generated or updated: :ivar dict process_types: a dictionary with entries: ``'diagnostic'``, ``'explicit'``, ...
[ "def", "_build_process_type_list", "(", "self", ")", ":", "self", ".", "process_types", "=", "{", "'diagnostic'", ":", "[", "]", ",", "'explicit'", ":", "[", "]", ",", "'implicit'", ":", "[", "]", ",", "'adjustment'", ":", "[", "]", "}", "#for name, proc...
Generates lists of processes organized by process type. Following object attributes are generated or updated: :ivar dict process_types: a dictionary with entries: ``'diagnostic'``, ``'explicit'``, ``'implicit'`` and ``'adjustmen...
[ "Generates", "lists", "of", "processes", "organized", "by", "process", "type", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/process/time_dependent_process.py#L283-L305
train
brian-rose/climlab
climlab/process/time_dependent_process.py
TimeDependentProcess.step_forward
def step_forward(self): """Updates state variables with computed tendencies. Calls the :func:`compute` method to get current tendencies for all process states. Multiplied with the timestep and added up to the state variables is updating all model states. :Example: ...
python
def step_forward(self): """Updates state variables with computed tendencies. Calls the :func:`compute` method to get current tendencies for all process states. Multiplied with the timestep and added up to the state variables is updating all model states. :Example: ...
[ "def", "step_forward", "(", "self", ")", ":", "tenddict", "=", "self", ".", "compute", "(", ")", "# Total tendency is applied as an explicit forward timestep", "# (already accounting properly for order of operations in compute() )", "for", "varname", ",", "tend", "in", "tend...
Updates state variables with computed tendencies. Calls the :func:`compute` method to get current tendencies for all process states. Multiplied with the timestep and added up to the state variables is updating all model states. :Example: :: >>> import clim...
[ "Updates", "state", "variables", "with", "computed", "tendencies", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/process/time_dependent_process.py#L307-L342
train
brian-rose/climlab
climlab/process/time_dependent_process.py
TimeDependentProcess._update_time
def _update_time(self): """Increments the timestep counter by one. Furthermore ``self.time['days_elapsed']`` and ``self.time['num_steps_per_year']`` are updated. The function is called by the time stepping methods. """ self.time['steps'] += 1 # time in days sin...
python
def _update_time(self): """Increments the timestep counter by one. Furthermore ``self.time['days_elapsed']`` and ``self.time['num_steps_per_year']`` are updated. The function is called by the time stepping methods. """ self.time['steps'] += 1 # time in days sin...
[ "def", "_update_time", "(", "self", ")", ":", "self", ".", "time", "[", "'steps'", "]", "+=", "1", "# time in days since beginning", "self", ".", "time", "[", "'days_elapsed'", "]", "+=", "self", ".", "time", "[", "'timestep'", "]", "/", "const", ".", "s...
Increments the timestep counter by one. Furthermore ``self.time['days_elapsed']`` and ``self.time['num_steps_per_year']`` are updated. The function is called by the time stepping methods.
[ "Increments", "the", "timestep", "counter", "by", "one", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/process/time_dependent_process.py#L354-L369
train
brian-rose/climlab
climlab/process/time_dependent_process.py
TimeDependentProcess.integrate_years
def integrate_years(self, years=1.0, verbose=True): """Integrates the model by a given number of years. :param float years: integration time for the model in years [default: 1.0] :param bool verbose: information whether model time details ...
python
def integrate_years(self, years=1.0, verbose=True): """Integrates the model by a given number of years. :param float years: integration time for the model in years [default: 1.0] :param bool verbose: information whether model time details ...
[ "def", "integrate_years", "(", "self", ",", "years", "=", "1.0", ",", "verbose", "=", "True", ")", ":", "days", "=", "years", "*", "const", ".", "days_per_year", "numsteps", "=", "int", "(", "self", ".", "time", "[", "'num_steps_per_year'", "]", "*", "...
Integrates the model by a given number of years. :param float years: integration time for the model in years [default: 1.0] :param bool verbose: information whether model time details should be printed [default: True] It ca...
[ "Integrates", "the", "model", "by", "a", "given", "number", "of", "years", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/process/time_dependent_process.py#L380-L449
train
brian-rose/climlab
climlab/process/time_dependent_process.py
TimeDependentProcess.integrate_days
def integrate_days(self, days=1.0, verbose=True): """Integrates the model forward for a specified number of days. It convertes the given number of days into years and calls :func:`integrate_years`. :param float days: integration time for the model in days ...
python
def integrate_days(self, days=1.0, verbose=True): """Integrates the model forward for a specified number of days. It convertes the given number of days into years and calls :func:`integrate_years`. :param float days: integration time for the model in days ...
[ "def", "integrate_days", "(", "self", ",", "days", "=", "1.0", ",", "verbose", "=", "True", ")", ":", "years", "=", "days", "/", "const", ".", "days_per_year", "self", ".", "integrate_years", "(", "years", "=", "years", ",", "verbose", "=", "verbose", ...
Integrates the model forward for a specified number of days. It convertes the given number of days into years and calls :func:`integrate_years`. :param float days: integration time for the model in days [default: 1.0] :param bool verbose: informa...
[ "Integrates", "the", "model", "forward", "for", "a", "specified", "number", "of", "days", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/process/time_dependent_process.py#L451-L481
train
brian-rose/climlab
climlab/process/time_dependent_process.py
TimeDependentProcess.integrate_converge
def integrate_converge(self, crit=1e-4, verbose=True): """Integrates the model until model states are converging. :param crit: exit criteria for difference of iterated solutions [default: 0.0001] :type crit: float :param bool verbos...
python
def integrate_converge(self, crit=1e-4, verbose=True): """Integrates the model until model states are converging. :param crit: exit criteria for difference of iterated solutions [default: 0.0001] :type crit: float :param bool verbos...
[ "def", "integrate_converge", "(", "self", ",", "crit", "=", "1e-4", ",", "verbose", "=", "True", ")", ":", "# implemented by m-kreuzer", "for", "varname", ",", "value", "in", "self", ".", "state", ".", "items", "(", ")", ":", "value_old", "=", "copy", "....
Integrates the model until model states are converging. :param crit: exit criteria for difference of iterated solutions [default: 0.0001] :type crit: float :param bool verbose: information whether total elapsed time ...
[ "Integrates", "the", "model", "until", "model", "states", "are", "converging", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/process/time_dependent_process.py#L483-L518
train
brian-rose/climlab
climlab/radiation/cam3/setup.py
cam3_gen_source
def cam3_gen_source(ext, build_dir): '''Add CAM3 fortran source if Fortran 90 compiler available, if no compiler is found do not try to build the extension.''' # Fortran 90 sources in order of compilation fort90source = ['pmgrid.F90', 'prescribed_aerosols.F90', 'shr_kind...
python
def cam3_gen_source(ext, build_dir): '''Add CAM3 fortran source if Fortran 90 compiler available, if no compiler is found do not try to build the extension.''' # Fortran 90 sources in order of compilation fort90source = ['pmgrid.F90', 'prescribed_aerosols.F90', 'shr_kind...
[ "def", "cam3_gen_source", "(", "ext", ",", "build_dir", ")", ":", "# Fortran 90 sources in order of compilation", "fort90source", "=", "[", "'pmgrid.F90'", ",", "'prescribed_aerosols.F90'", ",", "'shr_kind_mod.F90'", ",", "'quicksort.F90'", ",", "'abortutils.F90'", ",", ...
Add CAM3 fortran source if Fortran 90 compiler available, if no compiler is found do not try to build the extension.
[ "Add", "CAM3", "fortran", "source", "if", "Fortran", "90", "compiler", "available", "if", "no", "compiler", "is", "found", "do", "not", "try", "to", "build", "the", "extension", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/radiation/cam3/setup.py#L39-L74
train
brian-rose/climlab
climlab/domain/field.py
global_mean
def global_mean(field): """Calculates the latitude weighted global mean of a field with latitude dependence. :param Field field: input field :raises: :exc:`ValueError` if input field has no latitude axis :return: latitude weighted global mean of the field :rtype: float :Example: i...
python
def global_mean(field): """Calculates the latitude weighted global mean of a field with latitude dependence. :param Field field: input field :raises: :exc:`ValueError` if input field has no latitude axis :return: latitude weighted global mean of the field :rtype: float :Example: i...
[ "def", "global_mean", "(", "field", ")", ":", "try", ":", "lat", "=", "field", ".", "domain", ".", "lat", ".", "points", "except", ":", "raise", "ValueError", "(", "'No latitude axis in input field.'", ")", "try", ":", "# Field is 2D latitude / longitude", "lon...
Calculates the latitude weighted global mean of a field with latitude dependence. :param Field field: input field :raises: :exc:`ValueError` if input field has no latitude axis :return: latitude weighted global mean of the field :rtype: float :Example: initial global mean temperature ...
[ "Calculates", "the", "latitude", "weighted", "global", "mean", "of", "a", "field", "with", "latitude", "dependence", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/domain/field.py#L194-L224
train
brian-rose/climlab
climlab/domain/field.py
to_latlon
def to_latlon(array, domain, axis = 'lon'): """Broadcasts a 1D axis dependent array across another axis. :param array input_array: the 1D array used for broadcasting :param domain: the domain associated with that array :param axis: the axis ...
python
def to_latlon(array, domain, axis = 'lon'): """Broadcasts a 1D axis dependent array across another axis. :param array input_array: the 1D array used for broadcasting :param domain: the domain associated with that array :param axis: the axis ...
[ "def", "to_latlon", "(", "array", ",", "domain", ",", "axis", "=", "'lon'", ")", ":", "# if array is latitude dependent (has the same shape as lat)", "axis", ",", "array", ",", "depth", "=", "np", ".", "meshgrid", "(", "domain", ".", "axes", "[", "axis", "]",...
Broadcasts a 1D axis dependent array across another axis. :param array input_array: the 1D array used for broadcasting :param domain: the domain associated with that array :param axis: the axis that the input array will ...
[ "Broadcasts", "a", "1D", "axis", "dependent", "array", "across", "another", "axis", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/domain/field.py#L243-L281
train
brian-rose/climlab
climlab/domain/xarray.py
Field_to_xarray
def Field_to_xarray(field): '''Convert a climlab.Field object to xarray.DataArray''' dom = field.domain dims = []; dimlist = []; coords = {}; for axname in dom.axes: dimlist.append(axname) try: assert field.interfaces[dom.axis_index[axname]] bounds_name = axname +...
python
def Field_to_xarray(field): '''Convert a climlab.Field object to xarray.DataArray''' dom = field.domain dims = []; dimlist = []; coords = {}; for axname in dom.axes: dimlist.append(axname) try: assert field.interfaces[dom.axis_index[axname]] bounds_name = axname +...
[ "def", "Field_to_xarray", "(", "field", ")", ":", "dom", "=", "field", ".", "domain", "dims", "=", "[", "]", "dimlist", "=", "[", "]", "coords", "=", "{", "}", "for", "axname", "in", "dom", ".", "axes", ":", "dimlist", ".", "append", "(", "axname",...
Convert a climlab.Field object to xarray.DataArray
[ "Convert", "a", "climlab", ".", "Field", "object", "to", "xarray", ".", "DataArray" ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/domain/xarray.py#L8-L30
train
brian-rose/climlab
climlab/domain/xarray.py
state_to_xarray
def state_to_xarray(state): '''Convert a dictionary of climlab.Field objects to xarray.Dataset Input: dictionary of climlab.Field objects (e.g. process.state or process.diagnostics dictionary) Output: xarray.Dataset object with all spatial axes, including 'bounds' axes indicating cell boundaries i...
python
def state_to_xarray(state): '''Convert a dictionary of climlab.Field objects to xarray.Dataset Input: dictionary of climlab.Field objects (e.g. process.state or process.diagnostics dictionary) Output: xarray.Dataset object with all spatial axes, including 'bounds' axes indicating cell boundaries i...
[ "def", "state_to_xarray", "(", "state", ")", ":", "from", "climlab", ".", "domain", ".", "field", "import", "Field", "ds", "=", "Dataset", "(", ")", "for", "name", ",", "field", "in", "state", ".", "items", "(", ")", ":", "if", "isinstance", "(", "fi...
Convert a dictionary of climlab.Field objects to xarray.Dataset Input: dictionary of climlab.Field objects (e.g. process.state or process.diagnostics dictionary) Output: xarray.Dataset object with all spatial axes, including 'bounds' axes indicating cell boundaries in each spatial dimension. Any ...
[ "Convert", "a", "dictionary", "of", "climlab", ".", "Field", "objects", "to", "xarray", ".", "Dataset" ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/domain/xarray.py#L32-L60
train
brian-rose/climlab
climlab/domain/xarray.py
to_xarray
def to_xarray(input): '''Convert climlab input to xarray format. If input is a climlab.Field object, return xarray.DataArray If input is a dictionary (e.g. process.state or process.diagnostics), return xarray.Dataset object with all spatial axes, including 'bounds' axes indicating cell boundaries ...
python
def to_xarray(input): '''Convert climlab input to xarray format. If input is a climlab.Field object, return xarray.DataArray If input is a dictionary (e.g. process.state or process.diagnostics), return xarray.Dataset object with all spatial axes, including 'bounds' axes indicating cell boundaries ...
[ "def", "to_xarray", "(", "input", ")", ":", "from", "climlab", ".", "domain", ".", "field", "import", "Field", "if", "isinstance", "(", "input", ",", "Field", ")", ":", "return", "Field_to_xarray", "(", "input", ")", "elif", "isinstance", "(", "input", "...
Convert climlab input to xarray format. If input is a climlab.Field object, return xarray.DataArray If input is a dictionary (e.g. process.state or process.diagnostics), return xarray.Dataset object with all spatial axes, including 'bounds' axes indicating cell boundaries in each spatial dimension. ...
[ "Convert", "climlab", "input", "to", "xarray", "format", "." ]
eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6
https://github.com/brian-rose/climlab/blob/eae188a2ae9308229b8cbb8fe0b65f51b50ee1e6/climlab/domain/xarray.py#L62-L79
train
adamrehn/slidingwindow
slidingwindow/SlidingWindow.py
generate
def generate(data, dimOrder, maxWindowSize, overlapPercent, transforms = []): """ Generates a set of sliding windows for the specified dataset. """ # Determine the dimensions of the input data width = data.shape[dimOrder.index('w')] height = data.shape[dimOrder.index('h')] # Generate the windows return gene...
python
def generate(data, dimOrder, maxWindowSize, overlapPercent, transforms = []): """ Generates a set of sliding windows for the specified dataset. """ # Determine the dimensions of the input data width = data.shape[dimOrder.index('w')] height = data.shape[dimOrder.index('h')] # Generate the windows return gene...
[ "def", "generate", "(", "data", ",", "dimOrder", ",", "maxWindowSize", ",", "overlapPercent", ",", "transforms", "=", "[", "]", ")", ":", "# Determine the dimensions of the input data", "width", "=", "data", ".", "shape", "[", "dimOrder", ".", "index", "(", "'...
Generates a set of sliding windows for the specified dataset.
[ "Generates", "a", "set", "of", "sliding", "windows", "for", "the", "specified", "dataset", "." ]
17ea9395b48671e8cb7321b9510c6b25fec5e45f
https://github.com/adamrehn/slidingwindow/blob/17ea9395b48671e8cb7321b9510c6b25fec5e45f/slidingwindow/SlidingWindow.py#L87-L97
train
adamrehn/slidingwindow
slidingwindow/SlidingWindow.py
generateForSize
def generateForSize(width, height, dimOrder, maxWindowSize, overlapPercent, transforms = []): """ Generates a set of sliding windows for a dataset with the specified dimensions and order. """ # If the input data is smaller than the specified window size, # clip the window size to the input size on both dimension...
python
def generateForSize(width, height, dimOrder, maxWindowSize, overlapPercent, transforms = []): """ Generates a set of sliding windows for a dataset with the specified dimensions and order. """ # If the input data is smaller than the specified window size, # clip the window size to the input size on both dimension...
[ "def", "generateForSize", "(", "width", ",", "height", ",", "dimOrder", ",", "maxWindowSize", ",", "overlapPercent", ",", "transforms", "=", "[", "]", ")", ":", "# If the input data is smaller than the specified window size,", "# clip the window size to the input size on both...
Generates a set of sliding windows for a dataset with the specified dimensions and order.
[ "Generates", "a", "set", "of", "sliding", "windows", "for", "a", "dataset", "with", "the", "specified", "dimensions", "and", "order", "." ]
17ea9395b48671e8cb7321b9510c6b25fec5e45f
https://github.com/adamrehn/slidingwindow/blob/17ea9395b48671e8cb7321b9510c6b25fec5e45f/slidingwindow/SlidingWindow.py#L100-L143
train
adamrehn/slidingwindow
slidingwindow/SlidingWindow.py
SlidingWindow.apply
def apply(self, matrix): """ Slices the supplied matrix and applies any transform bound to this window """ view = matrix[ self.indices() ] return self.transform(view) if self.transform != None else view
python
def apply(self, matrix): """ Slices the supplied matrix and applies any transform bound to this window """ view = matrix[ self.indices() ] return self.transform(view) if self.transform != None else view
[ "def", "apply", "(", "self", ",", "matrix", ")", ":", "view", "=", "matrix", "[", "self", ".", "indices", "(", ")", "]", "return", "self", ".", "transform", "(", "view", ")", "if", "self", ".", "transform", "!=", "None", "else", "view" ]
Slices the supplied matrix and applies any transform bound to this window
[ "Slices", "the", "supplied", "matrix", "and", "applies", "any", "transform", "bound", "to", "this", "window" ]
17ea9395b48671e8cb7321b9510c6b25fec5e45f
https://github.com/adamrehn/slidingwindow/blob/17ea9395b48671e8cb7321b9510c6b25fec5e45f/slidingwindow/SlidingWindow.py#L27-L32
train
adamrehn/slidingwindow
slidingwindow/SlidingWindow.py
SlidingWindow.indices
def indices(self, includeChannel=True): """ Retrieves the indices for this window as a tuple of slices """ if self.dimOrder == DimOrder.HeightWidthChannel: # Equivalent to [self.y:self.y+self.h+1, self.x:self.x+self.w+1] return ( slice(self.y, self.y+self.h), slice(self.x, self.x+self.w) ) ...
python
def indices(self, includeChannel=True): """ Retrieves the indices for this window as a tuple of slices """ if self.dimOrder == DimOrder.HeightWidthChannel: # Equivalent to [self.y:self.y+self.h+1, self.x:self.x+self.w+1] return ( slice(self.y, self.y+self.h), slice(self.x, self.x+self.w) ) ...
[ "def", "indices", "(", "self", ",", "includeChannel", "=", "True", ")", ":", "if", "self", ".", "dimOrder", "==", "DimOrder", ".", "HeightWidthChannel", ":", "# Equivalent to [self.y:self.y+self.h+1, self.x:self.x+self.w+1]", "return", "(", "slice", "(", "self", "."...
Retrieves the indices for this window as a tuple of slices
[ "Retrieves", "the", "indices", "for", "this", "window", "as", "a", "tuple", "of", "slices" ]
17ea9395b48671e8cb7321b9510c6b25fec5e45f
https://github.com/adamrehn/slidingwindow/blob/17ea9395b48671e8cb7321b9510c6b25fec5e45f/slidingwindow/SlidingWindow.py#L46-L78
train
adamrehn/slidingwindow
slidingwindow/Batching.py
batchWindows
def batchWindows(windows, batchSize): """ Splits a list of windows into a series of batches. """ return np.array_split(np.array(windows), len(windows) // batchSize)
python
def batchWindows(windows, batchSize): """ Splits a list of windows into a series of batches. """ return np.array_split(np.array(windows), len(windows) // batchSize)
[ "def", "batchWindows", "(", "windows", ",", "batchSize", ")", ":", "return", "np", ".", "array_split", "(", "np", ".", "array", "(", "windows", ")", ",", "len", "(", "windows", ")", "//", "batchSize", ")" ]
Splits a list of windows into a series of batches.
[ "Splits", "a", "list", "of", "windows", "into", "a", "series", "of", "batches", "." ]
17ea9395b48671e8cb7321b9510c6b25fec5e45f
https://github.com/adamrehn/slidingwindow/blob/17ea9395b48671e8cb7321b9510c6b25fec5e45f/slidingwindow/Batching.py#L3-L7
train
adamrehn/slidingwindow
slidingwindow/WindowDistance.py
generateDistanceMatrix
def generateDistanceMatrix(width, height): """ Generates a matrix specifying the distance of each point in a window to its centre. """ # Determine the coordinates of the exact centre of the window originX = width / 2 originY = height / 2 # Generate the distance matrix distances = zerosFactory((height,width)...
python
def generateDistanceMatrix(width, height): """ Generates a matrix specifying the distance of each point in a window to its centre. """ # Determine the coordinates of the exact centre of the window originX = width / 2 originY = height / 2 # Generate the distance matrix distances = zerosFactory((height,width)...
[ "def", "generateDistanceMatrix", "(", "width", ",", "height", ")", ":", "# Determine the coordinates of the exact centre of the window", "originX", "=", "width", "/", "2", "originY", "=", "height", "/", "2", "# Generate the distance matrix", "distances", "=", "zerosFactor...
Generates a matrix specifying the distance of each point in a window to its centre.
[ "Generates", "a", "matrix", "specifying", "the", "distance", "of", "each", "point", "in", "a", "window", "to", "its", "centre", "." ]
17ea9395b48671e8cb7321b9510c6b25fec5e45f
https://github.com/adamrehn/slidingwindow/blob/17ea9395b48671e8cb7321b9510c6b25fec5e45f/slidingwindow/WindowDistance.py#L5-L20
train
adamrehn/slidingwindow
slidingwindow/ArrayUtils.py
_requiredSize
def _requiredSize(shape, dtype): """ Determines the number of bytes required to store a NumPy array with the specified shape and datatype. """ return math.floor(np.prod(np.asarray(shape, dtype=np.uint64)) * np.dtype(dtype).itemsize)
python
def _requiredSize(shape, dtype): """ Determines the number of bytes required to store a NumPy array with the specified shape and datatype. """ return math.floor(np.prod(np.asarray(shape, dtype=np.uint64)) * np.dtype(dtype).itemsize)
[ "def", "_requiredSize", "(", "shape", ",", "dtype", ")", ":", "return", "math", ".", "floor", "(", "np", ".", "prod", "(", "np", ".", "asarray", "(", "shape", ",", "dtype", "=", "np", ".", "uint64", ")", ")", "*", "np", ".", "dtype", "(", "dtype"...
Determines the number of bytes required to store a NumPy array with the specified shape and datatype.
[ "Determines", "the", "number", "of", "bytes", "required", "to", "store", "a", "NumPy", "array", "with", "the", "specified", "shape", "and", "datatype", "." ]
17ea9395b48671e8cb7321b9510c6b25fec5e45f
https://github.com/adamrehn/slidingwindow/blob/17ea9395b48671e8cb7321b9510c6b25fec5e45f/slidingwindow/ArrayUtils.py#L5-L10
train
adamrehn/slidingwindow
slidingwindow/ArrayUtils.py
arrayFactory
def arrayFactory(shape, dtype=float): """ Creates a new ndarray of the specified shape and datatype, storing it in memory if there is sufficient available space or else using a memory-mapped temporary file to provide the underlying buffer. """ # Determine the number of bytes required to store the array require...
python
def arrayFactory(shape, dtype=float): """ Creates a new ndarray of the specified shape and datatype, storing it in memory if there is sufficient available space or else using a memory-mapped temporary file to provide the underlying buffer. """ # Determine the number of bytes required to store the array require...
[ "def", "arrayFactory", "(", "shape", ",", "dtype", "=", "float", ")", ":", "# Determine the number of bytes required to store the array", "requiredBytes", "=", "_requiredSize", "(", "shape", ",", "dtype", ")", "# Determine if there is sufficient available memory", "vmem", "...
Creates a new ndarray of the specified shape and datatype, storing it in memory if there is sufficient available space or else using a memory-mapped temporary file to provide the underlying buffer.
[ "Creates", "a", "new", "ndarray", "of", "the", "specified", "shape", "and", "datatype", "storing", "it", "in", "memory", "if", "there", "is", "sufficient", "available", "space", "or", "else", "using", "a", "memory", "-", "mapped", "temporary", "file", "to", ...
17ea9395b48671e8cb7321b9510c6b25fec5e45f
https://github.com/adamrehn/slidingwindow/blob/17ea9395b48671e8cb7321b9510c6b25fec5e45f/slidingwindow/ArrayUtils.py#L40-L55
train
adamrehn/slidingwindow
slidingwindow/ArrayUtils.py
arrayCast
def arrayCast(source, dtype): """ Casts a NumPy array to the specified datatype, storing the copy in memory if there is sufficient available space or else using a memory-mapped temporary file to provide the underlying buffer. """ # Determine the number of bytes required to store the array requiredBytes = _requ...
python
def arrayCast(source, dtype): """ Casts a NumPy array to the specified datatype, storing the copy in memory if there is sufficient available space or else using a memory-mapped temporary file to provide the underlying buffer. """ # Determine the number of bytes required to store the array requiredBytes = _requ...
[ "def", "arrayCast", "(", "source", ",", "dtype", ")", ":", "# Determine the number of bytes required to store the array", "requiredBytes", "=", "_requiredSize", "(", "source", ".", "shape", ",", "dtype", ")", "# Determine if there is sufficient available memory", "vmem", "=...
Casts a NumPy array to the specified datatype, storing the copy in memory if there is sufficient available space or else using a memory-mapped temporary file to provide the underlying buffer.
[ "Casts", "a", "NumPy", "array", "to", "the", "specified", "datatype", "storing", "the", "copy", "in", "memory", "if", "there", "is", "sufficient", "available", "space", "or", "else", "using", "a", "memory", "-", "mapped", "temporary", "file", "to", "provide"...
17ea9395b48671e8cb7321b9510c6b25fec5e45f
https://github.com/adamrehn/slidingwindow/blob/17ea9395b48671e8cb7321b9510c6b25fec5e45f/slidingwindow/ArrayUtils.py#L67-L84
train
adamrehn/slidingwindow
slidingwindow/ArrayUtils.py
determineMaxWindowSize
def determineMaxWindowSize(dtype, limit=None): """ Determines the largest square window size that can be used, based on the specified datatype and amount of currently available system memory. If `limit` is specified, then this value will be returned in the event that it is smaller than the maximum computed size....
python
def determineMaxWindowSize(dtype, limit=None): """ Determines the largest square window size that can be used, based on the specified datatype and amount of currently available system memory. If `limit` is specified, then this value will be returned in the event that it is smaller than the maximum computed size....
[ "def", "determineMaxWindowSize", "(", "dtype", ",", "limit", "=", "None", ")", ":", "vmem", "=", "psutil", ".", "virtual_memory", "(", ")", "maxSize", "=", "math", ".", "floor", "(", "math", ".", "sqrt", "(", "vmem", ".", "available", "/", "np", ".", ...
Determines the largest square window size that can be used, based on the specified datatype and amount of currently available system memory. If `limit` is specified, then this value will be returned in the event that it is smaller than the maximum computed size.
[ "Determines", "the", "largest", "square", "window", "size", "that", "can", "be", "used", "based", "on", "the", "specified", "datatype", "and", "amount", "of", "currently", "available", "system", "memory", ".", "If", "limit", "is", "specified", "then", "this", ...
17ea9395b48671e8cb7321b9510c6b25fec5e45f
https://github.com/adamrehn/slidingwindow/blob/17ea9395b48671e8cb7321b9510c6b25fec5e45f/slidingwindow/ArrayUtils.py#L87-L100
train
kwikteam/phy
phy/cluster/views/base.py
ManualClusteringView.set_state
def set_state(self, state): """Set the view state. The passed object is the persisted `self.state` bunch. May be overriden. """ for k, v in state.items(): setattr(self, k, v)
python
def set_state(self, state): """Set the view state. The passed object is the persisted `self.state` bunch. May be overriden. """ for k, v in state.items(): setattr(self, k, v)
[ "def", "set_state", "(", "self", ",", "state", ")", ":", "for", "k", ",", "v", "in", "state", ".", "items", "(", ")", ":", "setattr", "(", "self", ",", "k", ",", "v", ")" ]
Set the view state. The passed object is the persisted `self.state` bunch. May be overriden.
[ "Set", "the", "view", "state", "." ]
7e9313dc364304b7d2bd03b92938347343703003
https://github.com/kwikteam/phy/blob/7e9313dc364304b7d2bd03b92938347343703003/phy/cluster/views/base.py#L128-L137
train
kwikteam/phy
phy/utils/_misc.py
_fullname
def _fullname(o): """Return the fully-qualified name of a function.""" return o.__module__ + "." + o.__name__ if o.__module__ else o.__name__
python
def _fullname(o): """Return the fully-qualified name of a function.""" return o.__module__ + "." + o.__name__ if o.__module__ else o.__name__
[ "def", "_fullname", "(", "o", ")", ":", "return", "o", ".", "__module__", "+", "\".\"", "+", "o", ".", "__name__", "if", "o", ".", "__module__", "else", "o", ".", "__name__" ]
Return the fully-qualified name of a function.
[ "Return", "the", "fully", "-", "qualified", "name", "of", "a", "function", "." ]
7e9313dc364304b7d2bd03b92938347343703003
https://github.com/kwikteam/phy/blob/7e9313dc364304b7d2bd03b92938347343703003/phy/utils/_misc.py#L123-L125
train
kwikteam/phy
phy/cluster/views/feature.py
FeatureView._get_axis_label
def _get_axis_label(self, dim): """Return the channel id from a dimension, if applicable.""" if u(dim[:-1]).isdecimal(): n = len(self.channel_ids) return str(self.channel_ids[int(dim[:-1]) % n]) + dim[-1] else: return dim
python
def _get_axis_label(self, dim): """Return the channel id from a dimension, if applicable.""" if u(dim[:-1]).isdecimal(): n = len(self.channel_ids) return str(self.channel_ids[int(dim[:-1]) % n]) + dim[-1] else: return dim
[ "def", "_get_axis_label", "(", "self", ",", "dim", ")", ":", "if", "u", "(", "dim", "[", ":", "-", "1", "]", ")", ".", "isdecimal", "(", ")", ":", "n", "=", "len", "(", "self", ".", "channel_ids", ")", "return", "str", "(", "self", ".", "channe...
Return the channel id from a dimension, if applicable.
[ "Return", "the", "channel", "id", "from", "a", "dimension", "if", "applicable", "." ]
7e9313dc364304b7d2bd03b92938347343703003
https://github.com/kwikteam/phy/blob/7e9313dc364304b7d2bd03b92938347343703003/phy/cluster/views/feature.py#L132-L138
train
kwikteam/phy
phy/cluster/views/feature.py
FeatureView._get_axis_data
def _get_axis_data(self, bunch, dim, cluster_id=None, load_all=None): """Extract the points from the data on a given dimension. bunch is returned by the features() function. dim is the string specifying the dimensions to extract for the data. """ if dim in self.attributes: ...
python
def _get_axis_data(self, bunch, dim, cluster_id=None, load_all=None): """Extract the points from the data on a given dimension. bunch is returned by the features() function. dim is the string specifying the dimensions to extract for the data. """ if dim in self.attributes: ...
[ "def", "_get_axis_data", "(", "self", ",", "bunch", ",", "dim", ",", "cluster_id", "=", "None", ",", "load_all", "=", "None", ")", ":", "if", "dim", "in", "self", ".", "attributes", ":", "return", "self", ".", "attributes", "[", "dim", "]", "(", "clu...
Extract the points from the data on a given dimension. bunch is returned by the features() function. dim is the string specifying the dimensions to extract for the data.
[ "Extract", "the", "points", "from", "the", "data", "on", "a", "given", "dimension", "." ]
7e9313dc364304b7d2bd03b92938347343703003
https://github.com/kwikteam/phy/blob/7e9313dc364304b7d2bd03b92938347343703003/phy/cluster/views/feature.py#L140-L167
train
kwikteam/phy
phy/cluster/views/feature.py
FeatureView._plot_labels
def _plot_labels(self): """Plot feature labels along left and bottom edge of subplots""" # iterate simultaneously over kth row in left column and # kth column in bottom row: br = self.n_cols - 1 # bottom row for k in range(0, self.n_cols): dim_x, _ = self.grid_dim[0]...
python
def _plot_labels(self): """Plot feature labels along left and bottom edge of subplots""" # iterate simultaneously over kth row in left column and # kth column in bottom row: br = self.n_cols - 1 # bottom row for k in range(0, self.n_cols): dim_x, _ = self.grid_dim[0]...
[ "def", "_plot_labels", "(", "self", ")", ":", "# iterate simultaneously over kth row in left column and", "# kth column in bottom row:", "br", "=", "self", ".", "n_cols", "-", "1", "# bottom row", "for", "k", "in", "range", "(", "0", ",", "self", ".", "n_cols", ")...
Plot feature labels along left and bottom edge of subplots
[ "Plot", "feature", "labels", "along", "left", "and", "bottom", "edge", "of", "subplots" ]
7e9313dc364304b7d2bd03b92938347343703003
https://github.com/kwikteam/phy/blob/7e9313dc364304b7d2bd03b92938347343703003/phy/cluster/views/feature.py#L199-L223
train
kwikteam/phy
phy/cluster/views/feature.py
FeatureView.on_channel_click
def on_channel_click(self, channel_id=None, key=None, button=None): """Respond to the click on a channel.""" channels = self.channel_ids if channels is None: return if len(channels) == 1: self.on_select() return assert len(channels) >= 2 ...
python
def on_channel_click(self, channel_id=None, key=None, button=None): """Respond to the click on a channel.""" channels = self.channel_ids if channels is None: return if len(channels) == 1: self.on_select() return assert len(channels) >= 2 ...
[ "def", "on_channel_click", "(", "self", ",", "channel_id", "=", "None", ",", "key", "=", "None", ",", "button", "=", "None", ")", ":", "channels", "=", "self", ".", "channel_ids", "if", "channels", "is", "None", ":", "return", "if", "len", "(", "channe...
Respond to the click on a channel.
[ "Respond", "to", "the", "click", "on", "a", "channel", "." ]
7e9313dc364304b7d2bd03b92938347343703003
https://github.com/kwikteam/phy/blob/7e9313dc364304b7d2bd03b92938347343703003/phy/cluster/views/feature.py#L317-L344
train
kwikteam/phy
phy/cluster/views/feature.py
FeatureView.on_request_split
def on_request_split(self): """Return the spikes enclosed by the lasso.""" if (self.lasso.count < 3 or not len(self.cluster_ids)): # pragma: no cover return np.array([], dtype=np.int64) assert len(self.channel_ids) # Get the dimensions of the lassoed subplot...
python
def on_request_split(self): """Return the spikes enclosed by the lasso.""" if (self.lasso.count < 3 or not len(self.cluster_ids)): # pragma: no cover return np.array([], dtype=np.int64) assert len(self.channel_ids) # Get the dimensions of the lassoed subplot...
[ "def", "on_request_split", "(", "self", ")", ":", "if", "(", "self", ".", "lasso", ".", "count", "<", "3", "or", "not", "len", "(", "self", ".", "cluster_ids", ")", ")", ":", "# pragma: no cover", "return", "np", ".", "array", "(", "[", "]", ",", "...
Return the spikes enclosed by the lasso.
[ "Return", "the", "spikes", "enclosed", "by", "the", "lasso", "." ]
7e9313dc364304b7d2bd03b92938347343703003
https://github.com/kwikteam/phy/blob/7e9313dc364304b7d2bd03b92938347343703003/phy/cluster/views/feature.py#L346-L387
train
kwikteam/phy
phy/plot/interact.py
Boxed.get_closest_box
def get_closest_box(self, pos): """Get the box closest to some position.""" pos = np.atleast_2d(pos) d = np.sum((np.array(self.box_pos) - pos) ** 2, axis=1) idx = np.argmin(d) return idx
python
def get_closest_box(self, pos): """Get the box closest to some position.""" pos = np.atleast_2d(pos) d = np.sum((np.array(self.box_pos) - pos) ** 2, axis=1) idx = np.argmin(d) return idx
[ "def", "get_closest_box", "(", "self", ",", "pos", ")", ":", "pos", "=", "np", ".", "atleast_2d", "(", "pos", ")", "d", "=", "np", ".", "sum", "(", "(", "np", ".", "array", "(", "self", ".", "box_pos", ")", "-", "pos", ")", "**", "2", ",", "a...
Get the box closest to some position.
[ "Get", "the", "box", "closest", "to", "some", "position", "." ]
7e9313dc364304b7d2bd03b92938347343703003
https://github.com/kwikteam/phy/blob/7e9313dc364304b7d2bd03b92938347343703003/phy/plot/interact.py#L259-L264
train
kwikteam/phy
phy/plot/interact.py
Boxed.update_boxes
def update_boxes(self, box_pos, box_size): """Set the box bounds from specified box positions and sizes.""" assert box_pos.shape == (self.n_boxes, 2) assert len(box_size) == 2 self.box_bounds = _get_boxes(box_pos, size=box_size, ...
python
def update_boxes(self, box_pos, box_size): """Set the box bounds from specified box positions and sizes.""" assert box_pos.shape == (self.n_boxes, 2) assert len(box_size) == 2 self.box_bounds = _get_boxes(box_pos, size=box_size, ...
[ "def", "update_boxes", "(", "self", ",", "box_pos", ",", "box_size", ")", ":", "assert", "box_pos", ".", "shape", "==", "(", "self", ".", "n_boxes", ",", "2", ")", "assert", "len", "(", "box_size", ")", "==", "2", "self", ".", "box_bounds", "=", "_ge...
Set the box bounds from specified box positions and sizes.
[ "Set", "the", "box", "bounds", "from", "specified", "box", "positions", "and", "sizes", "." ]
7e9313dc364304b7d2bd03b92938347343703003
https://github.com/kwikteam/phy/blob/7e9313dc364304b7d2bd03b92938347343703003/phy/plot/interact.py#L266-L273
train
kwikteam/phy
phy/gui/qt.py
require_qt
def require_qt(func): """Specify that a function requires a Qt application. Use this decorator to specify that a function needs a running Qt application before it can run. An error is raised if that is not the case. """ @wraps(func) def wrapped(*args, **kwargs): if not QApplication...
python
def require_qt(func): """Specify that a function requires a Qt application. Use this decorator to specify that a function needs a running Qt application before it can run. An error is raised if that is not the case. """ @wraps(func) def wrapped(*args, **kwargs): if not QApplication...
[ "def", "require_qt", "(", "func", ")", ":", "@", "wraps", "(", "func", ")", "def", "wrapped", "(", "*", "args", ",", "*", "*", "kwargs", ")", ":", "if", "not", "QApplication", ".", "instance", "(", ")", ":", "# pragma: no cover", "raise", "RuntimeError...
Specify that a function requires a Qt application. Use this decorator to specify that a function needs a running Qt application before it can run. An error is raised if that is not the case.
[ "Specify", "that", "a", "function", "requires", "a", "Qt", "application", "." ]
7e9313dc364304b7d2bd03b92938347343703003
https://github.com/kwikteam/phy/blob/7e9313dc364304b7d2bd03b92938347343703003/phy/gui/qt.py#L103-L116
train
kwikteam/phy
phy/gui/qt.py
create_app
def create_app(): """Create a Qt application.""" global QT_APP QT_APP = QApplication.instance() if QT_APP is None: # pragma: no cover QT_APP = QApplication(sys.argv) return QT_APP
python
def create_app(): """Create a Qt application.""" global QT_APP QT_APP = QApplication.instance() if QT_APP is None: # pragma: no cover QT_APP = QApplication(sys.argv) return QT_APP
[ "def", "create_app", "(", ")", ":", "global", "QT_APP", "QT_APP", "=", "QApplication", ".", "instance", "(", ")", "if", "QT_APP", "is", "None", ":", "# pragma: no cover", "QT_APP", "=", "QApplication", "(", "sys", ".", "argv", ")", "return", "QT_APP" ]
Create a Qt application.
[ "Create", "a", "Qt", "application", "." ]
7e9313dc364304b7d2bd03b92938347343703003
https://github.com/kwikteam/phy/blob/7e9313dc364304b7d2bd03b92938347343703003/phy/gui/qt.py#L123-L129
train
kwikteam/phy
phy/gui/qt.py
AsyncCaller.set
def set(self, f): """Call a function after a delay, unless another function is set in the meantime.""" self.stop() self._create_timer(f) self.start()
python
def set(self, f): """Call a function after a delay, unless another function is set in the meantime.""" self.stop() self._create_timer(f) self.start()
[ "def", "set", "(", "self", ",", "f", ")", ":", "self", ".", "stop", "(", ")", "self", ".", "_create_timer", "(", "f", ")", "self", ".", "start", "(", ")" ]
Call a function after a delay, unless another function is set in the meantime.
[ "Call", "a", "function", "after", "a", "delay", "unless", "another", "function", "is", "set", "in", "the", "meantime", "." ]
7e9313dc364304b7d2bd03b92938347343703003
https://github.com/kwikteam/phy/blob/7e9313dc364304b7d2bd03b92938347343703003/phy/gui/qt.py#L150-L155
train
kwikteam/phy
phy/gui/qt.py
AsyncCaller.stop
def stop(self): """Stop the current timer if there is one and cancel the async call.""" if self._timer: self._timer.stop() self._timer.deleteLater()
python
def stop(self): """Stop the current timer if there is one and cancel the async call.""" if self._timer: self._timer.stop() self._timer.deleteLater()
[ "def", "stop", "(", "self", ")", ":", "if", "self", ".", "_timer", ":", "self", ".", "_timer", ".", "stop", "(", ")", "self", ".", "_timer", ".", "deleteLater", "(", ")" ]
Stop the current timer if there is one and cancel the async call.
[ "Stop", "the", "current", "timer", "if", "there", "is", "one", "and", "cancel", "the", "async", "call", "." ]
7e9313dc364304b7d2bd03b92938347343703003
https://github.com/kwikteam/phy/blob/7e9313dc364304b7d2bd03b92938347343703003/phy/gui/qt.py#L162-L166
train
kwikteam/phy
phy/gui/actions.py
_wrap_callback_args
def _wrap_callback_args(f, docstring=None): # pragma: no cover """Display a Qt dialog when a function has arguments. The user can write function arguments as if it was a snippet. """ def wrapped(checked, *args): if args: return f(*args) if isinstance(f, partial): ...
python
def _wrap_callback_args(f, docstring=None): # pragma: no cover """Display a Qt dialog when a function has arguments. The user can write function arguments as if it was a snippet. """ def wrapped(checked, *args): if args: return f(*args) if isinstance(f, partial): ...
[ "def", "_wrap_callback_args", "(", "f", ",", "docstring", "=", "None", ")", ":", "# pragma: no cover", "def", "wrapped", "(", "checked", ",", "*", "args", ")", ":", "if", "args", ":", "return", "f", "(", "*", "args", ")", "if", "isinstance", "(", "f", ...
Display a Qt dialog when a function has arguments. The user can write function arguments as if it was a snippet.
[ "Display", "a", "Qt", "dialog", "when", "a", "function", "has", "arguments", "." ]
7e9313dc364304b7d2bd03b92938347343703003
https://github.com/kwikteam/phy/blob/7e9313dc364304b7d2bd03b92938347343703003/phy/gui/actions.py#L60-L99
train
kwikteam/phy
phy/gui/actions.py
_get_shortcut_string
def _get_shortcut_string(shortcut): """Return a string representation of a shortcut.""" if shortcut is None: return '' if isinstance(shortcut, (tuple, list)): return ', '.join([_get_shortcut_string(s) for s in shortcut]) if isinstance(shortcut, string_types): if hasattr(QKeySeque...
python
def _get_shortcut_string(shortcut): """Return a string representation of a shortcut.""" if shortcut is None: return '' if isinstance(shortcut, (tuple, list)): return ', '.join([_get_shortcut_string(s) for s in shortcut]) if isinstance(shortcut, string_types): if hasattr(QKeySeque...
[ "def", "_get_shortcut_string", "(", "shortcut", ")", ":", "if", "shortcut", "is", "None", ":", "return", "''", "if", "isinstance", "(", "shortcut", ",", "(", "tuple", ",", "list", ")", ")", ":", "return", "', '", ".", "join", "(", "[", "_get_shortcut_str...
Return a string representation of a shortcut.
[ "Return", "a", "string", "representation", "of", "a", "shortcut", "." ]
7e9313dc364304b7d2bd03b92938347343703003
https://github.com/kwikteam/phy/blob/7e9313dc364304b7d2bd03b92938347343703003/phy/gui/actions.py#L106-L119
train
kwikteam/phy
phy/gui/actions.py
_get_qkeysequence
def _get_qkeysequence(shortcut): """Return a QKeySequence or list of QKeySequence from a shortcut string.""" if shortcut is None: return [] if isinstance(shortcut, (tuple, list)): return [_get_qkeysequence(s) for s in shortcut] assert isinstance(shortcut, string_types) if hasattr(QKe...
python
def _get_qkeysequence(shortcut): """Return a QKeySequence or list of QKeySequence from a shortcut string.""" if shortcut is None: return [] if isinstance(shortcut, (tuple, list)): return [_get_qkeysequence(s) for s in shortcut] assert isinstance(shortcut, string_types) if hasattr(QKe...
[ "def", "_get_qkeysequence", "(", "shortcut", ")", ":", "if", "shortcut", "is", "None", ":", "return", "[", "]", "if", "isinstance", "(", "shortcut", ",", "(", "tuple", ",", "list", ")", ")", ":", "return", "[", "_get_qkeysequence", "(", "s", ")", "for"...
Return a QKeySequence or list of QKeySequence from a shortcut string.
[ "Return", "a", "QKeySequence", "or", "list", "of", "QKeySequence", "from", "a", "shortcut", "string", "." ]
7e9313dc364304b7d2bd03b92938347343703003
https://github.com/kwikteam/phy/blob/7e9313dc364304b7d2bd03b92938347343703003/phy/gui/actions.py#L122-L133
train
kwikteam/phy
phy/gui/actions.py
_show_shortcuts
def _show_shortcuts(shortcuts, name=None): """Display shortcuts.""" name = name or '' print('') if name: name = ' for ' + name print('Keyboard shortcuts' + name) for name in sorted(shortcuts): shortcut = _get_shortcut_string(shortcuts[name]) if not name.startswith('_'): ...
python
def _show_shortcuts(shortcuts, name=None): """Display shortcuts.""" name = name or '' print('') if name: name = ' for ' + name print('Keyboard shortcuts' + name) for name in sorted(shortcuts): shortcut = _get_shortcut_string(shortcuts[name]) if not name.startswith('_'): ...
[ "def", "_show_shortcuts", "(", "shortcuts", ",", "name", "=", "None", ")", ":", "name", "=", "name", "or", "''", "print", "(", "''", ")", "if", "name", ":", "name", "=", "' for '", "+", "name", "print", "(", "'Keyboard shortcuts'", "+", "name", ")", ...
Display shortcuts.
[ "Display", "shortcuts", "." ]
7e9313dc364304b7d2bd03b92938347343703003
https://github.com/kwikteam/phy/blob/7e9313dc364304b7d2bd03b92938347343703003/phy/gui/actions.py#L136-L146
train
kwikteam/phy
phy/gui/actions.py
Actions.add
def add(self, callback=None, name=None, shortcut=None, alias=None, docstring=None, menu=None, verbose=True): """Add an action with a keyboard shortcut.""" if callback is None: # Allow to use either add(func) or @add or @add(...). return partial(self.add, name=name, sh...
python
def add(self, callback=None, name=None, shortcut=None, alias=None, docstring=None, menu=None, verbose=True): """Add an action with a keyboard shortcut.""" if callback is None: # Allow to use either add(func) or @add or @add(...). return partial(self.add, name=name, sh...
[ "def", "add", "(", "self", ",", "callback", "=", "None", ",", "name", "=", "None", ",", "shortcut", "=", "None", ",", "alias", "=", "None", ",", "docstring", "=", "None", ",", "menu", "=", "None", ",", "verbose", "=", "True", ")", ":", "if", "cal...
Add an action with a keyboard shortcut.
[ "Add", "an", "action", "with", "a", "keyboard", "shortcut", "." ]
7e9313dc364304b7d2bd03b92938347343703003
https://github.com/kwikteam/phy/blob/7e9313dc364304b7d2bd03b92938347343703003/phy/gui/actions.py#L200-L246
train
kwikteam/phy
phy/gui/actions.py
Actions.separator
def separator(self, menu=None): """Add a separator""" self.gui.get_menu(menu or self.menu).addSeparator()
python
def separator(self, menu=None): """Add a separator""" self.gui.get_menu(menu or self.menu).addSeparator()
[ "def", "separator", "(", "self", ",", "menu", "=", "None", ")", ":", "self", ".", "gui", ".", "get_menu", "(", "menu", "or", "self", ".", "menu", ")", ".", "addSeparator", "(", ")" ]
Add a separator
[ "Add", "a", "separator" ]
7e9313dc364304b7d2bd03b92938347343703003
https://github.com/kwikteam/phy/blob/7e9313dc364304b7d2bd03b92938347343703003/phy/gui/actions.py#L248-L250
train
kwikteam/phy
phy/gui/actions.py
Actions.disable
def disable(self, name=None): """Disable one or all actions.""" if name is None: for name in self._actions_dict: self.disable(name) return self._actions_dict[name].qaction.setEnabled(False)
python
def disable(self, name=None): """Disable one or all actions.""" if name is None: for name in self._actions_dict: self.disable(name) return self._actions_dict[name].qaction.setEnabled(False)
[ "def", "disable", "(", "self", ",", "name", "=", "None", ")", ":", "if", "name", "is", "None", ":", "for", "name", "in", "self", ".", "_actions_dict", ":", "self", ".", "disable", "(", "name", ")", "return", "self", ".", "_actions_dict", "[", "name",...
Disable one or all actions.
[ "Disable", "one", "or", "all", "actions", "." ]
7e9313dc364304b7d2bd03b92938347343703003
https://github.com/kwikteam/phy/blob/7e9313dc364304b7d2bd03b92938347343703003/phy/gui/actions.py#L252-L258
train
kwikteam/phy
phy/gui/actions.py
Actions.enable
def enable(self, name=None): """Enable one or all actions.""" if name is None: for name in self._actions_dict: self.enable(name) return self._actions_dict[name].qaction.setEnabled(True)
python
def enable(self, name=None): """Enable one or all actions.""" if name is None: for name in self._actions_dict: self.enable(name) return self._actions_dict[name].qaction.setEnabled(True)
[ "def", "enable", "(", "self", ",", "name", "=", "None", ")", ":", "if", "name", "is", "None", ":", "for", "name", "in", "self", ".", "_actions_dict", ":", "self", ".", "enable", "(", "name", ")", "return", "self", ".", "_actions_dict", "[", "name", ...
Enable one or all actions.
[ "Enable", "one", "or", "all", "actions", "." ]
7e9313dc364304b7d2bd03b92938347343703003
https://github.com/kwikteam/phy/blob/7e9313dc364304b7d2bd03b92938347343703003/phy/gui/actions.py#L260-L266
train
kwikteam/phy
phy/gui/actions.py
Actions.run
def run(self, name, *args): """Run an action as specified by its name.""" assert isinstance(name, string_types) # Resolve the alias if it is an alias. name = self._aliases.get(name, name) # Get the action. action = self._actions_dict.get(name, None) if not action:...
python
def run(self, name, *args): """Run an action as specified by its name.""" assert isinstance(name, string_types) # Resolve the alias if it is an alias. name = self._aliases.get(name, name) # Get the action. action = self._actions_dict.get(name, None) if not action:...
[ "def", "run", "(", "self", ",", "name", ",", "*", "args", ")", ":", "assert", "isinstance", "(", "name", ",", "string_types", ")", "# Resolve the alias if it is an alias.", "name", "=", "self", ".", "_aliases", ".", "get", "(", "name", ",", "name", ")", ...
Run an action as specified by its name.
[ "Run", "an", "action", "as", "specified", "by", "its", "name", "." ]
7e9313dc364304b7d2bd03b92938347343703003
https://github.com/kwikteam/phy/blob/7e9313dc364304b7d2bd03b92938347343703003/phy/gui/actions.py#L272-L283
train
kwikteam/phy
phy/gui/actions.py
Actions.remove
def remove(self, name): """Remove an action.""" self.gui.removeAction(self._actions_dict[name].qaction) del self._actions_dict[name] delattr(self, name)
python
def remove(self, name): """Remove an action.""" self.gui.removeAction(self._actions_dict[name].qaction) del self._actions_dict[name] delattr(self, name)
[ "def", "remove", "(", "self", ",", "name", ")", ":", "self", ".", "gui", ".", "removeAction", "(", "self", ".", "_actions_dict", "[", "name", "]", ".", "qaction", ")", "del", "self", ".", "_actions_dict", "[", "name", "]", "delattr", "(", "self", ","...
Remove an action.
[ "Remove", "an", "action", "." ]
7e9313dc364304b7d2bd03b92938347343703003
https://github.com/kwikteam/phy/blob/7e9313dc364304b7d2bd03b92938347343703003/phy/gui/actions.py#L285-L289
train
kwikteam/phy
phy/gui/actions.py
Actions.remove_all
def remove_all(self): """Remove all actions.""" names = sorted(self._actions_dict.keys()) for name in names: self.remove(name)
python
def remove_all(self): """Remove all actions.""" names = sorted(self._actions_dict.keys()) for name in names: self.remove(name)
[ "def", "remove_all", "(", "self", ")", ":", "names", "=", "sorted", "(", "self", ".", "_actions_dict", ".", "keys", "(", ")", ")", "for", "name", "in", "names", ":", "self", ".", "remove", "(", "name", ")" ]
Remove all actions.
[ "Remove", "all", "actions", "." ]
7e9313dc364304b7d2bd03b92938347343703003
https://github.com/kwikteam/phy/blob/7e9313dc364304b7d2bd03b92938347343703003/phy/gui/actions.py#L291-L295
train
kwikteam/phy
phy/gui/actions.py
Actions.shortcuts
def shortcuts(self): """A dictionary of action shortcuts.""" return {name: action.shortcut for name, action in self._actions_dict.items()}
python
def shortcuts(self): """A dictionary of action shortcuts.""" return {name: action.shortcut for name, action in self._actions_dict.items()}
[ "def", "shortcuts", "(", "self", ")", ":", "return", "{", "name", ":", "action", ".", "shortcut", "for", "name", ",", "action", "in", "self", ".", "_actions_dict", ".", "items", "(", ")", "}" ]
A dictionary of action shortcuts.
[ "A", "dictionary", "of", "action", "shortcuts", "." ]
7e9313dc364304b7d2bd03b92938347343703003
https://github.com/kwikteam/phy/blob/7e9313dc364304b7d2bd03b92938347343703003/phy/gui/actions.py#L298-L301
train
kwikteam/phy
phy/gui/actions.py
Actions.show_shortcuts
def show_shortcuts(self): """Print all shortcuts.""" gui_name = self.gui.name actions_name = self.name name = ('{} - {}'.format(gui_name, actions_name) if actions_name else gui_name) _show_shortcuts(self.shortcuts, name)
python
def show_shortcuts(self): """Print all shortcuts.""" gui_name = self.gui.name actions_name = self.name name = ('{} - {}'.format(gui_name, actions_name) if actions_name else gui_name) _show_shortcuts(self.shortcuts, name)
[ "def", "show_shortcuts", "(", "self", ")", ":", "gui_name", "=", "self", ".", "gui", ".", "name", "actions_name", "=", "self", ".", "name", "name", "=", "(", "'{} - {}'", ".", "format", "(", "gui_name", ",", "actions_name", ")", "if", "actions_name", "el...
Print all shortcuts.
[ "Print", "all", "shortcuts", "." ]
7e9313dc364304b7d2bd03b92938347343703003
https://github.com/kwikteam/phy/blob/7e9313dc364304b7d2bd03b92938347343703003/phy/gui/actions.py#L303-L309
train
kwikteam/phy
phy/gui/actions.py
Snippets.command
def command(self): """This is used to write a snippet message in the status bar. A cursor is appended at the end. """ msg = self.gui.status_message n = len(msg) n_cur = len(self.cursor) return msg[:n - n_cur]
python
def command(self): """This is used to write a snippet message in the status bar. A cursor is appended at the end. """ msg = self.gui.status_message n = len(msg) n_cur = len(self.cursor) return msg[:n - n_cur]
[ "def", "command", "(", "self", ")", ":", "msg", "=", "self", ".", "gui", ".", "status_message", "n", "=", "len", "(", "msg", ")", "n_cur", "=", "len", "(", "self", ".", "cursor", ")", "return", "msg", "[", ":", "n", "-", "n_cur", "]" ]
This is used to write a snippet message in the status bar. A cursor is appended at the end.
[ "This", "is", "used", "to", "write", "a", "snippet", "message", "in", "the", "status", "bar", "." ]
7e9313dc364304b7d2bd03b92938347343703003
https://github.com/kwikteam/phy/blob/7e9313dc364304b7d2bd03b92938347343703003/phy/gui/actions.py#L372-L381
train
kwikteam/phy
phy/gui/actions.py
Snippets._backspace
def _backspace(self): """Erase the last character in the snippet command.""" if self.command == ':': return logger.log(5, "Snippet keystroke `Backspace`.") self.command = self.command[:-1]
python
def _backspace(self): """Erase the last character in the snippet command.""" if self.command == ':': return logger.log(5, "Snippet keystroke `Backspace`.") self.command = self.command[:-1]
[ "def", "_backspace", "(", "self", ")", ":", "if", "self", ".", "command", "==", "':'", ":", "return", "logger", ".", "log", "(", "5", ",", "\"Snippet keystroke `Backspace`.\"", ")", "self", ".", "command", "=", "self", ".", "command", "[", ":", "-", "1...
Erase the last character in the snippet command.
[ "Erase", "the", "last", "character", "in", "the", "snippet", "command", "." ]
7e9313dc364304b7d2bd03b92938347343703003
https://github.com/kwikteam/phy/blob/7e9313dc364304b7d2bd03b92938347343703003/phy/gui/actions.py#L390-L395
train
kwikteam/phy
phy/gui/actions.py
Snippets._enter
def _enter(self): """Disable the snippet mode and execute the command.""" command = self.command logger.log(5, "Snippet keystroke `Enter`.") # NOTE: we need to set back the actions (mode_off) before running # the command. self.mode_off() self.run(command)
python
def _enter(self): """Disable the snippet mode and execute the command.""" command = self.command logger.log(5, "Snippet keystroke `Enter`.") # NOTE: we need to set back the actions (mode_off) before running # the command. self.mode_off() self.run(command)
[ "def", "_enter", "(", "self", ")", ":", "command", "=", "self", ".", "command", "logger", ".", "log", "(", "5", ",", "\"Snippet keystroke `Enter`.\"", ")", "# NOTE: we need to set back the actions (mode_off) before running", "# the command.", "self", ".", "mode_off", ...
Disable the snippet mode and execute the command.
[ "Disable", "the", "snippet", "mode", "and", "execute", "the", "command", "." ]
7e9313dc364304b7d2bd03b92938347343703003
https://github.com/kwikteam/phy/blob/7e9313dc364304b7d2bd03b92938347343703003/phy/gui/actions.py#L397-L404
train
kwikteam/phy
phy/gui/actions.py
Snippets._create_snippet_actions
def _create_snippet_actions(self): """Add mock Qt actions for snippet keystrokes. Used to enable snippet mode. """ # One action per allowed character. for i, char in enumerate(self._snippet_chars): def _make_func(char): def callback(): ...
python
def _create_snippet_actions(self): """Add mock Qt actions for snippet keystrokes. Used to enable snippet mode. """ # One action per allowed character. for i, char in enumerate(self._snippet_chars): def _make_func(char): def callback(): ...
[ "def", "_create_snippet_actions", "(", "self", ")", ":", "# One action per allowed character.", "for", "i", ",", "char", "in", "enumerate", "(", "self", ".", "_snippet_chars", ")", ":", "def", "_make_func", "(", "char", ")", ":", "def", "callback", "(", ")", ...
Add mock Qt actions for snippet keystrokes. Used to enable snippet mode.
[ "Add", "mock", "Qt", "actions", "for", "snippet", "keystrokes", "." ]
7e9313dc364304b7d2bd03b92938347343703003
https://github.com/kwikteam/phy/blob/7e9313dc364304b7d2bd03b92938347343703003/phy/gui/actions.py#L406-L433
train
kwikteam/phy
phy/gui/actions.py
Snippets.run
def run(self, snippet): """Executes a snippet command. May be overridden. """ assert snippet[0] == ':' snippet = snippet[1:] snippet_args = _parse_snippet(snippet) name = snippet_args[0] logger.info("Processing snippet `%s`.", snippet) try: ...
python
def run(self, snippet): """Executes a snippet command. May be overridden. """ assert snippet[0] == ':' snippet = snippet[1:] snippet_args = _parse_snippet(snippet) name = snippet_args[0] logger.info("Processing snippet `%s`.", snippet) try: ...
[ "def", "run", "(", "self", ",", "snippet", ")", ":", "assert", "snippet", "[", "0", "]", "==", "':'", "snippet", "=", "snippet", "[", "1", ":", "]", "snippet_args", "=", "_parse_snippet", "(", "snippet", ")", "name", "=", "snippet_args", "[", "0", "]...
Executes a snippet command. May be overridden.
[ "Executes", "a", "snippet", "command", "." ]
7e9313dc364304b7d2bd03b92938347343703003
https://github.com/kwikteam/phy/blob/7e9313dc364304b7d2bd03b92938347343703003/phy/gui/actions.py#L435-L460
train
kwikteam/phy
phy/traces/waveform.py
_before_after
def _before_after(n_samples): """Get the number of samples before and after.""" if not isinstance(n_samples, (tuple, list)): before = n_samples // 2 after = n_samples - before else: assert len(n_samples) == 2 before, after = n_samples n_samples = before + after as...
python
def _before_after(n_samples): """Get the number of samples before and after.""" if not isinstance(n_samples, (tuple, list)): before = n_samples // 2 after = n_samples - before else: assert len(n_samples) == 2 before, after = n_samples n_samples = before + after as...
[ "def", "_before_after", "(", "n_samples", ")", ":", "if", "not", "isinstance", "(", "n_samples", ",", "(", "tuple", ",", "list", ")", ")", ":", "before", "=", "n_samples", "//", "2", "after", "=", "n_samples", "-", "before", "else", ":", "assert", "len...
Get the number of samples before and after.
[ "Get", "the", "number", "of", "samples", "before", "and", "after", "." ]
7e9313dc364304b7d2bd03b92938347343703003
https://github.com/kwikteam/phy/blob/7e9313dc364304b7d2bd03b92938347343703003/phy/traces/waveform.py#L149-L161
train
kwikteam/phy
phy/traces/waveform.py
_slice
def _slice(index, n_samples, margin=None): """Return a waveform slice.""" if margin is None: margin = (0, 0) assert isinstance(n_samples, (tuple, list)) assert len(n_samples) == 2 before, after = n_samples assert isinstance(margin, (tuple, list)) assert len(margin) == 2 margin_be...
python
def _slice(index, n_samples, margin=None): """Return a waveform slice.""" if margin is None: margin = (0, 0) assert isinstance(n_samples, (tuple, list)) assert len(n_samples) == 2 before, after = n_samples assert isinstance(margin, (tuple, list)) assert len(margin) == 2 margin_be...
[ "def", "_slice", "(", "index", ",", "n_samples", ",", "margin", "=", "None", ")", ":", "if", "margin", "is", "None", ":", "margin", "=", "(", "0", ",", "0", ")", "assert", "isinstance", "(", "n_samples", ",", "(", "tuple", ",", "list", ")", ")", ...
Return a waveform slice.
[ "Return", "a", "waveform", "slice", "." ]
7e9313dc364304b7d2bd03b92938347343703003
https://github.com/kwikteam/phy/blob/7e9313dc364304b7d2bd03b92938347343703003/phy/traces/waveform.py#L164-L179
train
kwikteam/phy
phy/traces/waveform.py
WaveformLoader._load_at
def _load_at(self, time, channels=None): """Load a waveform at a given time.""" if channels is None: channels = slice(None, None, None) time = int(time) time_o = time ns = self.n_samples_trace if not (0 <= time_o < ns): raise ValueError("Invalid ti...
python
def _load_at(self, time, channels=None): """Load a waveform at a given time.""" if channels is None: channels = slice(None, None, None) time = int(time) time_o = time ns = self.n_samples_trace if not (0 <= time_o < ns): raise ValueError("Invalid ti...
[ "def", "_load_at", "(", "self", ",", "time", ",", "channels", "=", "None", ")", ":", "if", "channels", "is", "None", ":", "channels", "=", "slice", "(", "None", ",", "None", ",", "None", ")", "time", "=", "int", "(", "time", ")", "time_o", "=", "...
Load a waveform at a given time.
[ "Load", "a", "waveform", "at", "a", "given", "time", "." ]
7e9313dc364304b7d2bd03b92938347343703003
https://github.com/kwikteam/phy/blob/7e9313dc364304b7d2bd03b92938347343703003/phy/traces/waveform.py#L248-L269
train
kwikteam/phy
phy/traces/waveform.py
WaveformLoader.get
def get(self, spike_ids, channels=None): """Load the waveforms of the specified spikes.""" if isinstance(spike_ids, slice): spike_ids = _range_from_slice(spike_ids, start=0, stop=self.n_spikes, ...
python
def get(self, spike_ids, channels=None): """Load the waveforms of the specified spikes.""" if isinstance(spike_ids, slice): spike_ids = _range_from_slice(spike_ids, start=0, stop=self.n_spikes, ...
[ "def", "get", "(", "self", ",", "spike_ids", ",", "channels", "=", "None", ")", ":", "if", "isinstance", "(", "spike_ids", ",", "slice", ")", ":", "spike_ids", "=", "_range_from_slice", "(", "spike_ids", ",", "start", "=", "0", ",", "stop", "=", "self"...
Load the waveforms of the specified spikes.
[ "Load", "the", "waveforms", "of", "the", "specified", "spikes", "." ]
7e9313dc364304b7d2bd03b92938347343703003
https://github.com/kwikteam/phy/blob/7e9313dc364304b7d2bd03b92938347343703003/phy/traces/waveform.py#L271-L337
train
kwikteam/phy
phy/stats/clusters.py
get_waveform_amplitude
def get_waveform_amplitude(mean_masks, mean_waveforms): """Return the amplitude of the waveforms on all channels.""" assert mean_waveforms.ndim == 2 n_samples, n_channels = mean_waveforms.shape assert mean_masks.ndim == 1 assert mean_masks.shape == (n_channels,) mean_waveforms = mean_waveform...
python
def get_waveform_amplitude(mean_masks, mean_waveforms): """Return the amplitude of the waveforms on all channels.""" assert mean_waveforms.ndim == 2 n_samples, n_channels = mean_waveforms.shape assert mean_masks.ndim == 1 assert mean_masks.shape == (n_channels,) mean_waveforms = mean_waveform...
[ "def", "get_waveform_amplitude", "(", "mean_masks", ",", "mean_waveforms", ")", ":", "assert", "mean_waveforms", ".", "ndim", "==", "2", "n_samples", ",", "n_channels", "=", "mean_waveforms", ".", "shape", "assert", "mean_masks", ".", "ndim", "==", "1", "assert"...
Return the amplitude of the waveforms on all channels.
[ "Return", "the", "amplitude", "of", "the", "waveforms", "on", "all", "channels", "." ]
7e9313dc364304b7d2bd03b92938347343703003
https://github.com/kwikteam/phy/blob/7e9313dc364304b7d2bd03b92938347343703003/phy/stats/clusters.py#L41-L55
train
kwikteam/phy
phy/stats/clusters.py
get_mean_masked_features_distance
def get_mean_masked_features_distance(mean_features_0, mean_features_1, mean_masks_0, mean_masks_1, n_features_per_channel=None, )...
python
def get_mean_masked_features_distance(mean_features_0, mean_features_1, mean_masks_0, mean_masks_1, n_features_per_channel=None, )...
[ "def", "get_mean_masked_features_distance", "(", "mean_features_0", ",", "mean_features_1", ",", "mean_masks_0", ",", "mean_masks_1", ",", "n_features_per_channel", "=", "None", ",", ")", ":", "assert", "n_features_per_channel", ">", "0", "mu_0", "=", "mean_features_0",...
Compute the distance between the mean masked features.
[ "Compute", "the", "distance", "between", "the", "mean", "masked", "features", "." ]
7e9313dc364304b7d2bd03b92938347343703003
https://github.com/kwikteam/phy/blob/7e9313dc364304b7d2bd03b92938347343703003/phy/stats/clusters.py#L58-L80
train