Skip to content

Bleaching

Bases: BaseSummary

A class for handling coral bleaching data from MERMAID.

The Bleaching class is responsible for fetching bleaching data, including observations, observations aggregated by sample units, and observations aggregated by sample events, for a specified project.

Source code in seasnake/summaries/bleaching.py 
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
class Bleaching(BaseSummary):
    """
    A class for handling coral bleaching data from MERMAID.

    The Bleaching class is responsible for fetching bleaching data, including observations,
    observations aggregated by sample units, and observations aggregated by sample events,
    for a specified project.
    """

    @requires_token
    def colonies_bleached_observations(self, project_id: str) -> DataFrame:
        """
        Retrieves a project's Bleaching colonies bleached observations.

        Args:
            project_id (str): The ID of the project for which to fetch Bleaching observations.

        Returns:
            DataFrame

        Examples:
        ```
        from seasnake import MermaidAuth, Bleaching

        auth = MermaidAuth()
        bleaching = Bleaching(token=auth.get_token())
        project_id = "AAAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE"
        print(bleaching.colonies_bleached_observations(project_id))
        ```
        """

        url = f"/projects/{project_id}/bleachingqcs/obscoloniesbleacheds/"
        df = self.read_cache(url)
        return self.to_cache(url, self.data_frame_from_url(url)) if df is None else df

    @requires_token
    def percent_cover_observations(self, project_id: str) -> DataFrame:
        """
        Retrieves a project's Bleaching percent cover of hard coral, macroalgae and
        soft coral observations.

        Args:
            project_id (str): The ID of the project for which to fetch Bleaching observations.

        Returns:
            DataFrame

        Examples:
        ```
        from seasnake import MermaidAuth, Bleaching

        auth = MermaidAuth()
        bleaching = Bleaching(token=auth.get_token())
        project_id = "AAAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE"
        print(bleaching.percent_cover_observations(project_id))
        ```
        """

        url = f"/projects/{project_id}/bleachingqcs/obsquadratbenthicpercents/"
        df = self.read_cache(url)
        return self.to_cache(url, self.data_frame_from_url(url)) if df is None else df

    @requires_token
    def sample_units(self, project_id: str) -> DataFrame:
        """
        Retrieves a project's Bleaching observations aggregated by sample units.

        Args:
            project_id (str): The ID of the project for which to fetch Bleaching sample units.

        Returns:
            DataFrame

        Examples:
        ```
        from seasnake import MermaidAuth, Bleaching

        auth = MermaidAuth()
        bleaching = Bleaching(token=auth.get_token())
        project_id = "AAAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE"
        print(bleaching.sample_units(project_id))
        ```
        """

        url = f"/projects/{project_id}/bleachingqcs/sampleunits/"
        df = self.read_cache(url)
        return self.to_cache(url, self.data_frame_from_url(url)) if df is None else df

    @requires_token
    def sample_events(self, project_id: str) -> DataFrame:
        """
        Retrieves a project's Bleaching observations aggregated by sample events.

        Args:
            project_id (str): The ID of the project for which to fetch Bleaching sample events.

        Returns:
            DataFrame

        Examples:
        ```
        from seasnake import MermaidAuth, Bleaching

        auth = MermaidAuth()
        bleaching = Bleaching(token=auth.get_token())
        project_id = "AAAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE"
        print(bleaching.sample_events(project_id))
        ```
        """

        url = f"/projects/{project_id}/bleachingqcs/sampleevents/"
        df = self.read_cache(url)
        return self.to_cache(url, self.data_frame_from_url(url)) if df is None else df

colonies_bleached_observations(project_id)

Retrieves a project's Bleaching colonies bleached observations.

Parameters:

Name Type Description Default
project_id str

The ID of the project for which to fetch Bleaching observations.

 required

Returns:

Type Description
DataFrame

DataFrame

Examples:

from seasnake import MermaidAuth, Bleaching

