String

class pyarts3.arts.String(*args, **kwargs)

Basic string type

Sizes

A variable x of this group may name 1 dimension, read as x.size().

Workspace methods that require String

abs_bandsReadHITRAN() abs_bandsReadJPL() abs_bandsReadSpeciesSplitARTSCAT() abs_bandsReadSpeciesSplitCatalog() abs_bandsReadSplit() abs_bandsSaveSplit() abs_cia_dataReadFromCIA() abs_cia_dataReadFromXML() abs_cia_dataReadSpeciesSplitCatalog() abs_lookup_dataFromProfiles() abs_lookup_dataSimpleWide() abs_predef_dataReadSpeciesSplitCatalog() abs_xfit_dataReadSpeciesSplitCatalog() atm_fieldAppendAuto() atm_fieldAppendBaseData() atm_fieldAppendCIASpeciesData() atm_fieldAppendLineIsotopologueData() atm_fieldAppendLineLevelData() atm_fieldAppendLineSpeciesData() atm_fieldAppendLookupTableSpeciesData() atm_fieldAppendPredefSpeciesData() atm_fieldAppendTagsSpeciesData() atm_fieldAppendXsecSpeciesData() atm_fieldHydrostaticPressure() atm_fieldInit() atm_fieldRead() atm_pointInit() disort_settings_agendaSetup() disort_settings_agendaSubsurfaceSetup() disort_settings_downwelling_wrapper_agendaSet() inversion_iterate_agendaSet() jac_targetsAddMagneticField() jac_targetsAddWindField() MCRadar() measurement_inversion_agendaSet() measurement_vecFromRadarSingleScattering()

measurement_vecFromSensor() model_state_vecFromRadarOnionPeeling() oemAddMagneticField() oemAddWindField() ray_path_observer_agendaSet() ray_path_observer_agendaSetGeometric() ray_point_back_propagation_agendaSet() ReadCatalogData() ReadXML() ReadXMLIndexed() single_rad_space_agendaSet() single_rad_surface_agendaSet() spectral_propmat_agendaSet() spectral_propmat_and_atm_path_agendaSet() spectral_propmat_scat_agendaSet() spectral_propmat_scat_spectral_agendaSet() spectral_rad_closed_surface_agendaSet() spectral_rad_observer_agendaSet() spectral_rad_space_agendaSet() spectral_rad_surface_agendaSet() spectral_surf_refl_agendaSet() sunFromGrid() surf_fieldEarth() surf_fieldEuropa() surf_fieldGanymede() surf_fieldIo() surf_fieldJupiter() surf_fieldMars() surf_fieldMoon() surf_fieldPlanet() surf_fieldVenus() telsem_atlasReadAscii() tessem_nnReadAscii() WriteBuiltinPartitionFunctionsXML() WriteXML() WriteXMLIndexed()

Overview

Method	readxml()	Read variable from file.
Method	savexml()	Saves variable to file.
Static Method	fromxml()	Create variable from file.
Operator	__add__()	__add__(self, arg: object, /) -> object
Operator	__and__()	__and__(self, arg: object, /) -> object
Operator	__divmod__()	__divmod__(self, arg: object, /) -> object
Operator	__eq__()	__eq__(self, arg: object, /) -> object
Operator	__floordiv__()	__floordiv__(self, arg: object, /) -> object
Operator	__format__()	__format__(self, arg: str, /) -> str
Operator	__ge__()	__ge__(self, arg: object, /) -> object
Operator	__getitem__()	Get item from string
Operator	__gt__()	__gt__(self, arg: object, /) -> object
Operator	__hash__()	Allows hashing
Operator	__init__()	__init__(self, arg: bytes, /) -> None
Operator	__le__()	__le__(self, arg: object, /) -> object
Operator	__len__()	Length of the string
Operator	__lt__()	__lt__(self, arg: object, /) -> object
Operator	__matmul__()	__matmul__(self, arg: object, /) -> object
Operator	__mod__()	__mod__(self, arg: object, /) -> object
Operator	__mul__()	__mul__(self, arg: object, /) -> object
Operator	__ne__()	__ne__(self, arg: object, /) -> object
Operator	__or__()	__or__(self, arg: object, /) -> object
Operator	__pow__()	__pow__(self, arg: object, /) -> object
Operator	__radd__()	__radd__(self, arg: object, /) -> object
Operator	__rand__()	__rand__(self, arg: object, /) -> object
Operator	__rdivmod__()	__rdivmod__(self, arg: object, /) -> object
Operator	__repr__()	__repr__(self) -> str
Operator	__rfloordiv__()	__rfloordiv__(self, arg: object, /) -> object
Operator	__rmatmul__()	__rmatmul__(self, arg: object, /) -> object
Operator	__rmod__()	__rmod__(self, arg: object, /) -> object
Operator	__rmul__()	__rmul__(self, arg: object, /) -> object
Operator	__ror__()	__ror__(self, arg: object, /) -> object
Operator	__rpow__()	__rpow__(self, arg: object, /) -> object
Operator	__rsub__()	__rsub__(self, arg: object, /) -> object
Operator	__rtruediv__()	__rtruediv__(self, arg: object, /) -> object
Operator	__str__()	__str__(self) -> str
Operator	__truediv__()	__truediv__(self, arg: object, /) -> object

