Source code for emodelrunner.configuration.subgroups

"""Dataclasses containing subgroups of config data."""

# Copyright 2020-2022 Blue Brain Project / EPFL

# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at

#     http://www.apache.org/licenses/LICENSE-2.0

# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.


from dataclasses import dataclass
from typing import Optional



[docs]
@dataclass(frozen=True)
class HocPaths:
    """Contains paths relative to hoc files creation."""

    hoc_dir: str
    cell_hoc_filename: str
    simul_hoc_filename: str
    run_hoc_filename: str
    syn_dir: str
    syn_dir_for_hoc: str
    syn_hoc_filename: str
    main_protocol_filename: str




[docs]
@dataclass(frozen=True)
class ProtArgs:
    """Contains data needed to create protocols."""

    emodel: str
    apical_point_isec: int
    mtype: str
    prot_path: str
    features_path: str




[docs]
@dataclass(frozen=True)
class SynMechArgs:
    """Contains data needed to create synapse mechanimsms.

    Attributes can be accessed only if add_synapses is True.
    """

    add_synapses: bool
    seed: int
    rng_settings_mode: str
    syn_conf_file: str
    syn_data_file: str
    syn_dir: str

    def __getattribute__(self, item):
        """Modified getattribute to restrict access to when add_synapses is True.

        Raises:
            AttributeError when an attribute other than add_synapses is looked for and
                add_synapses is False
        """
        if item != "add_synapses" and not self.add_synapses:
            raise AttributeError(
                f"You can not access {item} if add_synapses is {self.add_synapses}."
            )
        return super().__getattribute__(item)




[docs]
@dataclass(frozen=True)
class MorphArgs:
    """Contains data relative to morphology."""

    morph_path: str
    do_replace_axon: bool
    axon_hoc_path: Optional[str] = None




[docs]
@dataclass(frozen=True)
class PresynStimArgs:
    """Contains data relative to the presynaptic cell stimuli."""

    stim_train: float
    amp: float
    width: float