auth = MermaidAuth()
bleaching = Bleaching(token=auth.get_token())
project_id = "AAAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE"
print(bleaching.colonies_bleached_observations(project_id))
Source code in seasnake/summaries/bleaching.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
@requires_token
def colonies_bleached_observations(self, project_id: str) -> DataFrame:
    """
    Retrieves a project's Bleaching colonies bleached observations.

    Args:
        project_id (str): The ID of the project for which to fetch Bleaching observations.

    Returns:
        DataFrame

    Examples:
    ```
    from seasnake import MermaidAuth, Bleaching

    auth = MermaidAuth()
    bleaching = Bleaching(token=auth.get_token())
    project_id = "AAAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE"
    print(bleaching.colonies_bleached_observations(project_id))
    ```
    """

    url = f"/projects/{project_id}/bleachingqcs/obscoloniesbleacheds/"
    df = self.read_cache(url)
    return self.to_cache(url, self.data_frame_from_url(url)) if df is None else df

percent_cover_observations(project_id)

Retrieves a project's Bleaching percent cover of hard coral, macroalgae and soft coral observations.

Parameters:

Name Type Description Default
project_id str

The ID of the project for which to fetch Bleaching observations.

 required

Returns:

Type Description
DataFrame

DataFrame

Examples:

from seasnake import MermaidAuth, Bleaching

auth = MermaidAuth()
bleaching = Bleaching(token=auth.get_token())
project_id = "AAAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE"
print(bleaching.percent_cover_observations(project_id))
Source code in seasnake/summaries/bleaching.py 
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
@requires_token
def percent_cover_observations(self, project_id: str) -> DataFrame:
    """
    Retrieves a project's Bleaching percent cover of hard coral, macroalgae and
    soft coral observations.

    Args:
        project_id (str): The ID of the project for which to fetch Bleaching observations.

    Returns:
        DataFrame

    Examples:
    ```
    from seasnake import MermaidAuth, Bleaching

    auth = MermaidAuth()
    bleaching = Bleaching(token=auth.get_token())
    project_id = "AAAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE"
    print(bleaching.percent_cover_observations(project_id))
    ```
    """

    url = f"/projects/{project_id}/bleachingqcs/obsquadratbenthicpercents/"
    df = self.read_cache(url)
    return self.to_cache(url, self.data_frame_from_url(url)) if df is None else df

sample_events(project_id)

Retrieves a project's Bleaching observations aggregated by sample events.

Parameters:

Name Type Description Default
project_id str

The ID of the project for which to fetch Bleaching sample events.

 required

Returns:

Type Description
DataFrame

DataFrame

Examples:

from seasnake import MermaidAuth, Bleaching

auth = MermaidAuth()
bleaching = Bleaching(token=auth.get_token())
project_id = "AAAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE"
print(bleaching.sample_events(project_id))
Source code in seasnake/summaries/bleaching.py 
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
@requires_token
def sample_events(self, project_id: str) -> DataFrame:
    """
    Retrieves a project's Bleaching observations aggregated by sample events.

    Args:
        project_id (str): The ID of the project for which to fetch Bleaching sample events.

    Returns:
        DataFrame

    Examples:
    ```
    from seasnake import MermaidAuth, Bleaching

    auth = MermaidAuth()
    bleaching = Bleaching(token=auth.get_token())
    project_id = "AAAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE"
    print(bleaching.sample_events(project_id))
    ```
    """

    url = f"/projects/{project_id}/bleachingqcs/sampleevents/"
    df = self.read_cache(url)
    return self.to_cache(url, self.data_frame_from_url(url)) if df is None else df

sample_units(project_id)

Retrieves a project's Bleaching observations aggregated by sample units.

Parameters:

Name Type Description Default
project_id str

The ID of the project for which to fetch Bleaching sample units.

 required

Returns:

Type Description
DataFrame

DataFrame

Examples:

from seasnake import MermaidAuth, Bleaching

auth = MermaidAuth()
bleaching = Bleaching(token=auth.get_token())
project_id = "AAAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE"
print(bleaching.sample_units(project_id))
Source code in seasnake/summaries/bleaching.py 
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
@requires_token
def sample_units(self, project_id: str) -> DataFrame:
    """
    Retrieves a project's Bleaching observations aggregated by sample units.

    Args:
        project_id (str): The ID of the project for which to fetch Bleaching sample units.

    Returns:
        DataFrame

    Examples:
    ```
    from seasnake import MermaidAuth, Bleaching

    auth = MermaidAuth()
    bleaching = Bleaching(token=auth.get_token())
    project_id = "AAAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE"
    print(bleaching.sample_units(project_id))
    ```
    """

    url = f"/projects/{project_id}/bleachingqcs/sampleunits/"
    df = self.read_cache(url)
    return self.to_cache(url, self.data_frame_from_url(url)) if df is None else df