├── tests ├── __init__.py └── test_buoyant.py ├── .gitignore ├── buoyant ├── __init__.py ├── timezone.py ├── properties.py └── buoy.py ├── .travis.yml ├── setup.py ├── README.md └── LICENSE /tests/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .eggs 2 | *.pyc 3 | *.egg-info 4 | build 5 | *.egg 6 | readme.rst 7 | dist 8 | .env 9 | -------------------------------------------------------------------------------- /buoyant/__init__.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # Copyright 2014-17 Neil Freeman 3 | # This program is free software: you can redistribute it and/or modify 4 | # it under the terms of the GNU General Public License as published by 5 | # the Free Software Foundation, either version 3 of the License, or 6 | # (at your option) any later version. 7 | 8 | # This program is distributed in the hope that it will be useful, 9 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 | # GNU General Public License for more details. 12 | 13 | # You should have received a copy of the GNU General Public License 14 | # along with this program. If not, see . 15 | __version__ = "0.6.0" 16 | 17 | from .buoy import Buoy, Observation 18 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | # buoyant 2 | # Copyright 2014-2017 Neil Freeman contact@fakeisthenewreal.org 3 | 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | 14 | # You should have received a copy of the GNU General Public License 15 | # along with this program. If not, see . 16 | 17 | language: python 18 | 19 | python: 20 | - 3.6 21 | - 3.7 22 | - 3.8 23 | - 3.9 24 | 25 | matrix: 26 | allow_failures: 27 | - python: 3.9 28 | 29 | install: 30 | - python setup.py install 31 | 32 | script: 33 | - python -m unittest 34 | -------------------------------------------------------------------------------- /buoyant/timezone.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # Copyright 2014-17 Neil Freeman 3 | # This program is free software: you can redistribute it and/or modify 4 | # it under the terms of the GNU General Public License as published by 5 | # the Free Software Foundation, either version 3 of the License, or 6 | # (at your option) any later version. 7 | 8 | # This program is distributed in the hope that it will be useful, 9 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 | # GNU General Public License for more details. 12 | 13 | # You should have received a copy of the GNU General Public License 14 | # along with this program. If not, see . 15 | from datetime import datetime 16 | 17 | from pytz import timezone 18 | 19 | ISOFORMAT = '%Y-%m-%dT%H:%M:%S' 20 | 21 | 22 | def parse_datetime(timestamp): 23 | '''Parse an ISO datetime, which Python does buggily.''' 24 | d = datetime.strptime(timestamp[:-1], ISOFORMAT) 25 | 26 | if timestamp[-1:] == 'Z': 27 | return timezone('utc').localize(d) 28 | 29 | return d 30 | 31 | 32 | def iso_format(timestamp): 33 | return timestamp.strftime(ISOFORMAT + 'Z') 34 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # Copyright 2014-17 Neil Freeman 3 | # This program is free software: you can redistribute it and/or modify 4 | # it under the terms of the GNU General Public License as published by 5 | # the Free Software Foundation, either version 3 of the License, or 6 | # (at your option) any later version. 7 | 8 | # This program is distributed in the hope that it will be useful, 9 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 | # GNU General Public License for more details. 12 | 13 | # You should have received a copy of the GNU General Public License 14 | # along with this program. If not, see . 15 | from setuptools import setup 16 | 17 | with open('README.md') as f: 18 | README = f.read() 19 | 20 | with open('buoyant/__init__.py') as i: 21 | VERSION = next(r for r in i.readlines() if '__version__' in r).split('=')[1].strip('"\' \n') 22 | 23 | setup( 24 | name='buoyant', 25 | version=VERSION, 26 | description="Wrapper for the NOAA National Data Buoy Center", 27 | long_description=README, 28 | long_description_content_type='text/markdown', 29 | url='https://github.com/fitnr/buoyant', 30 | author='Neil Freeman', 31 | author_email='contact@fakeisthenewreal.org', 32 | license='GPL', 33 | packages=['buoyant'], 34 | install_requires=[ 35 | 'requests >=2.4.1, <3.0', 36 | 'pytz>=2015.6' 37 | ], 38 | python_requires=">=3.5", 39 | classifiers=[ 40 | 'License :: OSI Approved :: GNU General Public License v3 (GPLv3)', 41 | 'Programming Language :: Python :: 3.6', 42 | 'Programming Language :: Python :: 3.7', 43 | 'Programming Language :: Python :: 3.8', 44 | 'Topic :: Scientific/Engineering :: Atmospheric Science', 45 | 'Intended Audience :: Science/Research', 46 | ], 47 | test_suite='tests', 48 | ) 49 | -------------------------------------------------------------------------------- /buoyant/properties.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # Copyright 2014-17 Neil Freeman 3 | # This program is free software: you can redistribute it and/or modify 4 | # it under the terms of the GNU General Public License as published by 5 | # the Free Software Foundation, either version 3 of the License, or 6 | # (at your option) any later version. 7 | 8 | # This program is distributed in the hope that it will be useful, 9 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 | # GNU General Public License for more details. 12 | 13 | # You should have received a copy of the GNU General Public License 14 | # along with this program. If not, see . 15 | 16 | # lat, lon, datetime are assigned separately. 17 | general = [ 18 | 'air_pressure_at_sea_level', 19 | 'air_temperature', 20 | 'currents', 21 | 'sea_floor_depth_below_sea_surface', 22 | 'sea_water_electrical_conductivity', 23 | 'sea_water_salinity', 24 | 'sea_water_temperature', 25 | 'waves', 26 | 'winds', 27 | ] 28 | 29 | currents = [ 30 | 'bin', # (count) 31 | 'depth', # (m) 32 | 'direction_of_sea_water_velocity', # (degree) 33 | 'sea_water_speed', # (c/s) 34 | 'upward_sea_water_velocity', # (c/s) 35 | 'error_velocity', # (c/s) 36 | 'platform_orientation', # (degree) 37 | 'platform_pitch_angle', # (degree) 38 | 'platform_roll_angle', # (degree) 39 | 'sea_water_temperature', # (C) 40 | 'pct_good_3_beam', # (%) 41 | 'pct_good_4_beam', # (%) 42 | 'pct_rejected', # (%) 43 | 'pct_bad', # (%) 44 | 'echo_intensity_beam1', # (count) 45 | 'echo_intensity_beam2', # (count) 46 | 'echo_intensity_beam3', # (count) 47 | 'echo_intensity_beam4', # (count) 48 | 'correlation_magnitude_beam1', # (count) 49 | 'correlation_magnitude_beam2', # (count) 50 | 'correlation_magnitude_beam3', # (count) 51 | 'correlation_magnitude_beam4', # (count) 52 | 'quality_flags', 53 | ] 54 | 55 | waves = [ 56 | "sea_surface_wave_significant_height", # (m) 57 | "sea_surface_wave_peak_period", # (s) 58 | "sea_surface_wave_mean_period", # (s) 59 | "sea_surface_swell_wave_significant_height", # (m) 60 | "sea_surface_swell_wave_period", # (s) 61 | "sea_surface_wind_wave_significant_height", # (m) 62 | "sea_surface_wind_wave_period", # (s) 63 | "sea_water_temperature", # (c) 64 | "sea_surface_wave_to_direction", # (degree) 65 | "sea_surface_swell_wave_to_direction", # (degree) 66 | "sea_surface_wind_wave_to_direction", # (degree) 67 | "number_of_frequencies", # (count) 68 | "center_frequencies", # (Hz) 69 | "bandwidths", # (Hz) 70 | "spectral_energy", # (m**2/Hz) 71 | "mean_wave_direction", # (degree) 72 | "principal_wave_direction", # (degree) 73 | "polar_coordinate_r1", # (1) 74 | "polar_coordinate_r2", # (1) 75 | "calculation_method", 76 | "sampling_rate", # (Hz) 77 | ] 78 | 79 | winds = [ 80 | "wind_from_direction", # (degree) 81 | "wind_speed", # (m/s) 82 | "wind_speed_of_gust", # (m/s) 83 | "upward_air_velocity", # (m/s) 84 | ] 85 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## Buoyant 2 | 3 | Buoyant is a Python wrapper for grabbing buoy data from the [National Buoy Data Center](http://www.ndbc.noaa.gov). It parses CSV from the [SDF](http://sdf.ndbc.noaa.gov) endpoint and images from the [BuoyCam](http://www.ndbc.noaa.gov/buoycams.shtml) service. 4 | 5 | The NBDC provides a [list](http://sdf.ndbc.noaa.gov/stations.shtml) and a [map](http://sdf.ndbc.noaa.gov) of active buoys. 6 | 7 | Hello buoy example: 8 | ````python 9 | > from buoyant import Buoy 10 | > buoy = Buoy(13010) 11 | ```` 12 | 13 | Construct the Buoy object with the station ID. It's an alphanumeric code. If its numeric, an integer works fine. 14 | 15 | More examples: 16 | 17 | ````python 18 | > from buoyant import Buoy 19 | > buoy = Buoy('0Y2W3') 20 | > buoy.air_pressure_at_sea_level 21 | Observation(1014.1, 'hPa') 22 | ``` 23 | 24 | Get buoy location. 25 | ```python 26 | > buoy.coords 27 | (44.794, -87.313) 28 | ``` 29 | 30 | Get the time the measurements were made. This can be some time ago! 31 | ```python 32 | > buoy.air_pressure_at_sea_level.datetime 33 | datetime.datetime(2015, 8, 18, 11, 40, tzinfo=) 34 | ``` 35 | 36 | Not all stations report all data at all times. Be prepared to handle empty attributes. 37 | ```python 38 | > buoy.wave_height 39 | None 40 | ``` 41 | 42 | Clear the buoy object's data dictionary. This isn't very useful, since the buoys update only every hour or so. 43 | ``` 44 | > buoy.refresh() 45 | ```` 46 | 47 | The `Observation` object is numeric value (a `float`) with two additional attributes, `unit` and `value`. Generally `unit` this is an abbreviation for a metric unit or composition of units. You can use `Observation`s just like numeric objects, and use the `value` or `unit` field when `format`ting: 48 | ```python 49 | > pressure = buoy.air_pressure_at_sea_level 50 | Observation(1014.1, 'hPa') 51 | > min(pressure, 1020) 52 | Observation(1014.1, 'hPa') 53 | > '{0.value} [{0.unit}]'.format(pressure) 54 | '1014.1 [hPa]' 55 | ``` 56 | 57 | ### Images 58 | 59 | Some buoys have cameras! If the buoy doesn't have an active camera, a placeholder image provided by the NBDC will be returned. 60 | 61 | ````python 62 | > station = Buoy(41009) 63 | > station.image_url 64 | 'http://www.ndbc.noaa.gov/images/buoycam/Z14C_2014_11_01_2200.jpg' 65 | ```` 66 | 67 | Save image as a file 'out.jpg' 68 | ````python 69 | > station.write_image('out.jpg') 70 | ```` 71 | 72 | Get raw image as a `BytesIO` object 73 | ````python 74 | > station.image 75 | <_io.BytesIO object> 76 | > station.url 77 | 'http://www.ndbc.noaa.gov/station_page.php?station=41009' 78 | ```` 79 | 80 | ### No data 81 | 82 | There are two ways to a buoy can be missing a certain data field. Either there's no recent observation, or that buoy doesn't observe that datum. 83 | 84 | ````python 85 | > buoy = Buoy('0Y2W3') 86 | > buoy.winds 87 | # None, because while this is usually recorded, it hasn't been lately. 88 | > sturgeon.waves 89 | None 90 | ```` 91 | 92 | ### Measurements included 93 | 94 | * air_pressure_at_sea_level 95 | * air_temperature 96 | * currents 97 | * sea_floor_depth_below_sea_surface 98 | * sea_water_electrical_conductivity 99 | * sea_water_salinity 100 | * sea_water_temperature 101 | * waves 102 | * winds 103 | 104 | ### Currents and Waves and Wind 105 | 106 | Wave and wind data have multiple data points, the are returned as `dict`s. 107 | 108 | Currents data is returned as a `list` of `dict`s with current information at different times/depths. It's not well-documented on the NBDC site, so good luck! 109 | 110 | ### Compatibility 111 | 112 | Buoyant is compatible with Python 3.5+. 113 | 114 | ### License 115 | 116 | Buoyant is licensed under the [GPL](http://www.gnu.org/licenses/#GPL). 117 | -------------------------------------------------------------------------------- /tests/test_buoyant.py: -------------------------------------------------------------------------------- 1 | """General tests for Buoyant library.""" 2 | 3 | import datetime 4 | import unittest 5 | from io import BytesIO 6 | 7 | import buoyant 8 | from buoyant import buoy 9 | 10 | sampledata = [ 11 | { 12 | "latitude (degree)": "39.235", 13 | "sea_surface_wave_peak_period (s)": "13.79", 14 | "polar_coordinate_r1 (1)": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;", 15 | "station_id": "urn:ioos:station:wmo:46014", 16 | "sea_surface_wind_wave_period (s)": "3.80", 17 | "spectral_energy (m**2/Hz)": "0;0;0;0;0.117495;0.347233;0.340078;1.07545;1.31407;0.644604;0.319928;0.20951;0.203445;0.407703;0.501098;1.05528;0.552653;0.982512;0.40238;0.259344;0.176087;0.156276;0.10127;0.0713481;0.1257;0.0469963;0.0294347;0.0344079;0.0196117;0.0208386;0.0207157;0.0185725;0.0112313;0.0140935;0.00829521;0.0135329;0.0103501;0.00823833;0.00611987;0.00516951;0.00295949;0.00274196;0.00162249;0.00153895;0.000701703;0.000452887", 18 | "sea_surface_wave_mean_period (s)": "7.61", 19 | "sea_water_temperature (c)": "", 20 | "bandwidths (Hz)": "0.0050;0.0050;0.0050;0.0050;0.0050;0.0050;0.0050;0.0050;0.0050;0.0050;0.0050;0.0050;0.0050;0.0100;0.0100;0.0100;0.0100;0.0100;0.0100;0.0100;0.0100;0.0100;0.0100;0.0100;0.0100;0.0100;0.0100;0.0100;0.0100;0.0100;0.0100;0.0100;0.0100;0.0100;0.0100;0.0100;0.0100;0.0100;0.0100;0.0200;0.0200;0.0200;0.0200;0.0200;0.0200;0.0200", 21 | "sea_surface_wind_wave_to_direction (degree)": "", 22 | "polar_coordinate_r2 (1)": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;", 23 | "sampling_rate (Hz)": "", 24 | "sea_surface_wave_to_direction (degree)": "", 25 | "sea_surface_swell_wave_significant_height (m)": "1.07", 26 | "number_of_frequencies (count)": "46", 27 | "center_frequencies (Hz)": "0.0325;0.0375;0.0425;0.0475;0.0525;0.0575;0.0625;0.0675;0.0725;0.0775;0.0825;0.0875;0.0925;0.1000;0.1100;0.1200;0.1300;0.1400;0.1500;0.1600;0.1700;0.1800;0.1900;0.2000;0.2100;0.2200;0.2300;0.2400;0.2500;0.2600;0.2700;0.2800;0.2900;0.3000;0.3100;0.3200;0.3300;0.3400;0.3500;0.3650;0.3850;0.4050;0.4250;0.4450;0.4650;0.4850", 28 | "date_time": "2015-07-31T19:50:00Z", 29 | "sea_surface_wind_wave_significant_height (m)": "0.17", 30 | "sea_surface_wave_significant_height (m)": "1.09", 31 | "sea_surface_swell_wave_to_direction (degree)": "", 32 | "sea_surface_swell_wave_period (s)": "", 33 | "calculation_method": "UNKNOWN", 34 | "mean_wave_direction (degree)": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;", 35 | "longitude (degree)": "-123.974", 36 | "principal_wave_direction (degree)": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;", 37 | "sensor_id": "urn:ioos:sensor:wmo:46014::wpm1", 38 | } 39 | ] 40 | 41 | 42 | class BuoyTestCase(unittest.TestCase): 43 | def setUp(self): 44 | self.b = buoyant.Buoy("41012") 45 | 46 | def test_observation(self): 47 | """Test the Observation class.""" 48 | self.assertTrue(issubclass(buoyant.Observation, float)) 49 | subint = float.__new__(buoyant.Observation, 11) 50 | assert subint == 11 51 | assert isinstance(subint, buoyant.Observation) 52 | obs = buoyant.Observation(1, "m") 53 | assert isinstance(obs, buoyant.Observation) 54 | assert obs.unit == "m" 55 | self.assertEqual(str(obs), "1.0 m") 56 | assert repr(obs) == "Observation(1.0, 'm')" 57 | assert obs + 2 == 3 58 | 59 | def test_buoy_instant(self): 60 | assert self.b 61 | assert isinstance(self.b, buoyant.Buoy) 62 | 63 | def test_data_exists(self): 64 | x = self.b.sea_water_electrical_conductivity 65 | assert x.unit == "mS/cm" 66 | currents = self.b.currents 67 | self.assertIsInstance(currents, list) 68 | assert isinstance(x.datetime, datetime.datetime) 69 | assert isinstance(self.b.image, BytesIO) 70 | assert isinstance(self.b.__dict__["lat"], float) 71 | assert isinstance(self.b.coords, tuple) 72 | assert (self.b.__dict__["lat"], self.b.__dict__["lon"]) == self.b.coords 73 | 74 | def test_keys(self): 75 | """Test that observation attributes exist in Buoy class.""" 76 | self.assertIsNotNone(self.b.sea_water_salinity) 77 | self.assertIsNotNone(self.b.air_pressure_at_sea_level) 78 | self.assertIsNotNone(self.b.air_temperature) 79 | self.assertIsNotNone(self.b.currents) 80 | self.assertIsNotNone(self.b.sea_water_electrical_conductivity) 81 | self.assertIsNotNone(self.b.sea_water_salinity) 82 | self.assertIsNotNone(self.b.sea_water_temperature) 83 | 84 | def test_parse_unit(self): 85 | dictionary = {"magic (pixie dust)": "42"} 86 | x = buoy.parse_unit("magic", dictionary) 87 | assert isinstance(x, buoyant.Observation) 88 | 89 | nope = buoy.parse_unit("widget", dictionary) 90 | self.assertIsNone(nope) 91 | 92 | spectral_energy = buoy.parse_unit("spectral_energy", sampledata[0]) 93 | self.assertEqual(spectral_energy[4], buoy.Observation(0.117495, "m**2/Hz")) 94 | 95 | def test_error(self): 96 | with self.assertRaises(AttributeError): 97 | self.b._get("foo bar") 98 | 99 | self.assertIsNone(self.b.depth) 100 | 101 | def test_image(self): 102 | station = buoyant.Buoy(51001) 103 | assert buoy.CAM_ENDPOINT in station.image_url 104 | self.assertIsNotNone(station.image) 105 | 106 | def test_degroup(self): 107 | waves = buoyant.buoy._degroup(sampledata, buoyant.properties.waves) 108 | self.assertEqual( 109 | waves[0]["sea_surface_wind_wave_significant_height"], 110 | buoy.Observation(0.17, "m"), 111 | ) 112 | 113 | 114 | if __name__ == "__main__": 115 | unittest.main() 116 | -------------------------------------------------------------------------------- /buoyant/buoy.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # Copyright 2014-17 Neil Freeman 3 | # This program is free software: you can redistribute it and/or modify 4 | # it under the terms of the GNU General Public License as published by 5 | # the Free Software Foundation, either version 3 of the License, or 6 | # (at your option) any later version. 7 | 8 | # This program is distributed in the hope that it will be useful, 9 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 | # GNU General Public License for more details. 12 | 13 | # You should have received a copy of the GNU General Public License 14 | # along with this program. If not, see . 15 | import csv 16 | import re 17 | from io import BytesIO, StringIO 18 | 19 | import requests 20 | from pytz import utc 21 | 22 | from . import properties, timezone 23 | 24 | # Both take station as a GET argument. 25 | OBS_ENDPOINT = "https://sdf.ndbc.noaa.gov/sos/server.php" 26 | CAM_ENDPOINT = 'https://www.ndbc.noaa.gov/buoycam.php' 27 | 28 | ''' 29 | request=GetObservation 30 | service=SOS 31 | version=1.0.0 32 | offering=urn:ioos:station:wmo:41012 33 | observedproperty=air_pressure_at_sea_level 34 | responseformat=text/csv 35 | eventtime=latest 36 | ''' 37 | 38 | 39 | def parse_unit(prop, dictionary, timestamp=None): 40 | '''Do a fuzzy match for `prop` in the dictionary, taking into account unit suffix.''' 41 | # add the observation's time 42 | try: 43 | timestamp = timestamp or timezone.parse_datetime(dictionary.get('date_time')) 44 | except TypeError: 45 | timestamp = None 46 | 47 | # 'prop' is a stub of the property's attribute key, so search for matches 48 | matches = [k for k in dictionary.keys() if prop in k] 49 | 50 | try: 51 | value = dictionary[matches[0]] 52 | unit = re.search(r' \(([^)]+)\)', matches[0]) 53 | 54 | except IndexError: 55 | # No matches: fail out 56 | return None 57 | 58 | # Sometimes we get a list of values (e.g. waves) 59 | if ';' in value: 60 | # Ignore empty values 61 | values = [val for val in value.split(';') if val != ''] 62 | 63 | if unit: 64 | return [Observation(v, unit.group(1), timestamp) for v in values] 65 | 66 | return values 67 | 68 | # Sometimes there's no value! Sometimes there's no unit! 69 | if not value or not unit: 70 | return value or None 71 | 72 | return Observation(value, unit.group(1), timestamp) 73 | 74 | 75 | def _degroup(iterable, propertylist): 76 | return [{prop: parse_unit(prop, row) for prop in propertylist} for row in iterable] 77 | 78 | 79 | ''' 80 | Response looks like: 81 | station_id,sensor_id,"latitude (degree)","longitude (degree)",date_time,"depth (m)","air_pressure_at_sea_level (hPa)" 82 | urn:ioos:station:wmo:41012,urn:ioos:sensor:wmo:41012::baro1,30.04,-80.55,2014-02-19T12:50:00Z,0.00,1022.1 83 | ''' 84 | 85 | 86 | class Buoy: 87 | 88 | '''Wrapper for the NDBC Buoy information mini-API''' 89 | 90 | __dict__ = {} 91 | params = { 92 | 'request': 'GetObservation', 93 | 'service': 'SOS', 94 | 'version': '1.0.0', 95 | 'responseformat': 'text/csv', 96 | } 97 | 98 | def __init__(self, bouyid, eventtime=None): 99 | self.id = bouyid 100 | self.refresh() 101 | 102 | if eventtime: 103 | if eventtime.tzinfo: 104 | eventtime = eventtime.astimezone(utc) 105 | eventtime = timezone.iso_format(eventtime) 106 | self.eventtime = eventtime or 'latest' 107 | 108 | def refresh(self): 109 | """Reset data for this buoy. New values will be fetched in the future.""" 110 | self.__dict__ = { 111 | 'lat': None, 112 | 'lon': None, 113 | } 114 | 115 | def _get(self, observation, as_group=None): 116 | return self.__dict__.setdefault(observation, self.fetch(observation, as_group)) 117 | 118 | def fetch(self, observation, as_group=None): 119 | """Fetch an observation for this buoy from the API.""" 120 | if observation not in properties.general: 121 | raise AttributeError(observation) 122 | 123 | params = { 124 | 'offering': 'urn:ioos:station:wmo:{}'.format(self.id), 125 | 'observedproperty': observation, 126 | 'eventtime': self.eventtime, 127 | } 128 | params.update(self.params) 129 | request = requests.get(OBS_ENDPOINT, params=params) 130 | 131 | reader = csv.DictReader(StringIO(request.text)) 132 | 133 | if as_group: 134 | return _degroup(reader, getattr(properties, observation)) 135 | 136 | try: 137 | result = next(reader) 138 | except StopIteration: 139 | result = {} 140 | 141 | self.__dict__.setdefault('station_id', result.get('station_id')) 142 | self.__dict__.setdefault('sensor_id', result.get('sensor_id')) 143 | 144 | try: 145 | self.__dict__['lon'] = self.__dict__['lon'] or float(result.get('longitude (degree)')) 146 | self.__dict__['lat'] = self.__dict__['lat'] or float(result.get('latitude (degree)')) 147 | 148 | except TypeError: 149 | self.__dict__['lon'], self.__dict__['lat'] = None, None 150 | 151 | self.__dict__['depth'] = parse_unit('depth', result) 152 | 153 | return parse_unit(observation, result) 154 | 155 | @property 156 | def air_pressure_at_sea_level(self): 157 | return self._get('air_pressure_at_sea_level') 158 | 159 | @property 160 | def air_temperature(self): 161 | return self._get('air_temperature') 162 | 163 | @property 164 | def currents(self): 165 | try: 166 | return self._get('currents', as_group=True) 167 | except IndexError: 168 | pass 169 | 170 | @property 171 | def sea_floor_depth_below_sea_surface(self): 172 | return self._get('sea_floor_depth_below_sea_surface') 173 | 174 | @property 175 | def sea_water_electrical_conductivity(self): 176 | return self._get('sea_water_electrical_conductivity') 177 | 178 | @property 179 | def sea_water_salinity(self): 180 | return self._get('sea_water_salinity') 181 | 182 | @property 183 | def sea_water_temperature(self): 184 | return self._get('sea_water_temperature') 185 | 186 | @property 187 | def waves(self): 188 | try: 189 | return self._get('waves', as_group=True)[0] 190 | except IndexError: 191 | pass 192 | 193 | @property 194 | def winds(self): 195 | try: 196 | return self._get('winds', as_group=True)[0] 197 | except IndexError: 198 | pass 199 | 200 | @property 201 | def image_url(self): 202 | return '{0}?station={id}'.format(CAM_ENDPOINT, id=self.id) 203 | 204 | def _write_img(self, handle): 205 | i = requests.get(CAM_ENDPOINT, params={'station': self.id}) 206 | for chunk in i.iter_content(): 207 | handle.write(chunk) 208 | 209 | @property 210 | def image(self): 211 | output = BytesIO() 212 | self._write_img(output) 213 | output.seek(0) 214 | 215 | return output 216 | 217 | def save_image(self, filename): 218 | with open(filename, 'wb') as f: 219 | self._write_img(f) 220 | 221 | @property 222 | def coords(self): 223 | return self.__dict__.get('lat'), self.__dict__.get('lon') 224 | 225 | @property 226 | def depth(self): 227 | return self.__dict__.get('depth') 228 | 229 | 230 | class Observation(float): 231 | 232 | """An observation is a numeric object along with a unit string.""" 233 | 234 | def __init__(self, value, unit, datetime=None): 235 | self.value = value 236 | self._unit = unit 237 | self._datetime = datetime 238 | 239 | def __new__(cls, value, *_): 240 | return float.__new__(cls, value) 241 | 242 | @property 243 | def unit(self): 244 | """Return this observation's unit.""" 245 | return self._unit 246 | 247 | @property 248 | def datetime(self): 249 | """Return the timestamp that this observation was made.""" 250 | return self._datetime 251 | 252 | def __repr__(self): 253 | return "Observation({}, '{}')".format(self.__float__(), self.unit) 254 | 255 | def __str__(self): 256 | return "{} {}".format(self.__float__(), self.unit) 257 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | --------------------------------------------------------------------------------