Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add bare bone APIs for observation and event #186

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add bare bone APIs for observation and event #186

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d9cf029
Add barebone APIs for observation and event
shifucun Nov 7, 2022
f0d6464
add params
shifucun Nov 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions datacommons/event.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Copyright 2022 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
""" API to get event data."""


def event_series_within_place(event_type: str, containing_place: str,
date: str):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We probably want to use variable here too? Couple of options:

  1. Use the same API as observation_series() and friends, except, depending on the variable (Count_EarthquakeEvent vs. List_EarthquakeEvent), the returned value will have entities per date, rather than a value per date.

  2. Use very similar API structure as observation_series(), but these are "event" versions. We use the existing variables (e.g., Count_EarthquakeEvent), and this new API returns entities per data point.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

my preference would be for (2)
rather than event, should we use entity to be more extensible?

return None
36 changes: 36 additions & 0 deletions datacommons/observation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Copyright 2022 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
""" API to get statistical observation data."""

from typing import List


Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

document return value?

def observation_series(variable: str, entities: List[str]):
return None


def observation_series_of_entities_within_place(variable: str, entity_type: str,
containing_place: str):
return None


def observation_point(variable: str, entities: List[str], date: str = ""):
return None


def observation_point_of_entities_within_place(variable: str,
entity_type: str,
containing_place: str,
date: str = ""):
return None