# Zoo API Index

This is the Zoo package which forms a part of the [PyEarthTools package](https://github.com/ACCESS-Community-Hub/PyEarthTools).

The rest of this page contains reference information for the components of the Zoo package. The Zoo API docs can be viewed at [Zoo API Docs](zoo_api.md)

|  Module             |       Purpose                        |   API Docs     |
|---------------------|--------------------------------------|----------------|
|  `zoo`              |                                      | - [BaseForecastModel](zoo_api.md#pyearthtools.zoo.BaseForecastModel)  |
|                     |                                      | - [register](zoo_api.md#pyearthtools.zoo.register)  |
|  `zoo.exceptions`   |                                      | - [ModelException](zoo_api.md#pyearthtools.zoo.exceptions.ModelException)  |
|                     |                                      | - [ModelRegistrationException](zoo_api.md#pyearthtools.zoo.exceptions.ModelRegistrationException)  |
|  `zoo.model`        |                                      | - [Timer](zoo_api.md#pyearthtools.zoo.model.Timer)  |
|  `zoo.predict`      |                                      | - [data](zoo_api.md#pyearthtools.zoo.predict.data)  |
|                     |                                      | - [predict](zoo_api.md#pyearthtools.zoo.predict.predict)  |
|  `zoo.utils`        |                                      | - [Colour](zoo_api.md#pyearthtools.zoo.utils.Colour)  |
|                     |                                      | - [CategorisedObjects](zoo_api.md#pyearthtools.zoo.utils.CategorisedObjects)  |
|                     |                                      | - [AvailableModels](zoo_api.md#pyearthtools.zoo.utils.AvailableModels)  |
|                     |                                      | - [TabCompleter](zoo_api.md#pyearthtools.zoo.utils.TabCompleter)  |
|                     |                                      | - [parse_str](zoo_api.md#pyearthtools.zoo.utils.parse_str)  |
|                     |                                      | - [find_demlim](zoo_api.md#pyearthtools.zoo.utils.find_demlim)  |
|                     |                                      | - [delta_conversion](zoo_api.md#pyearthtools.zoo.utils.delta_conversion)  |
|                     |                                      | - [create_mapping](zoo_api.md#pyearthtools.zoo.utils.create_mapping)  |
|                     |                                      | - [get_annotation](zoo_api.md#pyearthtools.zoo.utils.get_annotation)  |
|                     |                                      | - [get_arguments](zoo_api.md#pyearthtools.zoo.utils.get_arguments)  |
|                     |                                      | - [split_name_assignment](zoo_api.md#pyearthtools.zoo.utils.split_name_assignment)  |
|  `zoo.warnings`     |                                      | - [AccessorRegistrationWarning](zoo_api.md#pyearthtools.zoo.warnings.AccessorRegistrationWarning)  |