ios_shell.sections module

Contains classes to represent complex elements of an IOS Shell file.

class ios_shell.sections.Administration(mission: str, agency: str, country: str, project: str, scientist: str, platform: str, remarks: str, raw: Dict[str, Any])

Bases: object

Represents the *ADMINISTRATION section.

agency: str

country: str

mission: str

platform: str

project: str

raw: Dict[str, Any]

remarks: str

scientist: str

class ios_shell.sections.Calibration(corrected_channels: List[Dict[str, str]], remarks: str, raw: Dict[str, Any])

Bases: object

Represents the *CALIBRATION section.

corrected_channels: List[Dict[str, str]]

raw: Dict[str, Any]

remarks: str

class ios_shell.sections.Channel(no='', name='', units='', minimum='', maximum='')

Bases: object

A single entry in the CHANNELS table.

maximum: float

minimum: float

name: str

no: int

units: str

class ios_shell.sections.ChannelDetail(no='', pad='', start='', width='', format='', type='', decimal_places='')

Bases: object

A single entry in the CHANNEL DETAILS table.

decimal_places: int = -1

format: str

no: int

pad: float

start: str

type: str

width: int

class ios_shell.sections.Deployment(mission: str, type: str, anchor_dropped: datetime, remarks: str, raw: Dict[str, Any])

Bases: object

Represents the *DEPLOYMENT section.

anchor_dropped: datetime

mission: str

raw: Dict[str, Any]

remarks: str

type: str

class ios_shell.sections.FileInfo(start_time: datetime, end_time: datetime, time_zero: datetime, time_increment: timedelta, time_units: str, number_of_records: int, data_description: str, file_type: str, format: str, data_type: str, pad: float, number_of_channels: int, channels: List[Channel], channel_details: List[ChannelDetail], remarks: str, raw: Dict[str, Any])

Bases: object

Represents the *FILE section.

channel_details: List[ChannelDetail]

channels: List[Channel]

data_description: str

data_type: str

end_time: datetime

file_type: str

format: str

number_of_channels: int

number_of_records: int

pad: float

raw: Dict[str, Any]

remarks: str

start_time: datetime

time_increment: timedelta

time_units: str

time_zero: datetime

class ios_shell.sections.History(programs: List[Program], remarks: str, raw: Dict[str, Any])

Bases: object

Represents the *HISTORY section.

programs: List[Program]

raw: Dict[str, Any]

remarks: str

class ios_shell.sections.Instrument(type: str, model: str, serial_number: str, depth: float, remarks: str, raw: Dict[str, Any])

Bases: object

Represents the *INSTRUMENT section.

depth: float

model: str

raw: Dict[str, Any]

remarks: str

serial_number: str

type: str

class ios_shell.sections.Location(geographic_area: str, station: str, event_number: int, latitude: float, longitude: float, water_depth: float, remarks: str, raw: Dict[str, Any])

Bases: object

Represents the *LOCATION section.

event_number: int

geographic_area: str

latitude: float

longitude: float

raw: Dict[str, Any]

remarks: str

station: str

water_depth: float

class ios_shell.sections.Program(name: str, version: str, date: date, time: time, records_in: int, records_out: int)

Bases: object

A single entry in the PROGRAMS table.

date: date

name: str

records_in: int

records_out: int

time: time

version: str

class ios_shell.sections.Raw(remarks: str, raw: Dict[str, Any])

Bases: object

Represents the *RAW section.

raw: Dict[str, Any]

remarks: str

class ios_shell.sections.Recovery(mission: str, anchor_released: datetime, remarks: str, raw: Dict[str, Any])

Bases: object

Represents the *RECOVERY section.

anchor_released: datetime

mission: str

raw: Dict[str, Any]

remarks: str

class ios_shell.sections.Version(version_no: str, date1: str, date2: str, tag: str = '')

Bases: object

Represents the *IOS HEADER VERSION line of the file.

date1: str

date2: str

tag: str = ''

version_no: str