cuperiod.TLSSettings

class cuperiod.TLSSettings(_case_sensitive=None, _nested_model_default_partial_update=None, _env_prefix=None, _env_prefix_target=None, _env_file=PosixPath('.'), _env_file_encoding=None, _env_ignore_empty=None, _env_nested_delimiter=None, _env_nested_max_split=None, _env_parse_none_str=None, _env_parse_enums=None, _cli_prog_name=None, _cli_parse_args=None, _cli_settings_source=None, _cli_parse_none_str=None, _cli_hide_none_type=None, _cli_avoid_json=None, _cli_enforce_required=None, _cli_use_class_docs_for_groups=None, _cli_exit_on_error=None, _cli_prefix=None, _cli_flag_prefix_char=None, _cli_implicit_flags=None, _cli_ignore_unknown_args=None, _cli_kebab_case=None, _cli_shortcuts=None, _secrets_dir=None, _build_sources=None, *, min_period_days=0.5, max_period_days=100.0, min_transits=2, oversample=2, grid_duration_frac=0.05, n_phase_bins=256, duration_min_frac=0.01, duration_max_frac=0.1, n_durations=5, limb_dark_u1=0.4, limb_dark_u2=0.3, n_peaks=10, peak_separation_rayleigh=3.0, alias_freq_tolerance=0.0035, harmonic_max=8, min_detections=20, backend='auto', period_batch=256, downsample_points=2000)[source]

Bases: BaseSettings

Settings for the transit least squares (TLS) search.

Parameters:

  • _case_sensitive (bool | None)

  • _nested_model_default_partial_update (bool | None)

  • _env_prefix (str | None)

  • _env_prefix_target (EnvPrefixTarget | None)

  • _env_file (DotenvType | None)

  • _env_file_encoding (str | None)

  • _env_ignore_empty (bool | None)

  • _env_nested_delimiter (str | None)

  • _env_nested_max_split (int | None)

  • _env_parse_none_str (str | None)

  • _env_parse_enums (bool | None)

  • _cli_prog_name (str | None)

  • _cli_parse_args (bool | list[str] | tuple[str, ...] | None)

  • _cli_settings_source (CliSettingsSource[Any] | None)

  • _cli_parse_none_str (str | None)

  • _cli_hide_none_type (bool | None)

  • _cli_avoid_json (bool | None)

  • _cli_enforce_required (bool | None)

  • _cli_use_class_docs_for_groups (bool | None)

  • _cli_exit_on_error (bool | None)

  • _cli_prefix (str | None)

  • _cli_flag_prefix_char (str | None)

  • _cli_implicit_flags (bool | Literal['dual', 'toggle'] | None)

  • _cli_ignore_unknown_args (bool | None)

  • _cli_kebab_case (bool | Literal['all', 'no_enums'] | None)

  • _cli_shortcuts (Mapping[str, str | list[str]] | None)

  • _secrets_dir (PathType | None)

  • _build_sources (tuple[tuple[PydanticBaseSettingsSource, ...], dict[str, Any]] | None)

  • min_period_days (Annotated[float, Gt(gt=0)])

  • max_period_days (Annotated[float, Gt(gt=0)])

  • min_transits (Annotated[int, Ge(ge=1)])

  • oversample (Annotated[int, Ge(ge=1)])

  • grid_duration_frac (Annotated[float, Gt(gt=0)])

  • n_phase_bins (Annotated[int, Ge(ge=16)])

  • duration_min_frac (Annotated[float, Gt(gt=0)])

  • duration_max_frac (Annotated[float, Gt(gt=0)])

  • n_durations (Annotated[int, Ge(ge=1)])

  • limb_dark_u1 (float)

  • limb_dark_u2 (float)

  • n_peaks (Annotated[int, Ge(ge=1)])

  • peak_separation_rayleigh (Annotated[float, Gt(gt=0)])

  • alias_freq_tolerance (Annotated[float, Ge(ge=0)])

  • harmonic_max (Annotated[int, Ge(ge=1)])

  • min_detections (Annotated[int, Ge(ge=3)])

  • backend (Literal['auto', 'cpu', 'gpu', 'numpy', 'cupy'])

  • period_batch (Annotated[int, Ge(ge=1)])

  • downsample_points (Annotated[int, Ge(ge=2)])

model_config = {'arbitrary_types_allowed': True, 'case_sensitive': False, 'cli_avoid_json': False, 'cli_enforce_required': False, 'cli_exit_on_error': True, 'cli_flag_prefix_char': '-', 'cli_hide_none_type': False, 'cli_ignore_unknown_args': False, 'cli_implicit_flags': False, 'cli_kebab_case': False, 'cli_parse_args': None, 'cli_parse_none_str': None, 'cli_prefix': '', 'cli_prog_name': None, 'cli_shortcuts': None, 'cli_use_class_docs_for_groups': False, 'enable_decoding': True, 'env_file': None, 'env_file_encoding': None, 'env_ignore_empty': False, 'env_nested_delimiter': None, 'env_nested_max_split': None, 'env_parse_enums': None, 'env_parse_none_str': None, 'env_prefix': 'CUPERIOD_TLS_', 'env_prefix_target': 'variable', 'extra': 'forbid', 'json_file': None, 'json_file_encoding': None, 'nested_model_default_partial_update': False, 'protected_namespaces': ('model_validate', 'model_dump', 'settings_customise_sources'), 'secrets_dir': None, 'toml_file': None, 'validate_default': True, 'yaml_config_section': None, 'yaml_file': None, 'yaml_file_encoding': None}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].