Sun

class pyarts3.arts.Sun(*args, **kwargs)

A single sun.

Each sun is described by a struct with its spectrum, radius distance from center of planet to center of sun, temperature (if possible), latitude in the sky of the planet, longitude in the sky of the planet and the type

Workspace variables of type Sun

sun

Overview

Method	`readxml()`	Read variable from file.
Method	`savexml()`	Saves variable to file.
Static Method	`fromxml()`	Create variable from file.
`String`	`description`	Sun description
`float`	`distance`	Sun distance
`float`	`latitude`	Sun latitude
`float`	`longitude`	Sun longitude
`float`	`radius`	Sun radius
`Matrix`	`spectrum`	Sun spectrum, monochromatic radiance spectrum at the surface of the sun
Operator	`__eq__()`	Return self==value.
Operator	`__format__()`	__format__(self, arg: str, /) -> str
Operator	`__ge__()`	Return self>=value.
Operator	`__getstate__()`	__getstate__(self) -> tuple[str, pyarts3.arts.Matrix, float, float, float, float]
Operator	`__gt__()`	Return self>value.
Operator	`__hash__()`	Return hash(self).
Operator	`__init__()`	__init__(self, arg: pyarts3.arts.Sun) -> None
Operator	`__le__()`	Return self<=value.
Operator	`__lt__()`	Return self<value.
Operator	`__ne__()`	Return self!=value.
Operator	`__repr__()`	__repr__(self) -> str
Operator	`__setstate__()`	__setstate__(self, arg: tuple[str, pyarts3.arts.Matrix, float, float, float, float], /) -> None
Operator	`__str__()`	__str__(self) -> str

Constructors

__init__(self) → None
__init__(self, arg: pyarts3.arts.Sun) → None

Methods

readxml(self, file: str) → str

Read variable from file.

Parameters:: file (str) – A file that can be read.
Raises:: RuntimeError – For any failure to read.
Returns:: file – The file path found (may differ from input due to environment variables).
Return type:: str

savexml(self, file: str, type: str = 'ascii', clobber: bool = True) → str

Saves variable to file.

Parameters:

file (str) – The path to which the file is written. Note that several of the options might modify the name or write more files.
type (str, optional) – Type of file to save. See FileType for options. Defaults is “ascii”.
clobber (bool, optional) – Overwrite existing files or add new file with modified name? Defaults is True.

Raises:

RuntimeError – For any failure to write.

Returns:

file – The file saved. May differ from input.

Return type:

str

Static Methods

fromxml(file: str) → pyarts3.arts.Sun

Create variable from file.

Parameters:: file (str) – A file that can be read
Raises:: RuntimeError – For any failure to read.
Returns:: artstype – The variable created from the file.
Return type:: T

Attributes

description: String: Sun description

distance: float: Sun distance

latitude: float: Sun latitude

longitude: float: Sun longitude

radius: float: Sun radius

spectrum: Matrix: Sun spectrum, monochromatic radiance spectrum at the surface of the sun

Operators

__eq__(value, /): Return self==value.

__format__(self, arg: str, /) → str

__ge__(value, /): Return self>=value.

__getstate__(self) → tuple[str, pyarts3.arts.Matrix, float, float, float, float]

__gt__(value, /): Return self>value.

__hash__(): Return hash(self).

__init__(self) → None
__init__(self, arg: pyarts3.arts.Sun) → None

__le__(value, /): Return self<=value.

__lt__(value, /): Return self<value.

__ne__(value, /): Return self!=value.

__repr__(self) → str

__setstate__(self, arg: tuple[str, pyarts3.arts.Matrix, float, float, float, float], /) → None

__str__(self) → str