Constructors

__init__(self) → None

__init__(self, arg: str, /) → None

__init__(self, arg: String) → None

__init__(self, arg: bytes, /) → 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) → String

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:

String

Operators

__add__(self, arg: String, /) → object

__add__(self, arg: object, /) → object

__and__(self, arg: String, /) → object

__and__(self, arg: object, /) → object

__divmod__(self, arg: String, /) → object

__divmod__(self, arg: object, /) → object

__eq__(self, arg: String, /) → object

__eq__(self, arg: object, /) → object

__floordiv__(self, arg: String, /) → object

__floordiv__(self, arg: object, /) → object

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

__ge__(self, arg: String, /) → object

__ge__(self, arg: object, /) → object

__getitem__(self, arg: object, /) → object

Get item from string

__gt__(self, arg: String, /) → object

__gt__(self, arg: object, /) → object

__hash__(self) → int

Allows hashing

__init__(self) → None

__init__(self, arg: str, /) → None

__init__(self, arg: String) → None

__init__(self, arg: bytes, /) → None

__le__(self, arg: String, /) → object

__le__(self, arg: object, /) → object

__len__(self) → int

Length of the string

__lt__(self, arg: String, /) → object

__lt__(self, arg: object, /) → object

__matmul__(self, arg: String, /) → object

__matmul__(self, arg: object, /) → object

__mod__(self, arg: String, /) → object

__mod__(self, arg: object, /) → object

__mul__(self, arg: String, /) → object

__mul__(self, arg: object, /) → object

__ne__(self, arg: String, /) → object

__ne__(self, arg: object, /) → object

__or__(self, arg: String, /) → object

__or__(self, arg: object, /) → object

__pow__(self, arg: String, /) → object

__pow__(self, arg: object, /) → object

__radd__(self, arg: String, /) → object

__radd__(self, arg: object, /) → object

__rand__(self, arg: String, /) → object

__rand__(self, arg: object, /) → object

__rdivmod__(self, arg: String, /) → object

__rdivmod__(self, arg: object, /) → object

__repr__(self) → str

__rfloordiv__(self, arg: String, /) → object

__rfloordiv__(self, arg: object, /) → object

__rmatmul__(self, arg: String, /) → object

__rmatmul__(self, arg: object, /) → object

__rmod__(self, arg: String, /) → object

__rmod__(self, arg: object, /) → object

__rmul__(self, arg: String, /) → object

__rmul__(self, arg: object, /) → object

__ror__(self, arg: String, /) → object

__ror__(self, arg: object, /) → object

__rpow__(self, arg: String, /) → object

__rpow__(self, arg: object, /) → object

__rsub__(self, arg: String, /) → object

__rsub__(self, arg: object, /) → object

__rtruediv__(self, arg: String, /) → object

__rtruediv__(self, arg: object, /) → object

__str__(self) → str

__truediv__(self, arg: String, /) → object

__truediv__(self, arg: object, /) → object