azely.api module#

class AzEl(data=None, index: Axes | None = None, columns: Axes | None = None, dtype: Dtype | None = None, copy: bool | None = None)[source]#

Bases: DataFrame

Calculated azimuth and elevation of the object in degrees.

Parameters:

  • index (Axes | None)

  • columns (Axes | None)

  • dtype (Dtype | None)

  • copy (bool | None)

az: Series#

Azimuth of the object in degrees.

el: Series#

Elevation of the object in degrees.

in_lst() → Self[source]#

Convert its time index to the local sidereal time (LST).

Return type:

Self

in_utc() → Self[source]#

Convert its time index to the coordinated universal time (UTC).

Return type:

Self

location: Location#

Location information used for the azimuth/elevation calculation.

object: Object#

Object information used for the azimuth/elevation calculation.

separation(other: Self, /) → Series[source]#

Calculate the separation angle with other object in degrees.

Parameters:

other (Self)

Return type:

Series

time: Time#

Time information used for the azimuth/elevation calculation.

calc(object: Object | ObjectDict | str, location: Location | LocationDict | str = '', time: Time | TimeDict | str = '', *, google_api: str | None = None, ipinfo_api: str | None = None, sep: str = '\\s*;\\s*', timeout: float = 10.0, append: AppendDict | bool = True, overwrite: OverwriteDict | bool = False, source: SourceDict | PathLike[str] | str | None = PosixPath('/github/home/.config/azely/cache.toml')) → AzEl[source]#

Calculate azimuth/elevation of given object in given location at give time.

Parameters:

  • object (Object | ObjectDict | str) – Object information, or query dictionary or string for it.

  • location (Location | LocationDict | str) – Location information, or query dictionary or string for it.

  • time (Time | TimeDict | str) – Time information, or query dictionary or string for it.

  • google_api (str | None) – Optional Google API key for the location information.

  • ipinfo_api (str | None) – Optional IPinfo API key for the location information.

  • sep (str) – Separator string for splitting the location/object/time queries.

  • timeout (float) – Timeout length in seconds for the location/object information.

  • append (AppendDict | bool) – Whether to append the location/object/time information to the source TOML file if it does not exist. An option dictionary for each information is also accepted.

  • overwrite (OverwriteDict | bool) – Whether to overwrite the location/object/time information to the source TOML file even if it already exists. An option dictionary for each information is also accepted.

  • source (SourceDict | PathLike[str] | str | None) – Path of a source TOML file for the location/object/time information. An option dictionary for each information is also accepted.

Returns:

Calculated azimuth and elevation of the object in degrees.

Return type:

AzEl