# This file is part of OpenDrift.
#
# OpenDrift is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, version 2
#
# OpenDrift is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with OpenDrift. If not, see <https://www.gnu.org/licenses/>.
#
# Copyright 2021, Gaute Hope, MET Norway
#from importlib import resources
from importlib.resources import files
from pathlib import Path
import logging
import json
import itertools
from functools import lru_cache
from adios_db.models.oil.oil import Oil as AdiosOil
from adios_db.computation import gnome_oil
from .oil import OpendriftOil
logger = logging.getLogger(__name__)
[docs]
@lru_cache(maxsize=None)
def __get_archive__():
import lzma
oils = []
oil_file = files('opendrift.models.openoil.adios').joinpath('oils.xz')
with lzma.open(oil_file, 'rt') as archive:
oils = json.load(archive)
# Add additional oils
#for f in resources.contents('opendrift.models.openoil.adios.extra_oils'):
# if Path(f).suffix == '.json':
# o = json.loads(resources.read_text('opendrift.models.openoil.adios.extra_oils', f))
# #logger.debug(f"Adding additional oil: {f}..: {o['data']['_id']}, {o['data']['attributes']['metadata']['name']}")
# oils.append(o)
for o in oils:
# For Norwegian oils, we add year to the name
if o['oil_id'][0:2] == 'NO':
yearstring = str(o['metadata']['reference']['year'])
# Override with sample_date, if available
if 'sample_date' in o['metadata']:
sd = o['metadata']['sample_date']
if sd.isnumeric():
yearstring = sd
elif sd[0:4].isnumeric():
yearstring = sd[0:4]
else:
raise Exception(f'Sample date could not be parsed: {sd}')
o['metadata']['name'] = \
f"{o['metadata']['name']} {yearstring}"
return oils
[docs]
def get_oil_names(location=None):
a = __get_archive__()
if location is not None:
a = [o for o in a if
o['oil_id'][0:4] == 'AD04' or
('location' in o['metadata'] and o['metadata']['location'].lower() == location.lower())]
return [o['metadata']['name'] for o in a]
[docs]
def oils(limit=50, query=''):
oils = filter(
lambda o: query in o['metadata']['name'],
__get_archive__())
return list(OpendriftOil(o) for o in itertools.islice(oils, limit))
[docs]
def find_full_oil_from_name(name) -> 'OpendriftOil':
logger.info(f'Querying ADIOS database for oil: {name}')
o = oils(query=name)
if len(o) > 1:
logger.warning(
f"Several oils found with name: {name}: {[oo.id for oo in o]}, using first."
)
elif len(o) < 1:
raise ValueError(f"No oil found with name: {name}")
return o[0]
[docs]
def get_full_oil_from_id(_id) -> 'OpendriftOil':
logger.debug(f"Fetching full oil: {_id}")
#oils = filter(lambda o: _id == o['data']['_id'], __get_archive__())
oils = filter(lambda o: _id == o['oil_id'], __get_archive__())
oil = next(OpendriftOil(o) for o in oils)
return oil