ATCF Observations#
Read and write Automated Tropical Cyclone Forecast (ATCF) formatted observations.
- atcf.ATCF.read(self, atcf_filepath=None)#
DESCRIPTION:
This method reads an ATCF-formatted file and returns a SimpleNamespace object containing the attributes for the respective ATCF records.
- Keywords:
- atcf_filepath:
str, optional A Python string specifying the path to the ATCF-formatted file containing the respective ATCF records.
- atcf_filepath:
- Returns:
- tcvobj:
SimpleNamespace A Python SimpleNamespace object containing the attributes for each ATCF record.
- tcvobj:
- Raises:
- ATCFError:
raised if the atcf_filepath attribute is NoneType upon entry.
- Return type:
SimpleNamespace
- atcf.ATCF.write(self, tcvobj, atcf_filepath)#
DESCRIPTION:
This method writes a ATCF-formatted file for the specified ATCF record events.
- Parameters:
- tcvobj:
SimpleNamespace A Python SimpleNamespace object containing the attributes for each ATCF record.
- atcf_filepath:
str A Python string specifying the path to the ATCF-formatted file to contain the respective ATCF records.
- tcvobj:
- Raises:
- ATCFError:
raised if an exception is encountered while building, formatting, and/or writing the respective ATCF records.
- Return type:
None