diff --git a/2.12.0a2/.buildinfo b/2.12.0a2/.buildinfo new file mode 100644 index 00000000..869dd4e8 --- /dev/null +++ b/2.12.0a2/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: b979dbf08076d6409ffdd024f384581c +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/2.12.0a2/.doctrees/environment.pickle b/2.12.0a2/.doctrees/environment.pickle new file mode 100644 index 00000000..3d1b411d Binary files /dev/null and b/2.12.0a2/.doctrees/environment.pickle differ diff --git a/2.12.0a2/.doctrees/index.doctree b/2.12.0a2/.doctrees/index.doctree new file mode 100644 index 00000000..4036bce8 Binary files /dev/null and b/2.12.0a2/.doctrees/index.doctree differ diff --git a/2.12.0a2/_modules/index.html b/2.12.0a2/_modules/index.html new file mode 100644 index 00000000..e368754a --- /dev/null +++ b/2.12.0a2/_modules/index.html @@ -0,0 +1,106 @@ + + + + + + Overview: module code — l2ss-py 2.12.0a2 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+ + +
+
+
+
+ + + + \ No newline at end of file diff --git a/2.12.0a2/_modules/podaac/subsetter/run_subsetter.html b/2.12.0a2/_modules/podaac/subsetter/run_subsetter.html new file mode 100644 index 00000000..0b91094d --- /dev/null +++ b/2.12.0a2/_modules/podaac/subsetter/run_subsetter.html @@ -0,0 +1,232 @@ + + + + + + podaac.subsetter.run_subsetter — l2ss-py 2.12.0a2 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Source code for podaac.subsetter.run_subsetter

+"""
+run_subsetter.py
+
+This script runs L2SS-Py on the given granule.
+"""
+import argparse
+import logging
+import os
+import sys
+
+import numpy as np
+
+from podaac.subsetter import subset
+
+
+
+[docs] +def parse_args(args: list) -> tuple: + """ + Parse args for this script. + + Returns + ------- + tuple + input_file, output_file, bbox, variables, min_time, max_time + """ + parser = argparse.ArgumentParser(description='Run l2ss-py') + parser.add_argument( + 'input_file', + type=str, + help='File to subset' + ) + parser.add_argument( + 'output_file', + type=str, + help='Output file' + ) + parser.add_argument( + '--bbox', + type=float, + default=[-180, -90, 180, 90], + nargs=4, + action='store', + help='Bounding box in the form min_lon min_lat max_lon max_lat' + ) + parser.add_argument( + '--variables', + type=str, + default=None, + nargs='+', + help='Variables, only include if variable subset is desired. ' + 'Should be a space separated list of variable names e.g. ' + 'sst wind_dir sst_error ...' + ) + parser.add_argument( + '--min-time', + type=str, + default=None, + help='Min time. Should be ISO-8601 format. Only include if ' + 'temporal subset is desired.' + ) + parser.add_argument( + '--max-time', + type=str, + default=None, + help='Max time. Should be ISO-8601 format. Only include if ' + 'temporal subset is desired.' + ) + parser.add_argument( + '--cut', + default=False, + action='store_true', + help='If provided, scanline will be cut' + ) + parser.add_argument( + '--shapefile', + type=str, + default=None, + help='Path to either shapefile or geojson file used to subset ' + 'the provided input granule' + ) + + args = parser.parse_args(args=args) + bbox = np.array([[args.bbox[0], args.bbox[2]], [args.bbox[1], args.bbox[3]]]) + + return args.input_file, args.output_file, bbox, args.variables, \ + args.min_time, args.max_time, args.cut, args.shapefile
+ + + +
+[docs] +def run_subsetter(args: list) -> None: + """ + Parse arguments and run subsetter on the specified input file + """ + input_file, output_file, bbox, variables, min_time, max_time, cut, shapefile = parse_args(args) + + logging.info('Executing subset on %s...', input_file) + subset.subset( + file_to_subset=input_file, + bbox=bbox, + output_file=output_file, + variables=variables, + cut=cut, + min_time=min_time, + max_time=max_time, + origin_source=os.path.basename(input_file), + shapefile=shapefile + ) + logging.info('Subset complete. Result in %s', output_file)
+ + + +
+[docs] +def main() -> None: + """Entry point to the script""" + logging.basicConfig( + stream=sys.stdout, + format='[%(asctime)s] {%(filename)s:%(lineno)d} %(levelname)s - %(message)s', + level=logging.DEBUG + ) + run_subsetter(sys.argv[1:])
+ + + +if __name__ == '__main__': + main() +
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/2.12.0a2/_modules/podaac/subsetter/subset.html b/2.12.0a2/_modules/podaac/subsetter/subset.html new file mode 100644 index 00000000..163a4f7f --- /dev/null +++ b/2.12.0a2/_modules/podaac/subsetter/subset.html @@ -0,0 +1,1565 @@ + + + + + + podaac.subsetter.subset — l2ss-py 2.12.0a2 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for podaac.subsetter.subset

+# Copyright 2019, by the California Institute of Technology.
+# ALL RIGHTS RESERVED. United States Government Sponsorship acknowledged.
+# Any commercial use must be negotiated with the Office of Technology
+# Transfer at the California Institute of Technology.
+#
+# This software may be subject to U.S. export control laws. By accepting
+# this software, the user agrees to comply with all applicable U.S. export
+# laws and regulations. User has the responsibility to obtain export
+# licenses, or other export authority as may be required before exporting
+# such information to foreign countries or providing access to foreign
+# persons.
+
+"""
+=========
+subset.py
+=========
+
+Functions related to subsetting a NetCDF file.
+"""
+
+import datetime
+import functools
+import json
+import operator
+import os
+import re
+from itertools import zip_longest
+from typing import List, Optional, Tuple, Union
+import dateutil
+from dateutil import parser
+
+import cf_xarray as cfxr
+import cftime
+import geopandas as gpd
+import importlib_metadata
+import julian
+import netCDF4 as nc
+import numpy as np
+import pandas as pd
+import xarray as xr
+import xarray.coding.times
+from shapely.geometry import Point, Polygon, MultiPolygon
+from shapely.ops import transform
+
+from podaac.subsetter import gpm_cleanup as gc
+from podaac.subsetter import time_converting as tc
+from podaac.subsetter import dimension_cleanup as dc
+from podaac.subsetter import xarray_enhancements as xre
+from podaac.subsetter.group_handling import GROUP_DELIM, transform_grouped_dataset, recombine_grouped_datasets, \
+    h5file_transform
+
+SERVICE_NAME = 'l2ss-py'
+
+
+
+[docs] +def apply_scale_offset(scale: float, offset: float, value: float) -> float: + """Apply scale and offset to the given value""" + return (value + offset) / scale
+ + + +
+[docs] +def remove_scale_offset(value: float, scale: float, offset: float) -> float: + """Remove scale and offset from the given value""" + return (value * scale) - offset
+ + + +
+[docs] +def convert_bound(bound: np.ndarray, coord_max: int, coord_var: xr.DataArray) -> np.ndarray: + """ + This function will return a converted bound, which matches the + range of the given input file. + + Parameters + ---------- + bound : np.array + 1-dimensional 2-element numpy array which represent the lower + and upper bounding box on this coordinate, respectively. + coord_max : integer + The max value which is possible given this coordinate. For + example, the max for longitude is 360. + coord_var : xarray.DataArray + The xarray variable for some coordinate. + + Returns + ------- + np.array + 1-dimensional 2-element number array which represents the lower + and upper bounding box on this coordinate and has been converted + based on the valid bounds coordinate range of the dataset. + + Notes + ----- + Assumption that 0 is always on the prime meridian/equator. + """ + + scale = coord_var.attrs.get('scale_factor', 1.0) + offset = coord_var.attrs.get('add_offset', 0.0) + valid_min = coord_var.attrs.get('valid_min', None) + + if valid_min is None or valid_min > 0: + # If coord var doesn't contain valid min, attempt to find + # manually. Note: Given the perfect storm, this could still fail + # to find the actual bounds. + + # Filter out _FillValue from data before calculating min and max + fill_value = coord_var.attrs.get('_FillValue', None) + var_values = coord_var.values + if fill_value: + var_values = np.where(var_values != fill_value, var_values, np.nan) + var_min = np.nanmin(var_values) + var_max = np.nanmax(var_values) + + if 0 <= var_min <= var_max <= (coord_max / scale): + valid_min = 0 + + # If the file coords are 0 --> max + if valid_min == 0: + bound = (bound + coord_max) % coord_max + + # If the right/top bound is 0, set to max. + if bound[1] == 0: + bound[1] = coord_max + + # If edges are the same, assume it wraps and return all + if bound[0] == bound[1]: + bound = np.array([0, coord_max]) + + # If the file longitude is -coord_max/2 --> coord_max/2 + if valid_min != 0: + # If edges are the same, assume it wraps and return all + if bound[0] == bound[1]: + bound = np.array([-(coord_max / 2), coord_max / 2]) + + # Calculate scale and offset so the bounds match the coord data + return apply_scale_offset(scale, offset, bound)
+ + + +
+[docs] +def convert_bbox(bbox: np.ndarray, dataset: xr.Dataset, lat_var_name: str, lon_var_name: str) -> np.ndarray: + """ + This function will return a converted bbox which matches the range + of the given input file. This will convert both the latitude and + longitude range. For example, an input dataset can have a valid + longitude range of -180 --> 180 or of 0 --> 360. + + Parameters + ---------- + bbox : np.array + The bounding box + dataset : xarray.Dataset + The dataset which is being subset. + lat_var_name : str + Name of the lat variable in the given dataset + lon_var_name : str + Name of the lon variable in the given dataset + + Returns + ------- + bbox : np.array + The new bbox which matches latitude and longitude ranges of the + input file. + + Notes + ----- + Assumption that the provided bounding box is always between + -180 --> 180 for longitude and -90, 90 for latitude. + """ + return np.array([convert_bound(bbox[0], 360, dataset[lon_var_name]), + convert_bound(bbox[1], 180, dataset[lat_var_name])])
+ + + +
+[docs] +def set_json_history(dataset: xr.Dataset, cut: bool, file_to_subset: str, + bbox: np.ndarray = None, shapefile: str = None, origin_source=None) -> None: + """ + Set the 'json_history' metadata header of the granule to reflect the + current version of the subsetter, as well as the parameters used + to call the subsetter. This will append an json array to the json_history of + the following format: + + Parameters + ---------- + dataset : xarray.Dataset + The dataset to change the header of + cut : boolean + True to cut the scanline + file_to_subset : string + The filepath of the file which was used to subset + bbox : np.ndarray + The requested bounding box + shapefile : str + Name of the shapefile to include in the version history + TODO: add docstring and type hint for `origin_source` parameter. + """ + + params = f'cut={cut}' + if bbox is not None: + params = f'bbox={bbox.tolist()} {params}' + elif shapefile is not None: + params = f'shapefile={shapefile} {params}' + + history_json = dataset.attrs.get('history_json', []) + if history_json: + history_json = json.loads(history_json) + + if origin_source: + derived_from = origin_source + else: + derived_from = os.path.basename(file_to_subset) + + new_history_json = { + "date_time": datetime.datetime.now(tz=datetime.timezone.utc).isoformat(), + "derived_from": derived_from, + "program": SERVICE_NAME, + "version": importlib_metadata.distribution(SERVICE_NAME).version, + "parameters": params, + "program_ref": "https://cmr.earthdata.nasa.gov:443/search/concepts/S1962070864-POCLOUD", + "$schema": "https://harmony.earthdata.nasa.gov/schemas/history/0.1.0/history-v0.1.0.json" + } + + history_json.append(new_history_json) + dataset.attrs['history_json'] = json.dumps(history_json)
+ + + +
+[docs] +def set_version_history(dataset: xr.Dataset, cut: bool, bbox: np.ndarray = None, shapefile: str = None) -> None: + """ + Set the 'history' metadata header of the granule to reflect the + current version of the subsetter, as well as the parameters used + to call the subsetter. This will append a line to the history of + the following format: + + TIMESTAMP podaac.subsetter VERSION (PARAMS) + + Parameters + ---------- + dataset : xarray.Dataset + The dataset to change the header of + cut : boolean + True to cut the scanline + bbox : np.ndarray + The requested bounding box + shapefile : str + Name of the shapefile to include in the version history + + """ + + version = importlib_metadata.distribution(SERVICE_NAME).version + history = dataset.attrs.get('history', "") + timestamp = datetime.datetime.utcnow() + params = f'cut={cut}' + if bbox is not None: + params = f'bbox={bbox.tolist()} {params}' + elif shapefile is not None: + params = f'shapefile={shapefile} {params}' + + history += f"\n{timestamp} {SERVICE_NAME} v{version} ({params})" + dataset.attrs['history'] = history.strip()
+ + + +
+[docs] +def calculate_chunks(dataset: xr.Dataset) -> dict: + """ + For the given dataset, calculate if the size on any dimension is + worth chunking. Any dimension larger than 4000 will be chunked. This + is done to ensure that the variable can fit in memory. + + Parameters + ---------- + dataset : xarray.Dataset + The dataset to calculate chunks for. + + Returns + ------- + dict + The chunk dictionary, where the key is the dimension and the + value is 4000 or 500 depending on how many dimensions. + """ + if len(dataset.dims) <= 3: + chunk = {dim: 4000 for dim in dataset.dims + if dataset.sizes[dim] > 4000 + and len(dataset.dims) > 1} + else: + chunk = {dim: 500 for dim in dataset.dims + if dataset.sizes[dim] > 500} + + return chunk
+ + + +
+[docs] +def find_matching_coords(dataset: xr.Dataset, match_list: List[str]) -> List[str]: + """ + As a backup for finding a coordinate var, look at the 'coordinates' + metadata attribute of all data vars in the granule. Return any + coordinate vars that have name matches with the provided + 'match_list' + + Parameters + ---------- + dataset : xr.Dataset + Dataset to search data variable coordinate metadata attribute + match_list : list (str) + List of possible matches to search for. For example, + ['lat', 'latitude'] would search for variables in the + 'coordinates' metadata attribute containing either 'lat' + or 'latitude' + + Returns + ------- + list (str) + List of matching coordinate variables names + """ + coord_attrs = [ + var.attrs['coordinates'] for var_name, var in dataset.data_vars.items() + if 'coordinates' in var.attrs + ] + coord_attrs = list(set(coord_attrs)) + match_coord_vars = [] + for coord_attr in coord_attrs: + coords = coord_attr.split(' ') + match_vars = [ + coord for coord in coords + if any(coord_cand in coord for coord_cand in match_list) + ] + if match_vars and match_vars[0] in dataset: + # Check if the var actually exists in the dataset + match_coord_vars.append(match_vars[0]) + return match_coord_vars
+ + + +
+[docs] +def compute_coordinate_variable_names(dataset: xr.Dataset) -> Tuple[Union[List[str], str], Union[List[str], str]]: + """ + Given a dataset, determine the coordinate variable from a list + of options + + Parameters + ---------- + dataset: xr.Dataset + The dataset to find the coordinate variables for + + Returns + ------- + tuple, str + Tuple of strings (or list of strings), where the first element is the lat coordinate + name and the second element is the lon coordinate name + """ + + dataset = xr.decode_cf(dataset) + + # look for lon and lat using standard name in coordinates and axes + custom_criteria = { + "latitude": { + "standard_name": "latitude|projection_y_coordinate", + }, + "longitude": { + "standard_name": "longitude|projection_x_coordinate", + } + } + + possible_lat_coord_names = ['lat', 'latitude', 'y'] + possible_lon_coord_names = ['lon', 'longitude', 'x'] + + def var_is_coord(var_name, possible_coord_names): + var_name = var_name.strip(GROUP_DELIM).split(GROUP_DELIM)[-1] + return var_name.lower() in possible_coord_names + + lat_coord_names = list(filter( + lambda var_name: var_is_coord(var_name, possible_lat_coord_names), dataset.variables)) + lon_coord_names = list(filter( + lambda var_name: var_is_coord(var_name, possible_lon_coord_names), dataset.variables)) + + if len(lat_coord_names) < 1 or len(lon_coord_names) < 1: + lat_coord_names = find_matching_coords(dataset, possible_lat_coord_names) + lon_coord_names = find_matching_coords(dataset, possible_lon_coord_names) + + # Couldn't find lon lat in data variables look in coordinates + if len(lat_coord_names) < 1 or len(lon_coord_names) < 1: + with cfxr.set_options(custom_criteria=custom_criteria): + lat_coord_names = dataset.cf.coordinates.get('latitude', []) + lon_coord_names = dataset.cf.coordinates.get('longitude', []) + + if len(lat_coord_names) < 1 or len(lon_coord_names) < 1: + try: + lat_coord_names = [dataset.cf["latitude"].name] + lon_coord_names = [dataset.cf["longitude"].name] + except KeyError: + pass + + if len(lat_coord_names) < 1 or len(lon_coord_names) < 1: + raise ValueError('Could not determine coordinate variables') + + return lat_coord_names, lon_coord_names
+ + + +
+[docs] +def is_360(lon_var: xr.DataArray, scale: float, offset: float) -> bool: + """ + Determine if given dataset is a '360' dataset or not. + + Parameters + ---------- + lon_var : xr.DataArray + The lon variable from the xarray Dataset + scale : float + Used to remove scale and offset for easier calculation + offset : float + Used to remove scale and offset for easier calculation + + Returns + ------- + bool + True if dataset is 360, False if not. Defaults to False. + """ + valid_min = lon_var.attrs.get('valid_min', None) + + if valid_min is None or valid_min > 0: + var_min = remove_scale_offset(np.amin(lon_var.values), scale, offset) + var_max = remove_scale_offset(np.amax(lon_var.values), scale, offset) + + if var_min < 0: + return False + if var_max > 180: + return True + + if valid_min == 0: + return True + if valid_min < 0: + return False + + return False
+ + + +
+[docs] +def get_spatial_bounds(dataset: xr.Dataset, lat_var_names: str, lon_var_names: str) -> Union[np.ndarray, None]: + """ + Get the spatial bounds for this dataset. These values are masked + and scaled. + + Parameters + ---------- + dataset : xr.Dataset + Dataset to retrieve spatial bounds for + lat_var_names : str + Name of the lat variable + lon_var_names : str + Name of the lon variable + + Returns + ------- + np.array + [[lon min, lon max], [lat min, lat max]] + """ + + lat_var_name = lat_var_names[0] if len(lat_var_names) == 1 else [ + lat_name for lat_name in lat_var_names if lat_name in dataset.data_vars.keys() + ][0] + lon_var_name = lon_var_names[0] if len(lon_var_names) == 1 else [ + lon_name for lon_name in lon_var_names if lon_name in dataset.data_vars.keys() + ][0] + + # Get scale from coordinate variable metadata attributes + lat_scale = dataset[lat_var_name].attrs.get('scale_factor', 1.0) + lon_scale = dataset[lon_var_name].attrs.get('scale_factor', 1.0) + lat_offset = dataset[lat_var_name].attrs.get('add_offset', 0.0) + lon_offset = dataset[lon_var_name].attrs.get('add_offset', 0.0) + lon_valid_min = dataset[lon_var_name].attrs.get('valid_min', None) + lat_fill_value = dataset[lat_var_name].attrs.get('_FillValue', None) + lon_fill_value = dataset[lon_var_name].attrs.get('_FillValue', None) + + # Apply mask and scale to min/max coordinate variables to get + # spatial bounds + + # Remove fill value. Might cause errors when getting min and max + lats = dataset[lat_var_name].values.flatten() + lons = dataset[lon_var_name].values.flatten() + + if lat_fill_value: + lats = list(filter(lambda a: not a == lat_fill_value, lats)) + if lon_fill_value: + lons = list(filter(lambda a: not a == lon_fill_value, lons)) + + if len(lats) == 0 or len(lons) == 0: + return None + + min_lat = remove_scale_offset(np.nanmin(lats), lat_scale, lat_offset) + max_lat = remove_scale_offset(np.nanmax(lats), lat_scale, lat_offset) + min_lon = remove_scale_offset(np.nanmin(lons), lon_scale, lon_offset) + max_lon = remove_scale_offset(np.nanmax(lons), lon_scale, lon_offset) + + min_lat = round(min_lat, 1) + max_lat = round(max_lat, 1) + min_lon = round(min_lon, 1) + max_lon = round(max_lon, 1) + + # Convert longitude to [-180,180] format + if lon_valid_min == 0 or 0 <= min_lon <= max_lon <= 360: + if min_lon > 180: + min_lon -= 360 + if max_lon > 180: + max_lon -= 360 + if min_lon == max_lon: + min_lon = -180 + max_lon = 180 + + return np.array([[min_lon, max_lon], [min_lat, max_lat]])
+ + + +
+[docs] +def compute_time_variable_name(dataset: xr.Dataset, lat_var: xr.Variable, total_time_vars: list) -> str: + """ + Try to determine the name of the 'time' variable. This is done as + follows: + + - The variable name contains 'time' + - The variable dimensions match the dimensions of the given lat var + - The variable that hasn't already been found + + Parameters + ---------- + dataset : xr.Dataset + xarray dataset to find time variable from + lat_var : xr.Variable + Lat variable for this dataset + + Returns + ------- + str + The name of the variable + + Raises + ------ + ValueError + If the time variable could not be determined + """ + + time_vars = find_matching_coords(dataset, ['time']) + if time_vars: + # There should only be one time var match (this is called once + # per lat var) + return time_vars[0] + + # Filter variables with 'time' in the name to avoid extra work + time_vars = list(filter(lambda var_name: 'time' in var_name, dataset.sizes.keys())) + + for var_name in time_vars: + if var_name not in total_time_vars and "time" in var_name and dataset[var_name].squeeze().dims == lat_var.squeeze().dims: + return var_name + + # first check if any variables are named 'time' + for var_name in list(dataset.data_vars.keys()): + var_name_time = var_name.strip(GROUP_DELIM).split(GROUP_DELIM)[-1] + if len(dataset[var_name].squeeze().dims) == 0: + continue + if var_name not in total_time_vars and ('time' == var_name_time.lower() or 'timeMidScan' == var_name_time) and dataset[var_name].squeeze().dims[0] in lat_var.squeeze().dims: + return var_name + + time_units_pattern = re.compile(r"(days|d|hours|hr|h|minutes|min|m|seconds|sec|s) since \d{4}-\d{2}-\d{2}( \d{2}:\d{2}:\d{2})?") + # Check variables for common time variable indicators + for var_name, var in dataset.variables.items(): + # pylint: disable=too-many-boolean-expressions + if ((('standard_name' in var.attrs and var.attrs['standard_name'] == 'time') or + ('axis' in var.attrs and var.attrs['axis'] == 'T') or + ('units' in var.attrs and time_units_pattern.match(var.attrs['units'])))) and var_name not in total_time_vars: + return var_name + + # then check if any variables have 'time' in the string if the above loop doesn't return anything + for var_name in list(dataset.data_vars.keys()): + var_name_time = var_name.strip(GROUP_DELIM).split(GROUP_DELIM)[-1] + if len(dataset[var_name].squeeze().dims) == 0: + continue + if var_name not in total_time_vars and 'time' in var_name_time.lower() and dataset[var_name].squeeze().dims[0] in lat_var.squeeze().dims: + return var_name + + raise ValueError('Unable to determine time variable')
+ + + +
+[docs] +def compute_utc_name(dataset: xr.Dataset) -> Union[str, None]: + """ + Get the name of the utc variable if it is there to determine origine time + """ + for var_name in list(dataset.data_vars.keys()): + if 'utc' in var_name.lower() and 'time' in var_name.lower(): + return var_name + + return None
+ + + +
+[docs] +def translate_longitude(geometry): + """ + Translates the longitude values of a Shapely geometry from the range [-180, 180) to [0, 360). + + Parameters + ---------- + geometry : shapely.geometry.base.BaseGeometry + The input shape geometry to be translated + + Returns + ------- + geometry + The translated shape geometry + """ + + def translate_point(point): + # Translate the point's x-coordinate (longitude) by adding 360 + return Point((point.x + 360) % 360, point.y) + + def translate_polygon(polygon): + def translate_coordinates(coords): + if len(coords[0]) == 2: + return [((x + 360) % 360, y) for x, y in coords] + if len(coords[0]) == 3: + return [((x + 360) % 360, y, z) for x, y, z in coords] + return coords + + exterior = translate_coordinates(polygon.exterior.coords) + + interiors = [ + translate_coordinates(ring.coords) + for ring in polygon.interiors + ] + + return Polygon(exterior, interiors) + + if isinstance(geometry, (Point, Polygon)): # pylint: disable=no-else-return + return translate_point(geometry) if isinstance(geometry, Point) else translate_polygon(geometry) + elif isinstance(geometry, MultiPolygon): + # Translate each polygon in the MultiPolygon + translated_polygons = [translate_longitude(subgeometry) for subgeometry in geometry.geoms] + return MultiPolygon(translated_polygons) + else: + # Handle other geometry types as needed + return geometry
+ + + +
+[docs] +def get_time_epoch_var(dataset: xr.Dataset, time_var_name: str) -> str: + """ + Get the name of the epoch time var. This is only needed in the case + where there is a single time var (of size 1) that contains the time + epoch used by the actual time var. + + Parameters + ---------- + dataset : xr.Dataset + Dataset that contains time var + time_var_name : str + The name of the actual time var (with matching dims to the + coord vars) + + Returns + ------- + str + The name of the epoch time variable + """ + time_var = dataset[time_var_name] + + if 'comment' in time_var.attrs: + epoch_var_name = time_var.attrs['comment'].split('plus')[0].strip() + elif 'time' in dataset.variables.keys() and time_var_name != 'time': + epoch_var_name = 'time' + elif any('time' in s for s in list(dataset.variables.keys())) and time_var_name != 'time': + for i in list(dataset.variables.keys()): + group_list = i.split(GROUP_DELIM) + if group_list[-1] == 'time': + epoch_var_name = i + break + return epoch_var_name + else: + raise ValueError('Unable to determine time variables') + + return epoch_var_name
+ + + +
+[docs] +def is_time_mjd(dataset: xr.Dataset, time_var_name: str) -> bool: + """ + Check to see if the time format is a time delta from a modified julian date. + + Parameters + ---------- + dataset : xr.Dataset + Dataset that contains time var + time_var_name : str + The name of the actual time var (with matching dims to the + coord vars) + + Returns + ------- + boolean + is time delta format in modified julian date + """ + time_var = dataset[time_var_name] + if 'comment' in time_var.attrs: + if 'Modified Julian Day' in time_var.attrs['comment']: + return True + return False
+ + + +
+[docs] +def translate_timestamp(str_timestamp: str) -> datetime.datetime: + """ + Translate timestamp to datetime object + + Parameters + ---------- + str_timestamp : str + Timestamp string. ISO or RFC + + Returns + ------- + datetime + Constructed Datetime object + """ + allowed_ts_formats = [ + '%Y-%m-%dT%H:%M:%SZ', + '%Y-%m-%dT%H:%M:%S%Z', + '%Y-%m-%dT%H:%M:%S.%fZ', + '%Y-%m-%dT%H:%M:%S.%f%Z', + '%Y-%m-%d %H:%M:%S', + ] + + for timestamp_format in allowed_ts_formats: + try: + return datetime.datetime.strptime(str_timestamp, timestamp_format) + except ValueError: + pass + return datetime.datetime.fromisoformat(str_timestamp)
+ + + +
+[docs] +def datetime_from_mjd(dataset: xr.Dataset, time_var_name: str) -> Union[datetime.datetime, None]: + """ + Translate the modified julian date from the long name in the time attribute. + + Parameters + ---------- + dataset : xr.Dataset + Dataset that contains time var + time_var_name : str + The name of the actual time var (with matching dims to the + coord vars) + + Returns + ------- + datetime + the datetime of the modified julian date + """ + + time_var = dataset[time_var_name] + if 'long_name' in time_var.attrs: + mdj_string = time_var.attrs['long_name'] + mjd = mdj_string[mdj_string.find("(") + 1:mdj_string.find(")")].split("= ")[1] + try: + mjd_float = float(mjd) + except ValueError: + return None + mjd_datetime = julian.from_jd(mjd_float, fmt='mjd') + return mjd_datetime + + return None
+ + + +
+[docs] +def build_temporal_cond(min_time: str, max_time: str, dataset: xr.Dataset, time_var_name: str + ) -> Union[np.ndarray, bool]: + """ + Build the temporal condition used in the xarray 'where' call which + drops data not in the given bounds. If the data in the time var is + of type 'datetime', assume this is a normal case where the time var + uses the epoch from the 'units' metadata attribute to get epoch. If + the data in the time var is of type 'timedelta', the epoch var is + needed to calculate the datetime. + + Parameters + ---------- + min_time : str + ISO timestamp representing the lower temporal bound + max_time : str + ISO timestamp representing the upper temporal bound + dataset : xr.Dataset + Dataset to build the condition off of + time_var_name : str + Name of the time variable + + Returns + ------- + np.array or boolean + If temporally subsetted, returns a boolean ND-array the shape + of which matches the dimensions of the coordinate vars. 'True' + is essentially a noop. + """ + + def build_cond(str_timestamp, compare): + timestamp = translate_timestamp(str_timestamp) + if np.issubdtype(dataset[time_var_name].dtype, np.dtype(np.datetime64)): + timestamp = pd.to_datetime(timestamp) + if np.issubdtype(dataset[time_var_name].dtype, np.dtype(np.timedelta64)): + if is_time_mjd(dataset, time_var_name): + mjd_datetime = datetime_from_mjd(dataset, time_var_name) + if mjd_datetime is None: + raise ValueError('Unable to get datetime from dataset to calculate time delta') + + # timedelta between timestamp and mjd + timestamp = np.datetime64(timestamp) - np.datetime64(mjd_datetime) + else: + epoch_time_var_name = get_time_epoch_var(dataset, time_var_name) + epoch_datetime = dataset[epoch_time_var_name].values[0] + timestamp = np.datetime64(timestamp) - epoch_datetime + + time_data = dataset[time_var_name] + if getattr(time_data, 'long_name', None) == "reference time of sst file": + timedelta_seconds = dataset['sst_dtime'].astype('timedelta64[s]') + time_data = time_data + timedelta_seconds + + return compare(time_data, timestamp) + + temporal_conds = [] + if min_time: + comparison_op = operator.ge + temporal_conds.append(build_cond(min_time, comparison_op)) + if max_time: + comparison_op = operator.le + temporal_conds.append(build_cond(max_time, comparison_op)) + temporal_cond = True + if min_time or max_time: + temporal_cond = functools.reduce(lambda cond_a, cond_b: cond_a & cond_b, temporal_conds) + return temporal_cond
+ + + +
+[docs] +def get_base_group_names(lats: List[str]) -> Tuple[List[str], List[Union[int, str]]]: # pylint: disable=too-many-branches + """Latitude groups may be at different depths. This function gets the level + number that makes each latitude group unique from the other latitude names""" + unique_groups = [] + group_list = [lat.strip(GROUP_DELIM).split(GROUP_DELIM) for lat in lats] + + # make all lists of group levels the same length + group_list = list(zip(*zip_longest(*group_list, fillvalue=''))) + + # put the groups in the same levels in the same list + group_list_transpose = np.array(group_list).T.tolist() + + diff_count = ['' for _ in range(len(group_list))] + group_count = 0 + # loop through each group level + for my_list in group_list_transpose: + for i in range(len(my_list)): # pylint: disable=consider-using-enumerate + count = 0 + for j in range(len(my_list)): # pylint: disable=consider-using-enumerate + # go through each lat name and compare the level names + if my_list[i] == my_list[j] and not isinstance(diff_count[j], int): + count += 1 + # if the lat names is equivalent to only itself then insert the level number + if count == 1: + if isinstance(diff_count[i], int): + continue + if 'lat' in my_list[i].lower(): # if we get to the end of the list, go to the previous level + diff_count[i] = group_count - 1 + continue + + diff_count[i] = group_count + + group_count += 1 + + # go back and re-put together the unique groups + for lat in enumerate(lats): + unique_groups.append(f'{GROUP_DELIM}{GROUP_DELIM.join(lat[1].strip(GROUP_DELIM).split(GROUP_DELIM)[:(diff_count[lat[0]]+1)])}') + return unique_groups, diff_count
+ + + +
+[docs] +def subset_with_bbox(dataset: xr.Dataset, # pylint: disable=too-many-branches + lat_var_names: list, + lon_var_names: list, + time_var_names: list, + variables: Optional[List[str]] = None, + bbox: np.ndarray = None, + cut: bool = True, + min_time: str = None, + max_time: str = None) -> np.ndarray: + """ + Subset an xarray Dataset using a spatial bounding box. + + Parameters + ---------- + dataset : xr.Dataset + Dataset to subset + lat_var_names : list + Name of the latitude variables in the given dataset + lon_var_names : list + Name of the longitude variables in the given dataset + time_var_names : list + Name of the time variables in the given dataset + variables : list[str] + List of variables to include in the result + bbox : np.array + Spatial bounding box to subset Dataset with. + cut : bool + True if scanline should be cut. + min_time : str + ISO timestamp of min temporal bound + max_time : str + ISO timestamp of max temporal bound + TODO: add docstring and type hint for `variables` parameter. + + Returns + ------- + np.array + Spatial bounds of Dataset after subset operation + TODO - fix this docstring type and the type hint to match code (currently returning a list[xr.Dataset]) + """ + lon_bounds, lat_bounds = convert_bbox(bbox, dataset, lat_var_names[0], lon_var_names[0]) + # condition should be 'or' instead of 'and' when bbox lon_min > lon_max + oper = operator.and_ + + if lon_bounds[0] > lon_bounds[1]: + oper = operator.or_ + + # get unique group names for latitude coordinates + diff_count = [-1] + if len(lat_var_names) > 1: + unique_groups, diff_count = get_base_group_names(lat_var_names) + else: + unique_groups = [f'{GROUP_DELIM}{GROUP_DELIM.join(x.strip(GROUP_DELIM).split(GROUP_DELIM)[:-1])}' for x in lat_var_names] + + datasets = [] + total_list = [] # don't include repeated variables + for lat_var_name, lon_var_name, time_var_name, diffs in zip( # pylint: disable=too-many-nested-blocks + lat_var_names, lon_var_names, time_var_names, diff_count + ): + if GROUP_DELIM in lat_var_name: + lat_var_prefix = GROUP_DELIM.join(lat_var_name.strip(GROUP_DELIM).split(GROUP_DELIM)[:(diffs+1)]) + + if diffs == -1: # if the lat name is in the root group: take only the root group vars + group_vars = list(dataset.data_vars.keys()) + # include the coordinate variables if user asks for + group_vars.extend([ + var for var in list(dataset.coords.keys()) + if var in variables and var not in group_vars + ]) + else: + group_vars = [ + var for var in dataset.data_vars.keys() + if GROUP_DELIM.join(var.strip(GROUP_DELIM).split(GROUP_DELIM)[:(diffs+1)]) == lat_var_prefix + ] + # include variables that aren't in a latitude group + if variables: + group_vars.extend([ + var for var in dataset.variables.keys() + if (var in variables and + var not in group_vars and + var not in total_list and + not var.startswith(tuple(unique_groups)) + ) + ]) + else: + group_vars.extend([ + var for var in dataset.data_vars.keys() + if (var not in group_vars and + var not in total_list and + not var.startswith(tuple(unique_groups)) + ) + ]) + + # group dimensions do not get carried over if unused by data variables (MLS nTotalTimes var) + # get all dimensions from data variables + dim_list = [] + for var in group_vars: + dim_list.extend(list(list(dataset[var].dims))) + # get all group dimensions + group_dims = [ + dim for dim in list(dataset.coords.keys()) + if GROUP_DELIM.join(dim.strip(GROUP_DELIM).split(GROUP_DELIM)[:(diffs+1)]) == lat_var_prefix + ] + # include any group dimensions that aren't accounted for in variable dimensions + var_included = list(set(group_dims) - set(dim_list)) + group_vars.extend(var_included) + + else: + group_vars = list(dataset.keys()) + + group_dataset = dataset[group_vars] + + # Calculate temporal conditions + temporal_cond = build_temporal_cond(min_time, max_time, group_dataset, time_var_name) + + group_dataset = xre.where( + group_dataset, + oper( + (group_dataset[lon_var_name] >= lon_bounds[0]), + (group_dataset[lon_var_name] <= lon_bounds[1]) + ) & + (group_dataset[lat_var_name] >= lat_bounds[0]) & + (group_dataset[lat_var_name] <= lat_bounds[1]) & + temporal_cond, + cut + ) + + datasets.append(group_dataset) + total_list.extend(group_vars) + if diffs == -1: + return datasets + dim_cleaned_datasets = dc.recreate_pixcore_dimensions(datasets) + return dim_cleaned_datasets
+ + + +
+[docs] +def subset_with_shapefile(dataset: xr.Dataset, + lat_var_name: str, + lon_var_name: str, + shapefile: str, + cut: bool, + chunks) -> np.ndarray: + """ + Subset an xarray Dataset using a shapefile + + Parameters + ---------- + dataset : xr.Dataset + Dataset to subset + lat_var_name : str + Name of the latitude variable in the given dataset + lon_var_name : str + Name of the longitude variable in the given dataset + shapefile : str + Absolute path to the shapefile used to subset the given dataset + cut : bool + True if scanline should be cut. + TODO: add docstring and type hint for `chunks` parameter. + + Returns + ------- + np.array + Spatial bounds of Dataset after shapefile subset operation + TODO - fix this docstring type and the type hint to match code (currently returning a xr.Dataset) + """ + shapefile_df = gpd.read_file(shapefile) + + lat_scale = dataset[lat_var_name].attrs.get('scale_factor', 1.0) + lon_scale = dataset[lon_var_name].attrs.get('scale_factor', 1.0) + lat_offset = dataset[lat_var_name].attrs.get('add_offset', 0.0) + lon_offset = dataset[lon_var_name].attrs.get('add_offset', 0.0) + + # If data is '360', convert shapefile to '360' as well. There is an + # assumption that the shapefile is -180,180. + if is_360(dataset[lon_var_name], lon_scale, lon_offset): + # Transform + shapefile_df.geometry = shapefile_df['geometry'].apply(translate_longitude) + + # Mask and scale shapefile + def scale(lon, lat, extra=None): # pylint: disable=unused-argument + lon = tuple(map(functools.partial(apply_scale_offset, lon_scale, lon_offset), lon)) + lat = tuple(map(functools.partial(apply_scale_offset, lat_scale, lat_offset), lat)) + return lon, lat + + geometries = [transform(scale, geometry) for geometry in shapefile_df.geometry] + shapefile_df.geometry = geometries + + def in_shape(lon, lat): + point = Point(lon, lat) + point_in_shapefile = shapefile_df.contains(point) + return point_in_shapefile.array[0] + + dask = "forbidden" + if chunks: + dask = "allowed" + + in_shape_vec = np.vectorize(in_shape) + boolean_mask = xr.apply_ufunc(in_shape_vec, dataset[lon_var_name], dataset[lat_var_name], dask=dask) + return xre.where(dataset, boolean_mask, cut)
+ + + +
+[docs] +def get_coordinate_variable_names(dataset: xr.Dataset, + lat_var_names: list = None, + lon_var_names: list = None, + time_var_names: list = None): + """ + Retrieve coordinate variables for this dataset. If coordinate + variables are provided, use those, Otherwise, attempt to determine + coordinate variables manually. + + Parameters + ---------- + dataset : xr.Dataset + xarray Dataset used to compute coordinate variables manually. + Only used if lat, lon, or time vars are not provided. + lat_var_names : list + List of latitude coordinate variables. + lon_var_names : list + List of longitude coordinate variables. + time_var_names : list + List of time coordinate variables. + + Returns + ------- + TODO: add return type docstring and type hint. + """ + + if not lat_var_names or not lon_var_names: + lat_var_names, lon_var_names = compute_coordinate_variable_names(dataset) + if not time_var_names: + time_var_names = [] + for lat_var_name in lat_var_names: + time_var_names.append(compute_time_variable_name(dataset, + dataset[lat_var_name], + time_var_names)) + + time_var_names.append(compute_utc_name(dataset)) + time_var_names = [x for x in time_var_names if x is not None] # remove Nones and any duplicates + + return lat_var_names, lon_var_names, time_var_names
+ + + +
+[docs] +def open_as_nc_dataset(filepath: str) -> Tuple[nc.Dataset, bool]: + """Open netcdf file, and flatten groups if they exist.""" + hdf_type = None + # Open dataset with netCDF4 first, so we can get group info + try: + nc_dataset = nc.Dataset(filepath, mode='r') + has_groups = bool(nc_dataset.groups) + # If dataset has groups, transform to work with xarray + if has_groups: + nc_dataset = transform_grouped_dataset(nc_dataset, filepath) + + except OSError: + nc_dataset, has_groups, hdf_type = h5file_transform(filepath) + + nc_dataset = dc.remove_duplicate_dims(nc_dataset) + + return nc_dataset, has_groups, hdf_type
+ + + +
+[docs] +def override_decode_cf_datetime() -> None: + """ + WARNING !!! REMOVE AT EARLIEST XARRAY FIX, this is a override to xarray override_decode_cf_datetime function. + xarray has problems decoding time units with format `seconds since 2000-1-1 0:0:0 0`, this solves by testing + the unit to see if its parsable, if it is use original function, if not format unit into a parsable format. + + https://github.com/pydata/xarray/issues/7210 + """ + + orig_decode_cf_datetime = xarray.coding.times.decode_cf_datetime + + def decode_cf_datetime(num_dates, units, calendar=None, use_cftime=None): + try: + parser.parse(units.split('since')[-1]) + return orig_decode_cf_datetime(num_dates, units, calendar, use_cftime) + except dateutil.parser.ParserError: + reference_time = cftime.num2date(0, units, calendar) + units = f"{units.split('since')[0]} since {reference_time}" + return orig_decode_cf_datetime(num_dates, units, calendar, use_cftime) + + xarray.coding.times.decode_cf_datetime = decode_cf_datetime
+ + + +
+[docs] +def test_access_sst_dtime_values(datafile): + """ + Test accessing values of 'sst_dtime' variable in a NetCDF file. + + Parameters + ---------- + datafile (str): Path to the NetCDF file. + + Returns + ------- + access_successful (bool): True if 'sst_dtime' values are accessible, False otherwise. + """ + + nc_dataset, _, _ = open_as_nc_dataset(datafile) + args = { + 'decode_coords': False, + 'mask_and_scale': True, + 'decode_times': True + } + try: + with xr.open_dataset( + xr.backends.NetCDF4DataStore(nc_dataset), + **args + ) as dataset: + # pylint: disable=pointless-statement + for var_name in dataset.variables: + dataset[var_name].values + except (TypeError, ValueError, KeyError): + return False + return True
+ + + +
+[docs] +def subset(file_to_subset: str, bbox: np.ndarray, output_file: str, + variables: Union[List[str], str, None] = (), + # pylint: disable=too-many-branches, disable=too-many-statements + cut: bool = True, shapefile: str = None, min_time: str = None, max_time: str = None, + origin_source: str = None, + lat_var_names: List[str] = (), lon_var_names: List[str] = (), time_var_names: List[str] = () + ) -> Union[np.ndarray, None]: + """ + Subset a given NetCDF file given a bounding box + + Parameters + ---------- + file_to_subset : string + The location of the file which will be subset + bbox : np.ndarray + The chosen bounding box. This is a tuple of tuples formatted + as such: ((west, east), (south, north)). The assumption is that + the valid range is ((-180, 180), (-90, 90)). This will be + transformed as appropriate if the actual longitude range is + 0-360. + output_file : string + The file path for the output of the subsetting operation. + variables : list, str, optional + List of variables to include in the resulting data file. + NOTE: This will remove ALL variables which are not included + in this list, including coordinate variables! + cut : boolean + True if the scanline should be cut, False if the scanline should + not be cut. Defaults to True. + shapefile : str + Name of local shapefile used to subset given file. + min_time : str + ISO timestamp representing the lower bound of the temporal + subset to be performed. If this value is not provided, the + granule will not be subset temporally on the lower bound. + max_time : str + ISO timestamp representing the upper bound of the temporal + subset to be performed. If this value is not provided, the + granule will not be subset temporally on the upper bound. + origin_source : str + Original location or filename of data to be used in "derived from" + history element. + lat_var_names : list + List of variables that represent the latitude coordinate + variables for this granule. This list will only contain more + than one value in the case where there are multiple groups and + different coordinate variables for each group. + lon_var_names : list + List of variables that represent the longitude coordinate + variables for this granule. This list will only contain more + than one value in the case where there are multiple groups and + different coordinate variables for each group. + time_var_names : list + List of variables that represent the time coordinate + variables for this granule. This list will only contain more + than one value in the case where there are multiple groups and + different coordinate variables for each group. + """ + file_extension = os.path.splitext(file_to_subset)[1] + nc_dataset, has_groups, hdf_type = open_as_nc_dataset(file_to_subset) + + override_decode_cf_datetime() + + if has_groups: + # Make sure all variables start with '/' + if variables: + variables = ['/' + var if not var.startswith('/') else var for var in variables] + lat_var_names = ['/' + var if not var.startswith('/') else var for var in lat_var_names] + lon_var_names = ['/' + var if not var.startswith('/') else var for var in lon_var_names] + time_var_names = ['/' + var if not var.startswith('/') else var for var in time_var_names] + # Replace all '/' with GROUP_DELIM + if variables: + variables = [var.replace('/', GROUP_DELIM) for var in variables] + lat_var_names = [var.replace('/', GROUP_DELIM) for var in lat_var_names] + lon_var_names = [var.replace('/', GROUP_DELIM) for var in lon_var_names] + time_var_names = [var.replace('/', GROUP_DELIM) for var in time_var_names] + + if '.HDF5' == file_extension: + # GPM files will have a ScanTime group + if 'ScanTime' in [var.split('__')[-2] for var in list(nc_dataset.variables.keys())]: + gc.change_var_dims(nc_dataset, variables) + hdf_type = 'GPM' + args = { + 'decode_coords': False, + 'mask_and_scale': False, + 'decode_times': False + } + # clean up time variable in SNDR before decode_times + # SNDR.AQUA files have ascending node time blank + if any('__asc_node_tai93' in i for i in list(nc_dataset.variables)): + asc_time_var = nc_dataset.variables['__asc_node_tai93'] + if not asc_time_var[:] > 0: + del nc_dataset.variables['__asc_node_tai93'] + + if min_time or max_time: + args['decode_times'] = True + float_dtypes = ['float64', 'float32'] + fill_value_f8 = nc.default_fillvals.get('f8') + + for time_variable in (v for v in nc_dataset.variables.keys() if 'time' in v): + time_var = nc_dataset[time_variable] + + if (getattr(time_var, '_FillValue', None) == fill_value_f8 and time_var.dtype in float_dtypes) or \ + (getattr(time_var, 'long_name', None) == "reference time of sst file"): + args['mask_and_scale'] = True + if getattr(time_var, 'long_name', None) == "reference time of sst file": + args['mask_and_scale'] = test_access_sst_dtime_values(file_to_subset) + break + + if hdf_type == 'GPM': + args['decode_times'] = False + + with xr.open_dataset( + xr.backends.NetCDF4DataStore(nc_dataset), + **args + ) as dataset: + + original_dataset = dataset + + lat_var_names, lon_var_names, time_var_names = get_coordinate_variable_names( + dataset=dataset, + lat_var_names=lat_var_names, + lon_var_names=lon_var_names, + time_var_names=time_var_names + ) + + start_date = None + if hdf_type and (min_time or max_time): + dataset, start_date = tc.convert_to_datetime(dataset, time_var_names, hdf_type) + + chunks = calculate_chunks(dataset) + if chunks: + dataset = dataset.chunk(chunks) + if variables: + # Drop variables that aren't explicitly requested, except lat_var_name and + # lon_var_name which are needed for subsetting + variables_upper = [variable.upper() for variable in variables] + vars_to_drop = [ + var_name for var_name, var in dataset.data_vars.items() + if var_name.upper() not in variables_upper + and var_name not in lat_var_names + and var_name not in lon_var_names + and var_name not in time_var_names + ] + + dataset = dataset.drop_vars(vars_to_drop) + if shapefile: + datasets = [ + subset_with_shapefile(dataset, lat_var_names[0], lon_var_names[0], shapefile, cut, chunks) + ] + elif bbox is not None: + datasets = subset_with_bbox( + dataset=dataset, + lat_var_names=lat_var_names, + lon_var_names=lon_var_names, + time_var_names=time_var_names, + variables=variables, + bbox=bbox, + cut=cut, + min_time=min_time, + max_time=max_time + ) + else: + raise ValueError('Either bbox or shapefile must be provided') + + spatial_bounds = [] + + for dataset in datasets: + set_version_history(dataset, cut, bbox, shapefile) + set_json_history(dataset, cut, file_to_subset, bbox, shapefile, origin_source) + if has_groups: + spatial_bounds.append(get_spatial_bounds( + dataset=dataset, + lat_var_names=lat_var_names, + lon_var_names=lon_var_names + )) + else: + for var in dataset.data_vars: + if dataset[var].dtype == 'S1' and isinstance(dataset[var].attrs.get('_FillValue'), bytes): + dataset[var].attrs['_FillValue'] = dataset[var].attrs['_FillValue'].decode('UTF-8') + + var_encoding = { + "zlib": True, + "complevel": 5, + "_FillValue": original_dataset[var].encoding.get('_FillValue') + } + + data_var = dataset[var].copy() + data_var.load().to_netcdf(output_file, 'a', encoding={var: var_encoding}) + del data_var + + with nc.Dataset(output_file, 'a') as dataset_attr: + dataset_attr.setncatts(dataset.attrs) + + if has_groups: + recombine_grouped_datasets(datasets, output_file, start_date, time_var_names) + # Check if the spatial bounds are all 'None'. This means the + # subset result is empty. + if any(bound is None for bound in spatial_bounds): + return None + return np.array([[ + min(lon[0][0][0] for lon in zip(spatial_bounds)), + max(lon[0][0][1] for lon in zip(spatial_bounds)) + ], [ + min(lat[0][1][0] for lat in zip(spatial_bounds)), + max(lat[0][1][1] for lat in zip(spatial_bounds)) + ]]) + + return get_spatial_bounds( + dataset=dataset, + lat_var_names=lat_var_names, + lon_var_names=lon_var_names + )
+ +
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/2.12.0a2/_modules/podaac/subsetter/subset_harmony.html b/2.12.0a2/_modules/podaac/subsetter/subset_harmony.html new file mode 100644 index 00000000..8d5be29a --- /dev/null +++ b/2.12.0a2/_modules/podaac/subsetter/subset_harmony.html @@ -0,0 +1,393 @@ + + + + + + podaac.subsetter.subset_harmony — l2ss-py 2.12.0a2 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Source code for podaac.subsetter.subset_harmony

+# Copyright 2019, by the California Institute of Technology.
+# ALL RIGHTS RESERVED. United States Government Sponsorship acknowledged.
+# Any commercial use must be negotiated with the Office of Technology
+# Transfer at the California Institute of Technology.
+#
+# This software may be subject to U.S. export control laws. By accepting
+# this software, the user agrees to comply with all applicable U.S. export
+# laws and regulations. User has the responsibility to obtain export
+# licenses, or other export authority as may be required before exporting
+# such information to foreign countries or providing access to foreign
+# persons.
+
+"""
+=================
+subset_harmony.py
+=================
+
+Implementation of harmony-service-lib that invokes the Level 2 subsetter.
+"""
+import argparse
+import os
+import subprocess
+import shutil
+from tempfile import mkdtemp
+from typing import List, Union
+
+import pystac
+from pystac import Asset
+
+import harmony
+import numpy as np
+from harmony import BaseHarmonyAdapter
+from harmony.util import download, stage, generate_output_filename, bbox_to_geometry
+
+from podaac.subsetter import subset
+from podaac.subsetter.subset import SERVICE_NAME
+
+DATA_DIRECTORY_ENV = "DATA_DIRECTORY"
+
+
+
+[docs] +def podaac_to_harmony_bbox(bbox: np.ndarray) -> Union[np.ndarray, float]: + """ + Convert PO.DAAC bbox ((west, east), (south, north)) + to Harmony bbox (west, south, east, north) + + Parameters + ---------- + bbox : np.array + Podaac bbox + + Returns + ------- + array, int or float + Harmony bbox + TODO - fix this docstring type, type hint, and code to match (code currently returns a list) + """ + + return_box = [bbox.item(0), bbox.item(2), bbox.item(1), bbox.item(3)] + return return_box
+ + + +
+[docs] +def harmony_to_podaac_bbox(bbox: list) -> np.ndarray: + """ + Convert Harmony bbox (west, south, east, north) + to PO.DAAC bbox ((west, east), (south, north)) + + Parameters + ---------- + bbox : list + Harmony bbox + + Returns + ------- + np.array + PO.DAAC bbox + """ + return np.array(((bbox[0], bbox[2]), + (bbox[1], bbox[3])))
+ + + +
+[docs] +class L2SubsetterService(BaseHarmonyAdapter): + """ + See https://github.com/nasa/harmony-service-lib-py + for documentation and examples. + """ + +
+[docs] + def __init__(self, message, catalog=None, config=None): + super().__init__(message, catalog, config) + + self.data_dir = os.getenv(DATA_DIRECTORY_ENV, '/home/dockeruser/data')
+ + +
+[docs] + def process_item(self, item: pystac.Item, source: harmony.message.Source) -> pystac.Item: + """ + Performs variable and bounding box subsetting on the input STAC Item's data, returning + an output STAC item + + Parameters + ---------- + item : pystac.Item + the item that should be subset + source : harmony.message.Source + the input source defining the variables, if any, to subset from the item + + Returns + ------- + pystac.Item + a STAC item describing the output of the subsetter + """ + result = item.clone() + result.assets = {} + + # Create a temporary dir for processing we may do + temp_dir = mkdtemp() + output_dir = self.data_dir + self.prepare_output_dir(output_dir) + + try: + # Get the data file + asset = next(v for k, v in item.assets.items() if 'data' in (v.roles or [])) + input_filename = download(asset.href, + temp_dir, + logger=self.logger, + access_token=self.message.accessToken, + cfg=self.config) + + message = self.message + + # Dictionary of keywords params that will be passed into + # the l2ss-py subset function + subset_params = {} + + # Transform params to PO.DAAC subsetter arguments and invoke the subsetter + harmony_bbox = [-180, -90, 180, 90] + + if message.subset and message.subset.bbox: + harmony_bbox = message.subset.bbox + + if message.subset and message.subset.shape: + subset_params['shapefile'] = download( + message.subset.shape.href, + temp_dir, + logger=self.logger, + access_token=self.message.accessToken, + cfg=self.config + ) + + if message.temporal: + subset_params['min_time'] = message.temporal.start + subset_params['max_time'] = message.temporal.end + + subset_params['bbox'] = harmony_to_podaac_bbox(harmony_bbox) + + try: + subset_params['cut'] = message.extraArgs['cut'] + except (KeyError, AttributeError, TypeError): + pass + + if source.variables: + subset_params['variables'] = [variable.name for variable in source.process('variables')] + + if source.coordinateVariables: + coordinate_variables = list( + filter(lambda var: var.type and var.subtype, source.coordinateVariables) + ) + + def filter_by_subtype(variables, subtype): + return list(map(lambda var: var.name, filter( + lambda var: var.subtype == subtype, variables + ))) + subset_params['lat_var_names'] = filter_by_subtype(coordinate_variables, 'LATITUDE') + subset_params['lon_var_names'] = filter_by_subtype(coordinate_variables, 'LONGITUDE') + subset_params['time_var_names'] = filter_by_subtype(coordinate_variables, 'TIME') + + subset_params['output_file'] = f'{output_dir}/{os.path.basename(input_filename)}' + subset_params['file_to_subset'] = input_filename + subset_params['origin_source'] = asset.href + + self.logger.info('Calling l2ss-py subset with params %s', subset_params) + result_bbox = subset.subset(**subset_params) + + # Stage the output file with a conventional filename + mime = 'application/x-netcdf4' + operations = { + "variable_subset": subset_params.get('variables'), + "is_subsetted": bool(result_bbox is not None) + } + staged_filename = generate_output_filename(asset.href, '.nc4', **operations) + + url = stage(subset_params['output_file'], + staged_filename, + mime, + location=message.stagingLocation, + logger=self.logger, + cfg=self.config) + + # Update the STAC record + asset = Asset(url, title=staged_filename, media_type=mime, roles=['data']) + result.assets['data'] = asset + if result_bbox is not None: + if message.subset: + message.subset.process('bbox') + bounding_box_array = np.array(podaac_to_harmony_bbox(result_bbox)) + if not np.all(np.isnan(bounding_box_array)): + result.bbox = podaac_to_harmony_bbox(result_bbox) + result.geometry = bbox_to_geometry(result.bbox) + + # Return the STAC record + return result + finally: + # Clean up any intermediate resources + shutil.rmtree(temp_dir)
+ + +
+[docs] + def prepare_output_dir(self, output_dir: str) -> None: + """ + Deletes (if present) and recreates the given output_dir, ensuring it exists + and is empty + + Parameters + ---------- + output_dir : string + the directory to delete and recreate + """ + self.cmd('rm', '-rf', output_dir) + self.cmd('mkdir', '-p', output_dir)
+ + +
+[docs] + def cmd(self, *args) -> List[str]: + """ + Logs and then runs command. + + Parameters + ---------- + args Command and args to run + + Returns + ------- + Command output + """ + self.logger.info("%s %s", args[0], " ".join(["'{}'".format(arg) for arg in args[1:]])) # pylint: disable=C0209 + result_str = subprocess.check_output(args).decode("utf-8") + return result_str.split("\n")
+
+ + + +
+[docs] +def main(config: harmony.util.Config = None) -> None: + """Parse command line arguments and invoke the service to respond to + them. + + Parameters + ---------- + config : harmony.util.Config + + Returns + ------- + None + """ + parser = argparse.ArgumentParser(prog=SERVICE_NAME, + description='Run the l2_subsetter service') + harmony.setup_cli(parser) + args = parser.parse_args() + if harmony.is_harmony_cli(args): + harmony.run_cli(parser, args, L2SubsetterService, cfg=config) + else: + parser.error("Only --harmony CLIs are supported")
+ + + +if __name__ == "__main__": + main() +
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/2.12.0a2/_modules/podaac/subsetter/xarray_enhancements.html b/2.12.0a2/_modules/podaac/subsetter/xarray_enhancements.html new file mode 100644 index 00000000..2be715db --- /dev/null +++ b/2.12.0a2/_modules/podaac/subsetter/xarray_enhancements.html @@ -0,0 +1,429 @@ + + + + + + podaac.subsetter.xarray_enhancements — l2ss-py 2.12.0a2 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Source code for podaac.subsetter.xarray_enhancements

+# Copyright 2019, by the California Institute of Technology.
+# ALL RIGHTS RESERVED. United States Government Sponsorship acknowledged.
+# Any commercial use must be negotiated with the Office of Technology
+# Transfer at the California Institute of Technology.
+#
+# This software may be subject to U.S. export control laws. By accepting
+# this software, the user agrees to comply with all applicable U.S. export
+# laws and regulations. User has the responsibility to obtain export
+# licenses, or other export authority as may be required before exporting
+# such information to foreign countries or providing access to foreign
+# persons.
+
+"""
+======================
+xarray_enhancements.py
+======================
+
+Functions which improve upon existing xarray functionality, optimized
+for this specific use-case.
+"""
+
+import logging
+from typing import Union
+
+import numpy as np
+import xarray as xr
+from podaac.subsetter import dimension_cleanup as dc
+
+
+
+[docs] +def get_indexers_from_1d(cond: xr.Dataset) -> dict: + """ + Get indexers from a dataset with 1 dimension. + + Parameters + ---------- + cond : xarray.Dataset + Contains the result of the initial lat lon condition. + + Returns + ------- + dict + Indexer dictionary for the provided condition. + """ + cols = cond.values + + if not cols.any(): + logging.info("No data within the given bounding box.") + + indexers = { + cond.dims[0]: np.where(cols)[0] + } + return indexers
+ + + +
+[docs] +def get_indexers_from_nd(cond: xr.Dataset, cut: bool) -> dict: + """ + Get indexers from a dataset with more than one dimension. + + Parameters + ---------- + cond : xarray.Dataset + Contains the result of the initial lat lon condition. + cut : bool + True if the scanline should be cut. + + Returns + ------- + dict + Indexer dictionary for the provided condition. + """ + # check if the lat/lon coordinate numpy array has 2 or more dimensions + transpose = False + if cond.values.squeeze().ndim == 2: + x_axis = 1 + y_axis = 0 + else: + if any('xtrack' in dim for dim in list(cond.dims)) and\ + any('atrack' in dim for dim in list(cond.dims)): + x_axis = list(cond.dims).index('xtrack') + y_axis = list(cond.dims).index('atrack') + transpose = True + else: + x_axis = 2 + y_axis = 1 + + rows = np.any(cond.values.squeeze(), axis=x_axis) + if cut: + cols = np.any(cond.values.squeeze(), axis=y_axis) + else: + cols = np.ones(len(cond.values[0])) + + # If the subsetted area is equal to the original area + if np.all(rows) & np.all(cols): + logging.info("Subsetted area equal to the original granule.") + + # If the subsetted area is empty + if not np.any(rows) | np.any(cols): + logging.info("No data within the given bounding box.") + + cond_shape_list = list(cond.shape) + cond_list = list(cond.dims) + output = [idx for idx, element in enumerate(cond_shape_list) if element == 1] + for i in output: + cond_list.pop(i) + + if rows.ndim == 1: + indexers = { + cond_list[0]: np.where(rows)[0], + cond_list[1]: np.where(cols)[0] + } + else: + # if the lat/lon had 3 dimensions the conditional array was identical in the z direction - taking the first + if transpose: + rows = rows.transpose()[0] + cols = cols.transpose()[0] + else: + rows = rows[0] + cols = cols[0] + indexers = { + cond_list[y_axis]: np.where(rows)[0], + cond_list[x_axis]: np.where(cols)[0] + } + + return indexers
+ + + +
+[docs] +def copy_empty_dataset(dataset: xr.Dataset) -> xr.Dataset: + """ + Copy a dataset into a new, empty dataset. This dataset should: + * Contain the same structure as the input dataset (only include + requested variables, if variable subset) + * Contain the same global metadata as the input dataset + * Contain a history field which describes this subset operation. + + Parameters + ---------- + dataset: xarray.Dataset + The dataset to copy into a empty dataset. + + Returns + ------- + xarray.Dataset + The new dataset which has no data. + """ + # Create a dict object where each key is a variable in the dataset and the value is an + # array initialized to the fill value for that variable or NaN if there is no fill value + # attribute for the variable + + empty_data = {k: np.full(v.shape, dataset.variables[k].attrs.get('_FillValue', np.nan), dtype=v.dtype) for k, v in dataset.items()} + + # Create a copy of the dataset filled with the empty data. Then select the first index along each + # dimension and return the result + return dataset.copy(data=empty_data).isel({dim: slice(0, 1, 1) for dim in dataset.dims})
+ + + +
+[docs] +def cast_type(var: xr.DataArray, var_type: str) -> xr.DataArray: + """ + Type cast a variable into a var type. + + Parameters + ---------- + var: xr.DataArray + The dataarray to be type casted. + var_type: string + New type the variable will be type casted to. + Returns + ------- + xr.DataArray + The newly type casted variable. + """ + + return var.astype(var_type)
+ + + +
+[docs] +def get_variables_with_indexers(dataset, indexers): + """ + returns a list of variables with bounding box dimensions and variables that + don't have bounding box dimensions + """ + index_list = list(indexers.keys()) + subset_vars = [] + no_subset_vars = [] + for i in list(dataset.variables.keys()): + variable_dims = list(dataset[i].dims) + if any(item in index_list for item in variable_dims): + subset_vars.append(i) + else: + no_subset_vars.append(i) + + return subset_vars, no_subset_vars
+ + + +
+[docs] +def where(dataset: xr.Dataset, cond: Union[xr.Dataset, xr.DataArray], cut: bool) -> xr.Dataset: + """ + Return a dataset which meets the given condition. + + This is a modification of the existing xarray 'where' function. + https://github.com/pydata/xarray/blob/master/xarray/core/common.py#L999 + + Parameters + ---------- + dataset : xarray.Dataset + The dataset to filter and return. + cond : DataArray or Dataset with boolean dtype + Locations at which to preserve this object's values. + cut : boolean + True if the scanline should be cut, False if the scanline should + not be cut. + + Returns + ------- + xarray.Dataset + The filtered Dataset + + Notes + ----- + The `cond` variable contains a boolean mask of valid data indices. + However in that mask, True represents valid data and False + represents invalid data. + """ + if cond.values.ndim == 1: + indexers = get_indexers_from_1d(cond) + else: + indexers = get_indexers_from_nd(cond, cut) + # If any of the indexer dimensions are empty, return an empty dataset + if not all(len(value) > 0 for value in indexers.values()): + return copy_empty_dataset(dataset) + + # This will be true if any variables in the dataset have a partial + # overlap with the coordinate dims. If so, the cond should be + # applied per-variable rather than to the entire dataset. + partial_dim_in_in_vars = np.any( + [len(set(indexers.keys()).intersection(var.dims)) > 0 and len( + indexers.keys() - var.dims) > 0 for _, var in dataset.variables.items()] + ) + + indexed_cond = cond.isel(**indexers) + indexed_ds = dataset.isel(**indexers) + subset_vars, non_subset_vars = get_variables_with_indexers(dataset, indexers) + + # dataset with variables that need to be subsetted + new_dataset_sub = indexed_ds[subset_vars].where(indexed_cond) + # data with variables that shouldn't be subsetted + new_dataset_non_sub = indexed_ds[non_subset_vars] + + # merge the datasets + new_dataset = xr.merge([new_dataset_non_sub, new_dataset_sub]) + + # Cast all variables to their original type + for variable_name, variable in new_dataset.data_vars.items(): + original_type = indexed_ds[variable_name].dtype + new_type = variable.dtype + indexed_var = indexed_ds[variable_name] + + if partial_dim_in_in_vars and (indexers.keys() - dataset[variable_name].dims) and set( + indexers.keys()).intersection(dataset[variable_name].dims): + + missing_dim = (indexers.keys() - dataset[variable_name].dims).pop() # Assume only 1 + var_indexers = { + dim_name: dim_value for dim_name, dim_value in indexers.items() + if dim_name in dataset[variable_name].dims + } + + var_cond = cond.any(axis=cond.dims.index(missing_dim)).isel(**var_indexers) + indexed_var = dataset[variable_name].isel(**var_indexers) + new_dataset[variable_name] = indexed_var.where(var_cond) + variable = new_dataset[variable_name] + elif partial_dim_in_in_vars and (indexers.keys() - dataset[variable_name].dims) and set( + indexers.keys()).intersection(new_dataset[variable_name].dims): + new_dataset[variable_name] = indexed_var + + new_dataset[variable_name].attrs = indexed_var.attrs + variable.attrs = indexed_var.attrs + # Check if variable has no _FillValue. If so, use original data + if '_FillValue' not in variable.attrs or len(indexed_var.shape) == 0: + + if original_type != new_type: + new_dataset[variable_name] = xr.apply_ufunc(cast_type, variable, + str(original_type), dask='allowed', + keep_attrs=True) + + # Replace nans with values from original dataset. If the + # variable has more than one dimension, copy the entire + # variable over, otherwise use a NaN mask to copy over the + # relevant values. + new_dataset[variable_name] = indexed_var + + new_dataset[variable_name].attrs = indexed_var.attrs + variable.attrs = indexed_var.attrs + new_dataset[variable_name].encoding['_FillValue'] = None + variable.encoding['_FillValue'] = None + + else: + # Manually replace nans with FillValue + # If variable represents time, cast _FillValue to datetime + fill_value = new_dataset[variable_name].attrs.get('_FillValue') + if np.issubdtype(new_dataset[variable_name].dtype, np.dtype(np.datetime64)): + fill_value = np.datetime64('nat') + if np.issubdtype(new_dataset[variable_name].dtype, np.dtype(np.timedelta64)): + fill_value = np.timedelta64('nat') + new_dataset[variable_name] = new_dataset[variable_name].fillna(fill_value) + if original_type != new_type: + new_dataset[variable_name] = xr.apply_ufunc(cast_type, new_dataset[variable_name], + str(original_type), dask='allowed', + keep_attrs=True) + + dc.sync_dims_inplace(dataset, new_dataset) + return new_dataset
+ +
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/2.12.0a2/_sources/index.rst.txt b/2.12.0a2/_sources/index.rst.txt new file mode 100644 index 00000000..04262c66 --- /dev/null +++ b/2.12.0a2/_sources/index.rst.txt @@ -0,0 +1,40 @@ +Reference Guide for l2ss-py +====================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + +.. mdinclude:: ../README.md + +Module Documentation +==================== + +.. automodule:: podaac.subsetter.subset + :members: + :special-members: + :private-members: + +.. automodule:: podaac.subsetter.subset_harmony + :members: + :special-members: + :private-members: + +.. automodule:: podaac.subsetter.run_subsetter + :members: + :special-members: + :private-members: + +.. automodule:: podaac.subsetter.xarray_enhancements + :members: + :special-members: + :private-members: + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/2.12.0a2/_static/_sphinx_javascript_frameworks_compat.js b/2.12.0a2/_static/_sphinx_javascript_frameworks_compat.js new file mode 100644 index 00000000..81415803 --- /dev/null +++ b/2.12.0a2/_static/_sphinx_javascript_frameworks_compat.js @@ -0,0 +1,123 @@ +/* Compatability shim for jQuery and underscores.js. + * + * Copyright Sphinx contributors + * Released under the two clause BSD licence + */ + +/** + * small helper function to urldecode strings + * + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL + */ +jQuery.urldecode = function(x) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} diff --git a/2.12.0a2/_static/basic.css b/2.12.0a2/_static/basic.css new file mode 100644 index 00000000..f316efcb --- /dev/null +++ b/2.12.0a2/_static/basic.css @@ -0,0 +1,925 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li p.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 360px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a:visited { + color: #551A8B; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +nav.contents, +aside.topic, +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +.sig dd { + margin-top: 0px; + margin-bottom: 0px; +} + +.sig dl { + margin-top: 0px; + margin-bottom: 0px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +.translated { + background-color: rgba(207, 255, 207, 0.2) +} + +.untranslated { + background-color: rgba(255, 207, 207, 0.2) +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/2.12.0a2/_static/css/badge_only.css b/2.12.0a2/_static/css/badge_only.css new file mode 100644 index 00000000..c718cee4 --- /dev/null +++ b/2.12.0a2/_static/css/badge_only.css @@ -0,0 +1 @@ +.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file diff --git a/2.12.0a2/_static/css/fonts/Roboto-Slab-Bold.woff b/2.12.0a2/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 00000000..6cb60000 Binary files /dev/null and b/2.12.0a2/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/2.12.0a2/_static/css/fonts/Roboto-Slab-Bold.woff2 b/2.12.0a2/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 00000000..7059e231 Binary files /dev/null and b/2.12.0a2/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/2.12.0a2/_static/css/fonts/Roboto-Slab-Regular.woff b/2.12.0a2/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 00000000..f815f63f Binary files /dev/null and b/2.12.0a2/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/2.12.0a2/_static/css/fonts/Roboto-Slab-Regular.woff2 b/2.12.0a2/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 00000000..f2c76e5b Binary files /dev/null and b/2.12.0a2/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/2.12.0a2/_static/css/fonts/fontawesome-webfont.eot b/2.12.0a2/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 00000000..e9f60ca9 Binary files /dev/null and b/2.12.0a2/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/2.12.0a2/_static/css/fonts/fontawesome-webfont.svg b/2.12.0a2/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 00000000..855c845e --- /dev/null +++ b/2.12.0a2/_static/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/2.12.0a2/_static/css/fonts/fontawesome-webfont.ttf b/2.12.0a2/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 00000000..35acda2f Binary files /dev/null and b/2.12.0a2/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/2.12.0a2/_static/css/fonts/fontawesome-webfont.woff b/2.12.0a2/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 00000000..400014a4 Binary files /dev/null and b/2.12.0a2/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/2.12.0a2/_static/css/fonts/fontawesome-webfont.woff2 b/2.12.0a2/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 00000000..4d13fc60 Binary files /dev/null and b/2.12.0a2/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/2.12.0a2/_static/css/fonts/lato-bold-italic.woff b/2.12.0a2/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 00000000..88ad05b9 Binary files /dev/null and b/2.12.0a2/_static/css/fonts/lato-bold-italic.woff differ diff --git a/2.12.0a2/_static/css/fonts/lato-bold-italic.woff2 b/2.12.0a2/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 00000000..c4e3d804 Binary files /dev/null and b/2.12.0a2/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/2.12.0a2/_static/css/fonts/lato-bold.woff b/2.12.0a2/_static/css/fonts/lato-bold.woff new file mode 100644 index 00000000..c6dff51f Binary files /dev/null and b/2.12.0a2/_static/css/fonts/lato-bold.woff differ diff --git a/2.12.0a2/_static/css/fonts/lato-bold.woff2 b/2.12.0a2/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 00000000..bb195043 Binary files /dev/null and b/2.12.0a2/_static/css/fonts/lato-bold.woff2 differ diff --git a/2.12.0a2/_static/css/fonts/lato-normal-italic.woff b/2.12.0a2/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 00000000..76114bc0 Binary files /dev/null and b/2.12.0a2/_static/css/fonts/lato-normal-italic.woff differ diff --git a/2.12.0a2/_static/css/fonts/lato-normal-italic.woff2 b/2.12.0a2/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 00000000..3404f37e Binary files /dev/null and b/2.12.0a2/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/2.12.0a2/_static/css/fonts/lato-normal.woff b/2.12.0a2/_static/css/fonts/lato-normal.woff new file mode 100644 index 00000000..ae1307ff Binary files /dev/null and b/2.12.0a2/_static/css/fonts/lato-normal.woff differ diff --git a/2.12.0a2/_static/css/fonts/lato-normal.woff2 b/2.12.0a2/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 00000000..3bf98433 Binary files /dev/null and b/2.12.0a2/_static/css/fonts/lato-normal.woff2 differ diff --git a/2.12.0a2/_static/css/theme.css b/2.12.0a2/_static/css/theme.css new file mode 100644 index 00000000..19a446a0 --- /dev/null +++ b/2.12.0a2/_static/css/theme.css @@ -0,0 +1,4 @@ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/2.12.0a2/_static/doctools.js b/2.12.0a2/_static/doctools.js new file mode 100644 index 00000000..4d67807d --- /dev/null +++ b/2.12.0a2/_static/doctools.js @@ -0,0 +1,156 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Base JavaScript utilities for all Sphinx HTML documentation. + * + * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); + } +}; + +/** + * Small JavaScript module for the documentation. + */ +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } + }, + + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; + }, + + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); + }, + + /** + * Initialise the domain index toggle buttons + */ + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); + }, + + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } + }); + }, +}; + +// quick alias for translations +const _ = Documentation.gettext; + +_ready(Documentation.init); diff --git a/2.12.0a2/_static/documentation_options.js b/2.12.0a2/_static/documentation_options.js new file mode 100644 index 00000000..66ca5479 --- /dev/null +++ b/2.12.0a2/_static/documentation_options.js @@ -0,0 +1,13 @@ +const DOCUMENTATION_OPTIONS = { + VERSION: '2.12.0a2', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/2.12.0a2/_static/file.png b/2.12.0a2/_static/file.png new file mode 100644 index 00000000..a858a410 Binary files /dev/null and b/2.12.0a2/_static/file.png differ diff --git a/2.12.0a2/_static/jquery.js b/2.12.0a2/_static/jquery.js new file mode 100644 index 00000000..c4c6022f --- /dev/null +++ b/2.12.0a2/_static/jquery.js @@ -0,0 +1,2 @@ +/*! jQuery v3.6.0 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.0",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var _t,zt=[],Ut=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=zt.pop()||S.expando+"_"+wt.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Ut.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ut.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Ut,"$1"+r):!1!==e.jsonp&&(e.url+=(Tt.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,zt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((_t=E.implementation.createHTMLDocument("").body).innerHTML="
",2===_t.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=Fe(y.pixelPosition,function(e,t){if(t)return t=We(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=y.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=y.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),y.elements=c+" "+a,j(b)}function f(a){var b=x[a[v]];return b||(b={},w++,a[v]=w,x[w]=b),b}function g(a,c,d){if(c||(c=b),q)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():u.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||t.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),q)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return y.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(y,b.frag)}function j(a){a||(a=b);var d=f(a);return!y.shivCSS||p||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),q||i(a,d),a}function k(a){for(var b,c=a.getElementsByTagName("*"),e=c.length,f=RegExp("^(?:"+d().join("|")+")$","i"),g=[];e--;)b=c[e],f.test(b.nodeName)&&g.push(b.applyElement(l(b)));return g}function l(a){for(var b,c=a.attributes,d=c.length,e=a.ownerDocument.createElement(A+":"+a.nodeName);d--;)b=c[d],b.specified&&e.setAttribute(b.nodeName,b.nodeValue);return e.style.cssText=a.style.cssText,e}function m(a){for(var b,c=a.split("{"),e=c.length,f=RegExp("(^|[\\s,>+~])("+d().join("|")+")(?=[[\\s,>+~#.:]|$)","gi"),g="$1"+A+"\\:$2";e--;)b=c[e]=c[e].split("}"),b[b.length-1]=b[b.length-1].replace(f,g),c[e]=b.join("}");return c.join("{")}function n(a){for(var b=a.length;b--;)a[b].removeNode()}function o(a){function b(){clearTimeout(g._removeSheetTimer),d&&d.removeNode(!0),d=null}var d,e,g=f(a),h=a.namespaces,i=a.parentWindow;return!B||a.printShived?a:("undefined"==typeof h[A]&&h.add(A),i.attachEvent("onbeforeprint",function(){b();for(var f,g,h,i=a.styleSheets,j=[],l=i.length,n=Array(l);l--;)n[l]=i[l];for(;h=n.pop();)if(!h.disabled&&z.test(h.media)){try{f=h.imports,g=f.length}catch(o){g=0}for(l=0;g>l;l++)n.push(f[l]);try{j.push(h.cssText)}catch(o){}}j=m(j.reverse().join("")),e=k(a),d=c(a,j)}),i.attachEvent("onafterprint",function(){n(e),clearTimeout(g._removeSheetTimer),g._removeSheetTimer=setTimeout(b,500)}),a.printShived=!0,a)}var p,q,r="3.7.3",s=a.html5||{},t=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,u=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,v="_html5shiv",w=0,x={};!function(){try{var a=b.createElement("a");a.innerHTML="",p="hidden"in a,q=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){p=!0,q=!0}}();var y={elements:s.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:r,shivCSS:s.shivCSS!==!1,supportsUnknownElements:q,shivMethods:s.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=y,j(b);var z=/^$|\b(?:all|print)\b/,A="html5shiv",B=!q&&function(){var c=b.documentElement;return!("undefined"==typeof b.namespaces||"undefined"==typeof b.parentWindow||"undefined"==typeof c.applyElement||"undefined"==typeof c.removeNode||"undefined"==typeof a.attachEvent)}();y.type+=" print",y.shivPrint=o,o(b),"object"==typeof module&&module.exports&&(module.exports=y)}("undefined"!=typeof window?window:this,document); \ No newline at end of file diff --git a/2.12.0a2/_static/js/html5shiv.min.js b/2.12.0a2/_static/js/html5shiv.min.js new file mode 100644 index 00000000..cd1c674f --- /dev/null +++ b/2.12.0a2/_static/js/html5shiv.min.js @@ -0,0 +1,4 @@ +/** +* @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed +*/ +!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3-pre",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML="",k="hidden"in a,l=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){k=!0,l=!0}}();var t={elements:n.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:m,shivCSS:n.shivCSS!==!1,supportsUnknownElements:l,shivMethods:n.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=t,j(b),"object"==typeof module&&module.exports&&(module.exports=t)}("undefined"!=typeof window?window:this,document); \ No newline at end of file diff --git a/2.12.0a2/_static/js/theme.js b/2.12.0a2/_static/js/theme.js new file mode 100644 index 00000000..1fddb6ee --- /dev/null +++ b/2.12.0a2/_static/js/theme.js @@ -0,0 +1 @@ +!function(n){var e={};function t(i){if(e[i])return e[i].exports;var o=e[i]={i:i,l:!1,exports:{}};return n[i].call(o.exports,o,o.exports,t),o.l=!0,o.exports}t.m=n,t.c=e,t.d=function(n,e,i){t.o(n,e)||Object.defineProperty(n,e,{enumerable:!0,get:i})},t.r=function(n){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(n,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(n,"__esModule",{value:!0})},t.t=function(n,e){if(1&e&&(n=t(n)),8&e)return n;if(4&e&&"object"==typeof n&&n&&n.__esModule)return n;var i=Object.create(null);if(t.r(i),Object.defineProperty(i,"default",{enumerable:!0,value:n}),2&e&&"string"!=typeof n)for(var o in n)t.d(i,o,function(e){return n[e]}.bind(null,o));return i},t.n=function(n){var e=n&&n.__esModule?function(){return n.default}:function(){return n};return t.d(e,"a",e),e},t.o=function(n,e){return Object.prototype.hasOwnProperty.call(n,e)},t.p="",t(t.s=0)}([function(n,e,t){t(1),n.exports=t(3)},function(n,e,t){(function(){var e="undefined"!=typeof window?window.jQuery:t(2);n.exports.ThemeNav={navBar:null,win:null,winScroll:!1,winResize:!1,linkScroll:!1,winPosition:0,winHeight:null,docHeight:null,isRunning:!1,enable:function(n){var t=this;void 0===n&&(n=!0),t.isRunning||(t.isRunning=!0,e((function(e){t.init(e),t.reset(),t.win.on("hashchange",t.reset),n&&t.win.on("scroll",(function(){t.linkScroll||t.winScroll||(t.winScroll=!0,requestAnimationFrame((function(){t.onScroll()})))})),t.win.on("resize",(function(){t.winResize||(t.winResize=!0,requestAnimationFrame((function(){t.onResize()})))})),t.onResize()})))},enableSticky:function(){this.enable(!0)},init:function(n){n(document);var e=this;this.navBar=n("div.wy-side-scroll:first"),this.win=n(window),n(document).on("click","[data-toggle='wy-nav-top']",(function(){n("[data-toggle='wy-nav-shift']").toggleClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift")})).on("click",".wy-menu-vertical .current ul li a",(function(){var t=n(this);n("[data-toggle='wy-nav-shift']").removeClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift"),e.toggleCurrent(t),e.hashChange()})).on("click","[data-toggle='rst-current-version']",(function(){n("[data-toggle='rst-versions']").toggleClass("shift-up")})),n("table.docutils:not(.field-list,.footnote,.citation)").wrap("
"),n("table.docutils.footnote").wrap("
"),n("table.docutils.citation").wrap("
"),n(".wy-menu-vertical ul").not(".simple").siblings("a").each((function(){var t=n(this);expand=n(''),expand.on("click",(function(n){return e.toggleCurrent(t),n.stopPropagation(),!1})),t.prepend(expand)}))},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),t=e.find('[href="'+n+'"]');if(0===t.length){var i=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(t=e.find('[href="#'+i.attr("id")+'"]')).length&&(t=e.find('[href="#"]'))}if(t.length>0){$(".wy-menu-vertical .current").removeClass("current").attr("aria-expanded","false"),t.addClass("current").attr("aria-expanded","true"),t.closest("li.toctree-l1").parent().addClass("current").attr("aria-expanded","true");for(let n=1;n<=10;n++)t.closest("li.toctree-l"+n).addClass("current").attr("aria-expanded","true");t[0].scrollIntoView()}}catch(n){console.log("Error expanding nav for anchor",n)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,t=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(t),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",(function(){this.linkScroll=!1}))},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current").attr("aria-expanded","false"),e.siblings().find("li.current").removeClass("current").attr("aria-expanded","false");var t=e.find("> ul li");t.length&&(t.removeClass("current").attr("aria-expanded","false"),e.toggleClass("current").attr("aria-expanded",(function(n,e){return"true"==e?"false":"true"})))}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:n.exports.ThemeNav,StickyNav:n.exports.ThemeNav}),function(){for(var n=0,e=["ms","moz","webkit","o"],t=0;t0 + var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 + var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 + var s_v = "^(" + C + ")?" + v; // vowel in stem + + this.stemWord = function (w) { + var stem; + var suffix; + var firstch; + var origword = w; + + if (w.length < 3) + return w; + + var re; + var re2; + var re3; + var re4; + + firstch = w.substr(0,1); + if (firstch == "y") + w = firstch.toUpperCase() + w.substr(1); + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) + w = w.replace(re,"$1$2"); + else if (re2.test(w)) + w = w.replace(re2,"$1$2"); + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) + w = w + "e"; + else if (re3.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + else if (re4.test(w)) + w = w + "e"; + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) + w = stem + "i"; + } + + // Step 2 + re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step2list[suffix]; + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step3list[suffix]; + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) + w = stem; + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) + w = stem; + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) + w = stem; + } + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + if (firstch == "y") + w = firstch.toLowerCase() + w.substr(1); + return w; + } +} + diff --git a/2.12.0a2/_static/minus.png b/2.12.0a2/_static/minus.png new file mode 100644 index 00000000..d96755fd Binary files /dev/null and b/2.12.0a2/_static/minus.png differ diff --git a/2.12.0a2/_static/plus.png b/2.12.0a2/_static/plus.png new file mode 100644 index 00000000..7107cec9 Binary files /dev/null and b/2.12.0a2/_static/plus.png differ diff --git a/2.12.0a2/_static/pygments.css b/2.12.0a2/_static/pygments.css new file mode 100644 index 00000000..84ab3030 --- /dev/null +++ b/2.12.0a2/_static/pygments.css @@ -0,0 +1,75 @@ +pre { line-height: 125%; } +td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +.highlight .hll { background-color: #ffffcc } +.highlight { background: #f8f8f8; } +.highlight .c { color: #3D7B7B; font-style: italic } /* Comment */ +.highlight .err { border: 1px solid #FF0000 } /* Error */ +.highlight .k { color: #008000; font-weight: bold } /* Keyword */ +.highlight .o { color: #666666 } /* Operator */ +.highlight .ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */ +.highlight .cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #9C6500 } /* Comment.Preproc */ +.highlight .cpf { color: #3D7B7B; font-style: italic } /* Comment.PreprocFile */ +.highlight .c1 { color: #3D7B7B; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #3D7B7B; font-style: italic } /* Comment.Special */ +.highlight .gd { color: #A00000 } /* Generic.Deleted */ +.highlight .ge { font-style: italic } /* Generic.Emph */ +.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */ +.highlight .gr { color: #E40000 } /* Generic.Error */ +.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.highlight .gi { color: #008400 } /* Generic.Inserted */ +.highlight .go { color: #717171 } /* Generic.Output */ +.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */ +.highlight .gs { font-weight: bold } /* Generic.Strong */ +.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.highlight .gt { color: #0044DD } /* Generic.Traceback */ +.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #008000 } /* Keyword.Pseudo */ +.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #B00040 } /* Keyword.Type */ +.highlight .m { color: #666666 } /* Literal.Number */ +.highlight .s { color: #BA2121 } /* Literal.String */ +.highlight .na { color: #687822 } /* Name.Attribute */ +.highlight .nb { color: #008000 } /* Name.Builtin */ +.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */ +.highlight .no { color: #880000 } /* Name.Constant */ +.highlight .nd { color: #AA22FF } /* Name.Decorator */ +.highlight .ni { color: #717171; font-weight: bold } /* Name.Entity */ +.highlight .ne { color: #CB3F38; font-weight: bold } /* Name.Exception */ +.highlight .nf { color: #0000FF } /* Name.Function */ +.highlight .nl { color: #767600 } /* Name.Label */ +.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */ +.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #19177C } /* Name.Variable */ +.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */ +.highlight .w { color: #bbbbbb } /* Text.Whitespace */ +.highlight .mb { color: #666666 } /* Literal.Number.Bin */ +.highlight .mf { color: #666666 } /* Literal.Number.Float */ +.highlight .mh { color: #666666 } /* Literal.Number.Hex */ +.highlight .mi { color: #666666 } /* Literal.Number.Integer */ +.highlight .mo { color: #666666 } /* Literal.Number.Oct */ +.highlight .sa { color: #BA2121 } /* Literal.String.Affix */ +.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */ +.highlight .sc { color: #BA2121 } /* Literal.String.Char */ +.highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */ +.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #BA2121 } /* Literal.String.Double */ +.highlight .se { color: #AA5D1F; font-weight: bold } /* Literal.String.Escape */ +.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */ +.highlight .si { color: #A45A77; font-weight: bold } /* Literal.String.Interpol */ +.highlight .sx { color: #008000 } /* Literal.String.Other */ +.highlight .sr { color: #A45A77 } /* Literal.String.Regex */ +.highlight .s1 { color: #BA2121 } /* Literal.String.Single */ +.highlight .ss { color: #19177C } /* Literal.String.Symbol */ +.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */ +.highlight .fm { color: #0000FF } /* Name.Function.Magic */ +.highlight .vc { color: #19177C } /* Name.Variable.Class */ +.highlight .vg { color: #19177C } /* Name.Variable.Global */ +.highlight .vi { color: #19177C } /* Name.Variable.Instance */ +.highlight .vm { color: #19177C } /* Name.Variable.Magic */ +.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/2.12.0a2/_static/searchtools.js b/2.12.0a2/_static/searchtools.js new file mode 100644 index 00000000..b08d58c9 --- /dev/null +++ b/2.12.0a2/_static/searchtools.js @@ -0,0 +1,620 @@ +/* + * searchtools.js + * ~~~~~~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for the full-text search. + * + * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +/** + * Simple result scoring code. + */ +if (typeof Scorer === "undefined") { + var Scorer = { + // Implement the following function to further tweak the score for each result + // The function takes a result array [docname, title, anchor, descr, score, filename] + // and returns the new score. + /* + score: result => { + const [docname, title, anchor, descr, score, filename] = result + return score + }, + */ + + // query matches the full name of an object + objNameMatch: 11, + // or matches in the last dotted part of the object name + objPartialMatch: 6, + // Additive scores depending on the priority of the object + objPrio: { + 0: 15, // used to be importantResults + 1: 5, // used to be objectResults + 2: -5, // used to be unimportantResults + }, + // Used when the priority is not in the mapping. + objPrioDefault: 0, + + // query found in title + title: 15, + partialTitle: 7, + // query found in terms + term: 5, + partialTerm: 2, + }; +} + +const _removeChildren = (element) => { + while (element && element.lastChild) element.removeChild(element.lastChild); +}; + +/** + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping + */ +const _escapeRegExp = (string) => + string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string + +const _displayItem = (item, searchTerms, highlightTerms) => { + const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; + const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; + const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; + const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; + const contentRoot = document.documentElement.dataset.content_root; + + const [docName, title, anchor, descr, score, _filename] = item; + + let listItem = document.createElement("li"); + let requestUrl; + let linkUrl; + if (docBuilder === "dirhtml") { + // dirhtml builder + let dirname = docName + "/"; + if (dirname.match(/\/index\/$/)) + dirname = dirname.substring(0, dirname.length - 6); + else if (dirname === "index/") dirname = ""; + requestUrl = contentRoot + dirname; + linkUrl = requestUrl; + } else { + // normal html builders + requestUrl = contentRoot + docName + docFileSuffix; + linkUrl = docName + docLinkSuffix; + } + let linkEl = listItem.appendChild(document.createElement("a")); + linkEl.href = linkUrl + anchor; + linkEl.dataset.score = score; + linkEl.innerHTML = title; + if (descr) { + listItem.appendChild(document.createElement("span")).innerHTML = + " (" + descr + ")"; + // highlight search terms in the description + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + } + else if (showSearchSummary) + fetch(requestUrl) + .then((responseData) => responseData.text()) + .then((data) => { + if (data) + listItem.appendChild( + Search.makeSearchSummary(data, searchTerms, anchor) + ); + // highlight search terms in the summary + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + }); + Search.output.appendChild(listItem); +}; +const _finishSearch = (resultCount) => { + Search.stopPulse(); + Search.title.innerText = _("Search Results"); + if (!resultCount) + Search.status.innerText = Documentation.gettext( + "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." + ); + else + Search.status.innerText = _( + "Search finished, found ${resultCount} page(s) matching the search query." + ).replace('${resultCount}', resultCount); +}; +const _displayNextItem = ( + results, + resultCount, + searchTerms, + highlightTerms, +) => { + // results left, load the summary and display it + // this is intended to be dynamic (don't sub resultsCount) + if (results.length) { + _displayItem(results.pop(), searchTerms, highlightTerms); + setTimeout( + () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), + 5 + ); + } + // search finished, update title and status message + else _finishSearch(resultCount); +}; +// Helper function used by query() to order search results. +// Each input is an array of [docname, title, anchor, descr, score, filename]. +// Order the results by score (in opposite order of appearance, since the +// `_displayNextItem` function uses pop() to retrieve items) and then alphabetically. +const _orderResultsByScoreThenName = (a, b) => { + const leftScore = a[4]; + const rightScore = b[4]; + if (leftScore === rightScore) { + // same score: sort alphabetically + const leftTitle = a[1].toLowerCase(); + const rightTitle = b[1].toLowerCase(); + if (leftTitle === rightTitle) return 0; + return leftTitle > rightTitle ? -1 : 1; // inverted is intentional + } + return leftScore > rightScore ? 1 : -1; +}; + +/** + * Default splitQuery function. Can be overridden in ``sphinx.search`` with a + * custom function per language. + * + * The regular expression works by splitting the string on consecutive characters + * that are not Unicode letters, numbers, underscores, or emoji characters. + * This is the same as ``\W+`` in Python, preserving the surrogate pair area. + */ +if (typeof splitQuery === "undefined") { + var splitQuery = (query) => query + .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) + .filter(term => term) // remove remaining empty strings +} + +/** + * Search Module + */ +const Search = { + _index: null, + _queued_query: null, + _pulse_status: -1, + + htmlToText: (htmlString, anchor) => { + const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); + for (const removalQuery of [".headerlink", "script", "style"]) { + htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() }); + } + if (anchor) { + const anchorContent = htmlElement.querySelector(`[role="main"] ${anchor}`); + if (anchorContent) return anchorContent.textContent; + + console.warn( + `Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.` + ); + } + + // if anchor not specified or not found, fall back to main content + const docContent = htmlElement.querySelector('[role="main"]'); + if (docContent) return docContent.textContent; + + console.warn( + "Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template." + ); + return ""; + }, + + init: () => { + const query = new URLSearchParams(window.location.search).get("q"); + document + .querySelectorAll('input[name="q"]') + .forEach((el) => (el.value = query)); + if (query) Search.performSearch(query); + }, + + loadIndex: (url) => + (document.body.appendChild(document.createElement("script")).src = url), + + setIndex: (index) => { + Search._index = index; + if (Search._queued_query !== null) { + const query = Search._queued_query; + Search._queued_query = null; + Search.query(query); + } + }, + + hasIndex: () => Search._index !== null, + + deferQuery: (query) => (Search._queued_query = query), + + stopPulse: () => (Search._pulse_status = -1), + + startPulse: () => { + if (Search._pulse_status >= 0) return; + + const pulse = () => { + Search._pulse_status = (Search._pulse_status + 1) % 4; + Search.dots.innerText = ".".repeat(Search._pulse_status); + if (Search._pulse_status >= 0) window.setTimeout(pulse, 500); + }; + pulse(); + }, + + /** + * perform a search for something (or wait until index is loaded) + */ + performSearch: (query) => { + // create the required interface elements + const searchText = document.createElement("h2"); + searchText.textContent = _("Searching"); + const searchSummary = document.createElement("p"); + searchSummary.classList.add("search-summary"); + searchSummary.innerText = ""; + const searchList = document.createElement("ul"); + searchList.classList.add("search"); + + const out = document.getElementById("search-results"); + Search.title = out.appendChild(searchText); + Search.dots = Search.title.appendChild(document.createElement("span")); + Search.status = out.appendChild(searchSummary); + Search.output = out.appendChild(searchList); + + const searchProgress = document.getElementById("search-progress"); + // Some themes don't use the search progress node + if (searchProgress) { + searchProgress.innerText = _("Preparing search..."); + } + Search.startPulse(); + + // index already loaded, the browser was quick! + if (Search.hasIndex()) Search.query(query); + else Search.deferQuery(query); + }, + + _parseQuery: (query) => { + // stem the search terms and add them to the correct list + const stemmer = new Stemmer(); + const searchTerms = new Set(); + const excludedTerms = new Set(); + const highlightTerms = new Set(); + const objectTerms = new Set(splitQuery(query.toLowerCase().trim())); + splitQuery(query.trim()).forEach((queryTerm) => { + const queryTermLower = queryTerm.toLowerCase(); + + // maybe skip this "word" + // stopwords array is from language_data.js + if ( + stopwords.indexOf(queryTermLower) !== -1 || + queryTerm.match(/^\d+$/) + ) + return; + + // stem the word + let word = stemmer.stemWord(queryTermLower); + // select the correct list + if (word[0] === "-") excludedTerms.add(word.substr(1)); + else { + searchTerms.add(word); + highlightTerms.add(queryTermLower); + } + }); + + if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js + localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" ")) + } + + // console.debug("SEARCH: searching for:"); + // console.info("required: ", [...searchTerms]); + // console.info("excluded: ", [...excludedTerms]); + + return [query, searchTerms, excludedTerms, highlightTerms, objectTerms]; + }, + + /** + * execute search (requires search index to be loaded) + */ + _performSearch: (query, searchTerms, excludedTerms, highlightTerms, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + const allTitles = Search._index.alltitles; + const indexEntries = Search._index.indexentries; + + // Collect multiple result groups to be sorted separately and then ordered. + // Each is an array of [docname, title, anchor, descr, score, filename]. + const normalResults = []; + const nonMainIndexResults = []; + + _removeChildren(document.getElementById("search-progress")); + + const queryLower = query.toLowerCase().trim(); + for (const [title, foundTitles] of Object.entries(allTitles)) { + if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) { + for (const [file, id] of foundTitles) { + const score = Math.round(Scorer.title * queryLower.length / title.length); + const boost = titles[file] === title ? 1 : 0; // add a boost for document titles + normalResults.push([ + docNames[file], + titles[file] !== title ? `${titles[file]} > ${title}` : title, + id !== null ? "#" + id : "", + null, + score + boost, + filenames[file], + ]); + } + } + } + + // search for explicit entries in index directives + for (const [entry, foundEntries] of Object.entries(indexEntries)) { + if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { + for (const [file, id, isMain] of foundEntries) { + const score = Math.round(100 * queryLower.length / entry.length); + const result = [ + docNames[file], + titles[file], + id ? "#" + id : "", + null, + score, + filenames[file], + ]; + if (isMain) { + normalResults.push(result); + } else { + nonMainIndexResults.push(result); + } + } + } + } + + // lookup as object + objectTerms.forEach((term) => + normalResults.push(...Search.performObjectSearch(term, objectTerms)) + ); + + // lookup as search terms in fulltext + normalResults.push(...Search.performTermsSearch(searchTerms, excludedTerms)); + + // let the scorer override scores with a custom scoring function + if (Scorer.score) { + normalResults.forEach((item) => (item[4] = Scorer.score(item))); + nonMainIndexResults.forEach((item) => (item[4] = Scorer.score(item))); + } + + // Sort each group of results by score and then alphabetically by name. + normalResults.sort(_orderResultsByScoreThenName); + nonMainIndexResults.sort(_orderResultsByScoreThenName); + + // Combine the result groups in (reverse) order. + // Non-main index entries are typically arbitrary cross-references, + // so display them after other results. + let results = [...nonMainIndexResults, ...normalResults]; + + // remove duplicate search results + // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept + let seen = new Set(); + results = results.reverse().reduce((acc, result) => { + let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(','); + if (!seen.has(resultStr)) { + acc.push(result); + seen.add(resultStr); + } + return acc; + }, []); + + return results.reverse(); + }, + + query: (query) => { + const [searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms] = Search._parseQuery(query); + const results = Search._performSearch(searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms); + + // for debugging + //Search.lastresults = results.slice(); // a copy + // console.info("search results:", Search.lastresults); + + // print the results + _displayNextItem(results, results.length, searchTerms, highlightTerms); + }, + + /** + * search for object names + */ + performObjectSearch: (object, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const objects = Search._index.objects; + const objNames = Search._index.objnames; + const titles = Search._index.titles; + + const results = []; + + const objectSearchCallback = (prefix, match) => { + const name = match[4] + const fullname = (prefix ? prefix + "." : "") + name; + const fullnameLower = fullname.toLowerCase(); + if (fullnameLower.indexOf(object) < 0) return; + + let score = 0; + const parts = fullnameLower.split("."); + + // check for different match types: exact matches of full name or + // "last name" (i.e. last dotted part) + if (fullnameLower === object || parts.slice(-1)[0] === object) + score += Scorer.objNameMatch; + else if (parts.slice(-1)[0].indexOf(object) > -1) + score += Scorer.objPartialMatch; // matches in last name + + const objName = objNames[match[1]][2]; + const title = titles[match[0]]; + + // If more than one term searched for, we require other words to be + // found in the name/title/description + const otherTerms = new Set(objectTerms); + otherTerms.delete(object); + if (otherTerms.size > 0) { + const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase(); + if ( + [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0) + ) + return; + } + + let anchor = match[3]; + if (anchor === "") anchor = fullname; + else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname; + + const descr = objName + _(", in ") + title; + + // add custom score for some objects according to scorer + if (Scorer.objPrio.hasOwnProperty(match[2])) + score += Scorer.objPrio[match[2]]; + else score += Scorer.objPrioDefault; + + results.push([ + docNames[match[0]], + fullname, + "#" + anchor, + descr, + score, + filenames[match[0]], + ]); + }; + Object.keys(objects).forEach((prefix) => + objects[prefix].forEach((array) => + objectSearchCallback(prefix, array) + ) + ); + return results; + }, + + /** + * search for full-text terms in the index + */ + performTermsSearch: (searchTerms, excludedTerms) => { + // prepare search + const terms = Search._index.terms; + const titleTerms = Search._index.titleterms; + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + + const scoreMap = new Map(); + const fileMap = new Map(); + + // perform the search on the required terms + searchTerms.forEach((word) => { + const files = []; + const arr = [ + { files: terms[word], score: Scorer.term }, + { files: titleTerms[word], score: Scorer.title }, + ]; + // add support for partial matches + if (word.length > 2) { + const escapedWord = _escapeRegExp(word); + if (!terms.hasOwnProperty(word)) { + Object.keys(terms).forEach((term) => { + if (term.match(escapedWord)) + arr.push({ files: terms[term], score: Scorer.partialTerm }); + }); + } + if (!titleTerms.hasOwnProperty(word)) { + Object.keys(titleTerms).forEach((term) => { + if (term.match(escapedWord)) + arr.push({ files: titleTerms[term], score: Scorer.partialTitle }); + }); + } + } + + // no match but word was a required one + if (arr.every((record) => record.files === undefined)) return; + + // found search word in contents + arr.forEach((record) => { + if (record.files === undefined) return; + + let recordFiles = record.files; + if (recordFiles.length === undefined) recordFiles = [recordFiles]; + files.push(...recordFiles); + + // set score for the word in each file + recordFiles.forEach((file) => { + if (!scoreMap.has(file)) scoreMap.set(file, {}); + scoreMap.get(file)[word] = record.score; + }); + }); + + // create the mapping + files.forEach((file) => { + if (!fileMap.has(file)) fileMap.set(file, [word]); + else if (fileMap.get(file).indexOf(word) === -1) fileMap.get(file).push(word); + }); + }); + + // now check if the files don't contain excluded terms + const results = []; + for (const [file, wordList] of fileMap) { + // check if all requirements are matched + + // as search terms with length < 3 are discarded + const filteredTermCount = [...searchTerms].filter( + (term) => term.length > 2 + ).length; + if ( + wordList.length !== searchTerms.size && + wordList.length !== filteredTermCount + ) + continue; + + // ensure that none of the excluded terms is in the search result + if ( + [...excludedTerms].some( + (term) => + terms[term] === file || + titleTerms[term] === file || + (terms[term] || []).includes(file) || + (titleTerms[term] || []).includes(file) + ) + ) + break; + + // select one (max) score for the file. + const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w])); + // add result to the result list + results.push([ + docNames[file], + titles[file], + "", + null, + score, + filenames[file], + ]); + } + return results; + }, + + /** + * helper function to return a node containing the + * search summary for a given text. keywords is a list + * of stemmed words. + */ + makeSearchSummary: (htmlText, keywords, anchor) => { + const text = Search.htmlToText(htmlText, anchor); + if (text === "") return null; + + const textLower = text.toLowerCase(); + const actualStartPosition = [...keywords] + .map((k) => textLower.indexOf(k.toLowerCase())) + .filter((i) => i > -1) + .slice(-1)[0]; + const startWithContext = Math.max(actualStartPosition - 120, 0); + + const top = startWithContext === 0 ? "" : "..."; + const tail = startWithContext + 240 < text.length ? "..." : ""; + + let summary = document.createElement("p"); + summary.classList.add("context"); + summary.textContent = top + text.substr(startWithContext, 240).trim() + tail; + + return summary; + }, +}; + +_ready(Search.init); diff --git a/2.12.0a2/_static/sphinx_highlight.js b/2.12.0a2/_static/sphinx_highlight.js new file mode 100644 index 00000000..8a96c69a --- /dev/null +++ b/2.12.0a2/_static/sphinx_highlight.js @@ -0,0 +1,154 @@ +/* Highlighting utilities for Sphinx HTML documentation. */ +"use strict"; + +const SPHINX_HIGHLIGHT_ENABLED = true + +/** + * highlight a given string on a node by wrapping it in + * span elements with the given class name. + */ +const _highlight = (node, addItems, text, className) => { + if (node.nodeType === Node.TEXT_NODE) { + const val = node.nodeValue; + const parent = node.parentNode; + const pos = val.toLowerCase().indexOf(text); + if ( + pos >= 0 && + !parent.classList.contains(className) && + !parent.classList.contains("nohighlight") + ) { + let span; + + const closestNode = parent.closest("body, svg, foreignObject"); + const isInSVG = closestNode && closestNode.matches("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.classList.add(className); + } + + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + const rest = document.createTextNode(val.substr(pos + text.length)); + parent.insertBefore( + span, + parent.insertBefore( + rest, + node.nextSibling + ) + ); + node.nodeValue = val.substr(0, pos); + /* There may be more occurrences of search term in this node. So call this + * function recursively on the remaining fragment. + */ + _highlight(rest, addItems, text, className); + + if (isInSVG) { + const rect = document.createElementNS( + "http://www.w3.org/2000/svg", + "rect" + ); + const bbox = parent.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute("class", className); + addItems.push({ parent: parent, target: rect }); + } + } + } else if (node.matches && !node.matches("button, select, textarea")) { + node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); + } +}; +const _highlightText = (thisNode, text, className) => { + let addItems = []; + _highlight(thisNode, addItems, text, className); + addItems.forEach((obj) => + obj.parent.insertAdjacentElement("beforebegin", obj.target) + ); +}; + +/** + * Small JavaScript module for the documentation. + */ +const SphinxHighlight = { + + /** + * highlight the search words provided in localstorage in the text + */ + highlightSearchWords: () => { + if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight + + // get and clear terms from localstorage + const url = new URL(window.location); + const highlight = + localStorage.getItem("sphinx_highlight_terms") + || url.searchParams.get("highlight") + || ""; + localStorage.removeItem("sphinx_highlight_terms") + url.searchParams.delete("highlight"); + window.history.replaceState({}, "", url); + + // get individual terms from highlight string + const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); + if (terms.length === 0) return; // nothing to do + + // There should never be more than one element matching "div.body" + const divBody = document.querySelectorAll("div.body"); + const body = divBody.length ? divBody[0] : document.querySelector("body"); + window.setTimeout(() => { + terms.forEach((term) => _highlightText(body, term, "highlighted")); + }, 10); + + const searchBox = document.getElementById("searchbox"); + if (searchBox === null) return; + searchBox.appendChild( + document + .createRange() + .createContextualFragment( + '" + ) + ); + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + localStorage.removeItem("sphinx_highlight_terms") + }, + + initEscapeListener: () => { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; + if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { + SphinxHighlight.hideSearchWords(); + event.preventDefault(); + } + }); + }, +}; + +_ready(() => { + /* Do not call highlightSearchWords() when we are on the search page. + * It will highlight words from the *previous* search query. + */ + if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); + SphinxHighlight.initEscapeListener(); +}); diff --git a/2.12.0a2/genindex.html b/2.12.0a2/genindex.html new file mode 100644 index 00000000..86811307 --- /dev/null +++ b/2.12.0a2/genindex.html @@ -0,0 +1,373 @@ + + + + + + Index — l2ss-py 2.12.0a2 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Index

+ +
+ _ + | A + | B + | C + | D + | F + | G + | H + | I + | L + | M + | O + | P + | R + | S + | T + | W + +
+

_

+ + +
+ +

A

+ + +
+ +

B

+ + +
+ +

C

+ + + +
+ +

D

+ + +
+ +

F

+ + +
+ +

G

+ + + +
+ +

H

+ + +
+ +

I

+ + + +
+ +

L

+ + +
+ +

M

+ + +
+ +

O

+ + + +
+ +

P

+ + + +
+ +

R

+ + + +
+ +

S

+ + + +
+ +

T

+ + + +
+ +

W

+ + +
+ + + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/2.12.0a2/index.html b/2.12.0a2/index.html new file mode 100644 index 00000000..96da5dae --- /dev/null +++ b/2.12.0a2/index.html @@ -0,0 +1,1144 @@ + + + + + + + Reference Guide for l2ss-py — l2ss-py 2.12.0a2 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Reference Guide for l2ss-py

+
+
+
+
+

l2ss-py

+Coverage +


+develop: +.. image:: https://github.com/podaac/l2ss-py/actions/workflows/build-pipeline.yml/badge.svg?branch=develop&event=push

+
+
+


+main: +.. image:: https://github.com/podaac/l2ss-py/actions/workflows/build-pipeline.yml/badge.svg?branch=main&event=push

+
+
+

Harmony service for subsetting L2 data. l2ss-py supports:

+
    +
  • Spatial subsetting

    +
      +
    • Bounding box

    • +
    • Shapefile subsetting

    • +
    • GeoJSON subsetting

    • +
    +
  • +
  • Temporal subsetting

  • +
  • Variable subsetting

  • +
+

If you would like to contribute to l2ss-py, refer to the contribution document.

+
+

Initial setup, with poetry

+
    +
  1. Follow the instructions for installing poetry here.

  2. +
  3. Install l2ss-py, with its dependencies, by running the following from the repository directory:

  4. +
+
poetry install
+
+
+

**Note:** l2ss-py can be installed as above and run without any dependency on harmony. +However, to additionally test the harmony adapter layer, +extra dependencies can be installed with poetry install -E harmony.

+
+
+

How to test l2ss-py locally

+
+

Unit tests

+

There are comprehensive unit tests for l2ss-py. The tests can be run as follows:

+
poetry run pytest -m "not aws and not integration" tests/
+
+
+

You can generate coverage reports as follows:

+
poetry run pytest --junitxml=build/reports/pytest.xml --cov=podaac/ --cov-report=html -m "not aws and not integration" tests/
+
+
+

**Note:** The majority of the tests execute core functionality of l2ss-py without ever interacting with the harmony python modules. +The test_subset_harmony tests, however, are explicitly for testing the harmony adapter layer +and do require the harmony optional dependencies be installed, +as described above with the -E harmony argument.

+
+
+

l2ss-py script

+

You can run l2ss-py on a single granule without using Harmony. In order +to run this, the l2ss-py package must be installed in your current +Python interpreter

+
$ l2ss-py --help
+usage: run_subsetter.py [-h] [--bbox BBOX BBOX BBOX BBOX]
+                        [--variables VARIABLES [VARIABLES ...]]
+                        [--min-time MIN_TIME] [--max-time MAX_TIME] [--cut]
+                        input_file output_file
+
+Run l2ss-py
+
+positional arguments:
+  input_file            File to subset
+  output_file           Output file
+
+optional arguments:
+  -h, --help            show this help message and exit
+  --bbox BBOX BBOX BBOX BBOX
+                        Bounding box in the form min_lon min_lat max_lon
+                        max_lat
+  --variables VARIABLES [VARIABLES ...]
+                        Variables, only include if variable subset is desired.
+                        Should be a space separated list of variable names
+                        e.g. sst wind_dir sst_error ...
+  --min-time MIN_TIME   Min time. Should be ISO-8601 format. Only include if
+                        temporal subset is desired.
+  --max-time MAX_TIME   Max time. Should be ISO-8601 format. Only include if
+                        temporal subset is desired.
+  --cut                 If provided, scanline will be cut
+  --shapefile SHAPEFILE
+                        Path to either shapefile or geojson file used to subset the provided input granule
+
+
+

For example:

+
l2ss-py /path/to/input.nc /path/to/output.nc --bbox -50 -10 50 10 --variables wind_speed wind_dir ice_age time --min-time '2015-07-02T09:00:00' --max-time '2015-07-02T10:00:00' --cut
+
+
+

An addition to providing a bounding box, spatial subsetting can be achieved by passing in a shapefile or a geojson file.

+

```shell script +poetry run l2ss-py /path/to/input.nc /path/to/output.nc –shapefile /path/to/test.shp

+
or
+
+```shell script
+poetry run l2ss-py /path/to/input.nc /path/to/output.nc --shapefile /path/to/test.geojson
+
+
+
+
+

Running Harmony locally

+

In order to fully test l2ss-py with Harmony, you can run Harmony locally. This requires the data exists in UAT Earthdata Cloud.

+
    +
  1. Set up local Harmony instance. Instructions here

  2. +
  3. Add concept ID for your data to services.yml

  4. +
  5. Execute a local Harmony l2ss-py request. For example:

    +
    localhost:3000/YOUR_COLLECTION_ID/ogc-api-coverages/1.0.0/collections/all/coverage/rangeset?format=application%2Fx-netcdf4&subset=lat(-10%3A10)&subset=lon(-10%3A10)&maxResults=2
    +
    +
    +
  6. +
+
+
+
+
+

Module Documentation

+
+

subset.py

+

Functions related to subsetting a NetCDF file.

+
+
+
+podaac.subsetter.subset.apply_scale_offset(scale: float, offset: float, value: float) float[source]
+

Apply scale and offset to the given value

+
+ +
+
+podaac.subsetter.subset.build_temporal_cond(min_time: str, max_time: str, dataset: Dataset, time_var_name: str) ndarray | bool[source]
+

Build the temporal condition used in the xarray ‘where’ call which +drops data not in the given bounds. If the data in the time var is +of type ‘datetime’, assume this is a normal case where the time var +uses the epoch from the ‘units’ metadata attribute to get epoch. If +the data in the time var is of type ‘timedelta’, the epoch var is +needed to calculate the datetime.

+
+
Parameters:
+
    +
  • min_time (str) – ISO timestamp representing the lower temporal bound

  • +
  • max_time (str) – ISO timestamp representing the upper temporal bound

  • +
  • dataset (xr.Dataset) – Dataset to build the condition off of

  • +
  • time_var_name (str) – Name of the time variable

  • +
+
+
Returns:
+

If temporally subsetted, returns a boolean ND-array the shape +of which matches the dimensions of the coordinate vars. ‘True’ +is essentially a noop.

+
+
Return type:
+

np.array or boolean

+
+
+
+ +
+
+podaac.subsetter.subset.calculate_chunks(dataset: Dataset) dict[source]
+

For the given dataset, calculate if the size on any dimension is +worth chunking. Any dimension larger than 4000 will be chunked. This +is done to ensure that the variable can fit in memory.

+
+
Parameters:
+

dataset (xarray.Dataset) – The dataset to calculate chunks for.

+
+
Returns:
+

The chunk dictionary, where the key is the dimension and the +value is 4000 or 500 depending on how many dimensions.

+
+
Return type:
+

dict

+
+
+
+ +
+
+podaac.subsetter.subset.compute_coordinate_variable_names(dataset: Dataset) Tuple[List[str] | str, List[str] | str][source]
+

Given a dataset, determine the coordinate variable from a list +of options

+
+
Parameters:
+

dataset (xr.Dataset) – The dataset to find the coordinate variables for

+
+
Returns:
+

Tuple of strings (or list of strings), where the first element is the lat coordinate +name and the second element is the lon coordinate name

+
+
Return type:
+

tuple, str

+
+
+
+ +
+
+podaac.subsetter.subset.compute_time_variable_name(dataset: Dataset, lat_var: Variable, total_time_vars: list) str[source]
+

Try to determine the name of the ‘time’ variable. This is done as +follows:

+
    +
  • The variable name contains ‘time’

  • +
  • The variable dimensions match the dimensions of the given lat var

  • +
  • The variable that hasn’t already been found

  • +
+
+
Parameters:
+
    +
  • dataset (xr.Dataset) – xarray dataset to find time variable from

  • +
  • lat_var (xr.Variable) – Lat variable for this dataset

  • +
+
+
Returns:
+

The name of the variable

+
+
Return type:
+

str

+
+
Raises:
+

ValueError – If the time variable could not be determined

+
+
+
+ +
+
+podaac.subsetter.subset.compute_utc_name(dataset: Dataset) str | None[source]
+

Get the name of the utc variable if it is there to determine origine time

+
+ +
+
+podaac.subsetter.subset.convert_bbox(bbox: ndarray, dataset: Dataset, lat_var_name: str, lon_var_name: str) ndarray[source]
+

This function will return a converted bbox which matches the range +of the given input file. This will convert both the latitude and +longitude range. For example, an input dataset can have a valid +longitude range of -180 –> 180 or of 0 –> 360.

+
+
Parameters:
+
    +
  • bbox (np.array) – The bounding box

  • +
  • dataset (xarray.Dataset) – The dataset which is being subset.

  • +
  • lat_var_name (str) – Name of the lat variable in the given dataset

  • +
  • lon_var_name (str) – Name of the lon variable in the given dataset

  • +
+
+
Returns:
+

bbox – The new bbox which matches latitude and longitude ranges of the +input file.

+
+
Return type:
+

np.array

+
+
+

Notes

+

Assumption that the provided bounding box is always between +-180 –> 180 for longitude and -90, 90 for latitude.

+
+ +
+
+podaac.subsetter.subset.convert_bound(bound: ndarray, coord_max: int, coord_var: DataArray) ndarray[source]
+

This function will return a converted bound, which matches the +range of the given input file.

+
+
Parameters:
+
    +
  • bound (np.array) – 1-dimensional 2-element numpy array which represent the lower +and upper bounding box on this coordinate, respectively.

  • +
  • coord_max (integer) – The max value which is possible given this coordinate. For +example, the max for longitude is 360.

  • +
  • coord_var (xarray.DataArray) – The xarray variable for some coordinate.

  • +
+
+
Returns:
+

1-dimensional 2-element number array which represents the lower +and upper bounding box on this coordinate and has been converted +based on the valid bounds coordinate range of the dataset.

+
+
Return type:
+

np.array

+
+
+

Notes

+

Assumption that 0 is always on the prime meridian/equator.

+
+ +
+
+podaac.subsetter.subset.datetime_from_mjd(dataset: Dataset, time_var_name: str) datetime | None[source]
+

Translate the modified julian date from the long name in the time attribute.

+
+
Parameters:
+
    +
  • dataset (xr.Dataset) – Dataset that contains time var

  • +
  • time_var_name (str) – The name of the actual time var (with matching dims to the +coord vars)

  • +
+
+
Returns:
+

the datetime of the modified julian date

+
+
Return type:
+

datetime

+
+
+
+ +
+
+podaac.subsetter.subset.find_matching_coords(dataset: Dataset, match_list: List[str]) List[str][source]
+

As a backup for finding a coordinate var, look at the ‘coordinates’ +metadata attribute of all data vars in the granule. Return any +coordinate vars that have name matches with the provided +‘match_list’

+
+
Parameters:
+
    +
  • dataset (xr.Dataset) – Dataset to search data variable coordinate metadata attribute

  • +
  • match_list (list (str)) – List of possible matches to search for. For example, +[‘lat’, ‘latitude’] would search for variables in the +‘coordinates’ metadata attribute containing either ‘lat’ +or ‘latitude’

  • +
+
+
Returns:
+

List of matching coordinate variables names

+
+
Return type:
+

list (str)

+
+
+
+ +
+
+podaac.subsetter.subset.get_base_group_names(lats: List[str]) Tuple[List[str], List[str | int]][source]
+

Latitude groups may be at different depths. This function gets the level +number that makes each latitude group unique from the other latitude names

+
+ +
+
+podaac.subsetter.subset.get_coordinate_variable_names(dataset: Dataset, lat_var_names: list | None = None, lon_var_names: list | None = None, time_var_names: list | None = None)[source]
+

Retrieve coordinate variables for this dataset. If coordinate +variables are provided, use those, Otherwise, attempt to determine +coordinate variables manually.

+
+
Parameters:
+
    +
  • dataset (xr.Dataset) – xarray Dataset used to compute coordinate variables manually. +Only used if lat, lon, or time vars are not provided.

  • +
  • lat_var_names (list) – List of latitude coordinate variables.

  • +
  • lon_var_names (list) – List of longitude coordinate variables.

  • +
  • time_var_names (list) – List of time coordinate variables.

  • +
+
+
Returns:
+

TODO

+
+
Return type:
+

add return type docstring and type hint.

+
+
+
+ +
+
+podaac.subsetter.subset.get_spatial_bounds(dataset: Dataset, lat_var_names: str, lon_var_names: str) ndarray | None[source]
+

Get the spatial bounds for this dataset. These values are masked +and scaled.

+
+
Parameters:
+
    +
  • dataset (xr.Dataset) – Dataset to retrieve spatial bounds for

  • +
  • lat_var_names (str) – Name of the lat variable

  • +
  • lon_var_names (str) – Name of the lon variable

  • +
+
+
Returns:
+

[[lon min, lon max], [lat min, lat max]]

+
+
Return type:
+

np.array

+
+
+
+ +
+
+podaac.subsetter.subset.get_time_epoch_var(dataset: Dataset, time_var_name: str) str[source]
+

Get the name of the epoch time var. This is only needed in the case +where there is a single time var (of size 1) that contains the time +epoch used by the actual time var.

+
+
Parameters:
+
    +
  • dataset (xr.Dataset) – Dataset that contains time var

  • +
  • time_var_name (str) – The name of the actual time var (with matching dims to the +coord vars)

  • +
+
+
Returns:
+

The name of the epoch time variable

+
+
Return type:
+

str

+
+
+
+ +
+
+podaac.subsetter.subset.is_360(lon_var: DataArray, scale: float, offset: float) bool[source]
+

Determine if given dataset is a ‘360’ dataset or not.

+
+
Parameters:
+
    +
  • lon_var (xr.DataArray) – The lon variable from the xarray Dataset

  • +
  • scale (float) – Used to remove scale and offset for easier calculation

  • +
  • offset (float) – Used to remove scale and offset for easier calculation

  • +
+
+
Returns:
+

True if dataset is 360, False if not. Defaults to False.

+
+
Return type:
+

bool

+
+
+
+ +
+
+podaac.subsetter.subset.is_time_mjd(dataset: Dataset, time_var_name: str) bool[source]
+

Check to see if the time format is a time delta from a modified julian date.

+
+
Parameters:
+
    +
  • dataset (xr.Dataset) – Dataset that contains time var

  • +
  • time_var_name (str) – The name of the actual time var (with matching dims to the +coord vars)

  • +
+
+
Returns:
+

is time delta format in modified julian date

+
+
Return type:
+

boolean

+
+
+
+ +
+
+podaac.subsetter.subset.open_as_nc_dataset(filepath: str) Tuple[Dataset, bool][source]
+

Open netcdf file, and flatten groups if they exist.

+
+ +
+
+podaac.subsetter.subset.override_decode_cf_datetime() None[source]
+

WARNING !!! REMOVE AT EARLIEST XARRAY FIX, this is a override to xarray override_decode_cf_datetime function. +xarray has problems decoding time units with format seconds since 2000-1-1 0:0:0 0, this solves by testing +the unit to see if its parsable, if it is use original function, if not format unit into a parsable format.

+

https://github.com/pydata/xarray/issues/7210

+
+ +
+
+podaac.subsetter.subset.remove_scale_offset(value: float, scale: float, offset: float) float[source]
+

Remove scale and offset from the given value

+
+ +
+
+podaac.subsetter.subset.set_json_history(dataset: Dataset, cut: bool, file_to_subset: str, bbox: ndarray | None = None, shapefile: str | None = None, origin_source=None) None[source]
+

Set the ‘json_history’ metadata header of the granule to reflect the +current version of the subsetter, as well as the parameters used +to call the subsetter. This will append an json array to the json_history of +the following format:

+
+
Parameters:
+
    +
  • dataset (xarray.Dataset) – The dataset to change the header of

  • +
  • cut (boolean) – True to cut the scanline

  • +
  • file_to_subset (string) – The filepath of the file which was used to subset

  • +
  • bbox (np.ndarray) – The requested bounding box

  • +
  • shapefile (str) – Name of the shapefile to include in the version history

  • +
  • TODO (add docstring and type hint for origin_source parameter.)

  • +
+
+
+
+ +
+
+podaac.subsetter.subset.set_version_history(dataset: Dataset, cut: bool, bbox: ndarray | None = None, shapefile: str | None = None) None[source]
+

Set the ‘history’ metadata header of the granule to reflect the +current version of the subsetter, as well as the parameters used +to call the subsetter. This will append a line to the history of +the following format:

+

TIMESTAMP podaac.subsetter VERSION (PARAMS)

+
+
Parameters:
+
    +
  • dataset (xarray.Dataset) – The dataset to change the header of

  • +
  • cut (boolean) – True to cut the scanline

  • +
  • bbox (np.ndarray) – The requested bounding box

  • +
  • shapefile (str) – Name of the shapefile to include in the version history

  • +
+
+
+
+ +
+
+podaac.subsetter.subset.subset(file_to_subset: str, bbox: ndarray, output_file: str, variables: List[str] | str | None = (), cut: bool = True, shapefile: str | None = None, min_time: str | None = None, max_time: str | None = None, origin_source: str | None = None, lat_var_names: List[str] = (), lon_var_names: List[str] = (), time_var_names: List[str] = ()) ndarray | None[source]
+

Subset a given NetCDF file given a bounding box

+
+
Parameters:
+
    +
  • file_to_subset (string) – The location of the file which will be subset

  • +
  • bbox (np.ndarray) – The chosen bounding box. This is a tuple of tuples formatted +as such: ((west, east), (south, north)). The assumption is that +the valid range is ((-180, 180), (-90, 90)). This will be +transformed as appropriate if the actual longitude range is +0-360.

  • +
  • output_file (string) – The file path for the output of the subsetting operation.

  • +
  • variables (list, str, optional) – List of variables to include in the resulting data file. +NOTE: This will remove ALL variables which are not included +in this list, including coordinate variables!

  • +
  • cut (boolean) – True if the scanline should be cut, False if the scanline should +not be cut. Defaults to True.

  • +
  • shapefile (str) – Name of local shapefile used to subset given file.

  • +
  • min_time (str) – ISO timestamp representing the lower bound of the temporal +subset to be performed. If this value is not provided, the +granule will not be subset temporally on the lower bound.

  • +
  • max_time (str) – ISO timestamp representing the upper bound of the temporal +subset to be performed. If this value is not provided, the +granule will not be subset temporally on the upper bound.

  • +
  • origin_source (str) – Original location or filename of data to be used in “derived from” +history element.

  • +
  • lat_var_names (list) – List of variables that represent the latitude coordinate +variables for this granule. This list will only contain more +than one value in the case where there are multiple groups and +different coordinate variables for each group.

  • +
  • lon_var_names (list) – List of variables that represent the longitude coordinate +variables for this granule. This list will only contain more +than one value in the case where there are multiple groups and +different coordinate variables for each group.

  • +
  • time_var_names (list) – List of variables that represent the time coordinate +variables for this granule. This list will only contain more +than one value in the case where there are multiple groups and +different coordinate variables for each group.

  • +
+
+
+
+ +
+
+podaac.subsetter.subset.subset_with_bbox(dataset: Dataset, lat_var_names: list, lon_var_names: list, time_var_names: list, variables: List[str] | None = None, bbox: ndarray | None = None, cut: bool = True, min_time: str | None = None, max_time: str | None = None) ndarray[source]
+

Subset an xarray Dataset using a spatial bounding box.

+
+
Parameters:
+
    +
  • dataset (xr.Dataset) – Dataset to subset

  • +
  • lat_var_names (list) – Name of the latitude variables in the given dataset

  • +
  • lon_var_names (list) – Name of the longitude variables in the given dataset

  • +
  • time_var_names (list) – Name of the time variables in the given dataset

  • +
  • variables (list[str]) – List of variables to include in the result

  • +
  • bbox (np.array) – Spatial bounding box to subset Dataset with.

  • +
  • cut (bool) – True if scanline should be cut.

  • +
  • min_time (str) – ISO timestamp of min temporal bound

  • +
  • max_time (str) – ISO timestamp of max temporal bound

  • +
  • TODO (add docstring and type hint for variables parameter.)

  • +
+
+
Returns:
+

    +
  • np.array – Spatial bounds of Dataset after subset operation

  • +
  • TODO - fix this docstring type and the type hint to match code (currently returning a list[xr.Dataset])

  • +
+

+
+
+
+ +
+
+podaac.subsetter.subset.subset_with_shapefile(dataset: Dataset, lat_var_name: str, lon_var_name: str, shapefile: str, cut: bool, chunks) ndarray[source]
+

Subset an xarray Dataset using a shapefile

+
+
Parameters:
+
    +
  • dataset (xr.Dataset) – Dataset to subset

  • +
  • lat_var_name (str) – Name of the latitude variable in the given dataset

  • +
  • lon_var_name (str) – Name of the longitude variable in the given dataset

  • +
  • shapefile (str) – Absolute path to the shapefile used to subset the given dataset

  • +
  • cut (bool) – True if scanline should be cut.

  • +
  • TODO (add docstring and type hint for chunks parameter.)

  • +
+
+
Returns:
+

    +
  • np.array – Spatial bounds of Dataset after shapefile subset operation

  • +
  • TODO - fix this docstring type and the type hint to match code (currently returning a xr.Dataset)

  • +
+

+
+
+
+ +
+
+podaac.subsetter.subset.test_access_sst_dtime_values(datafile)[source]
+

Test accessing values of ‘sst_dtime’ variable in a NetCDF file.

+
+
Parameters:
+

(str) (datafile)

+
+
Returns:
+

access_successful (bool)

+
+
Return type:
+

True if ‘sst_dtime’ values are accessible, False otherwise.

+
+
+
+ +
+
+podaac.subsetter.subset.translate_longitude(geometry)[source]
+

Translates the longitude values of a Shapely geometry from the range [-180, 180) to [0, 360).

+
+
Parameters:
+

geometry (shapely.geometry.base.BaseGeometry) – The input shape geometry to be translated

+
+
Returns:
+

The translated shape geometry

+
+
Return type:
+

geometry

+
+
+
+ +
+
+podaac.subsetter.subset.translate_timestamp(str_timestamp: str) datetime[source]
+

Translate timestamp to datetime object

+
+
Parameters:
+

str_timestamp (str) – Timestamp string. ISO or RFC

+
+
Returns:
+

Constructed Datetime object

+
+
Return type:
+

datetime

+
+
+
+ +
+

subset_harmony.py

+

Implementation of harmony-service-lib that invokes the Level 2 subsetter.

+
+
+
+class podaac.subsetter.subset_harmony.L2SubsetterService(message, catalog=None, config=None)[source]
+

See https://github.com/nasa/harmony-service-lib-py +for documentation and examples.

+
+
+__init__(message, catalog=None, config=None)[source]
+

Constructs the adapter

+
+
Parameters:
+
    +
  • message (harmony.Message) – The Harmony input which needs acting upon

  • +
  • catalog (pystac.Catalog) – A STAC catalog containing the files on which to act

  • +
  • config (harmony.util.Config) – The configuration values for this runtime environment.

  • +
+
+
+
+ +
+
+cmd(*args) List[str][source]
+

Logs and then runs command.

+
+
Parameters:
+

run (args Command and args to)

+
+
Return type:
+

Command output

+
+
+
+ +
+
+prepare_output_dir(output_dir: str) None[source]
+

Deletes (if present) and recreates the given output_dir, ensuring it exists +and is empty

+
+
Parameters:
+

output_dir (string) – the directory to delete and recreate

+
+
+
+ +
+
+process_item(item: Item, source: Source) Item[source]
+

Performs variable and bounding box subsetting on the input STAC Item’s data, returning +an output STAC item

+
+
Parameters:
+
    +
  • item (pystac.Item) – the item that should be subset

  • +
  • source (harmony.message.Source) – the input source defining the variables, if any, to subset from the item

  • +
+
+
Returns:
+

a STAC item describing the output of the subsetter

+
+
Return type:
+

pystac.Item

+
+
+
+ +
+ +
+
+podaac.subsetter.subset_harmony.harmony_to_podaac_bbox(bbox: list) ndarray[source]
+

Convert Harmony bbox (west, south, east, north) +to PO.DAAC bbox ((west, east), (south, north))

+
+
Parameters:
+

bbox (list) – Harmony bbox

+
+
Returns:
+

PO.DAAC bbox

+
+
Return type:
+

np.array

+
+
+
+ +
+
+podaac.subsetter.subset_harmony.main(config: Config | None = None) None[source]
+

Parse command line arguments and invoke the service to respond to +them.

+
+
Parameters:
+

config (harmony.util.Config)

+
+
Return type:
+

None

+
+
+
+ +
+
+podaac.subsetter.subset_harmony.podaac_to_harmony_bbox(bbox: ndarray) ndarray | float[source]
+

Convert PO.DAAC bbox ((west, east), (south, north)) +to Harmony bbox (west, south, east, north)

+
+
Parameters:
+

bbox (np.array) – Podaac bbox

+
+
Returns:
+

    +
  • array, int or float – Harmony bbox

  • +
  • TODO - fix this docstring type, type hint, and code to match (code currently returns a list)

  • +
+

+
+
+
+ +

run_subsetter.py

+

This script runs L2SS-Py on the given granule.

+
+
+podaac.subsetter.run_subsetter.main() None[source]
+

Entry point to the script

+
+ +
+
+podaac.subsetter.run_subsetter.parse_args(args: list) tuple[source]
+

Parse args for this script.

+
+
Returns:
+

input_file, output_file, bbox, variables, min_time, max_time

+
+
Return type:
+

tuple

+
+
+
+ +
+
+podaac.subsetter.run_subsetter.run_subsetter(args: list) None[source]
+

Parse arguments and run subsetter on the specified input file

+
+ +
+

xarray_enhancements.py

+

Functions which improve upon existing xarray functionality, optimized +for this specific use-case.

+
+
+
+podaac.subsetter.xarray_enhancements.cast_type(var: DataArray, var_type: str) DataArray[source]
+

Type cast a variable into a var type.

+
+
Parameters:
+
    +
  • var (xr.DataArray) – The dataarray to be type casted.

  • +
  • var_type (string) – New type the variable will be type casted to.

  • +
+
+
Returns:
+

The newly type casted variable.

+
+
Return type:
+

xr.DataArray

+
+
+
+ +
+
+podaac.subsetter.xarray_enhancements.copy_empty_dataset(dataset: Dataset) Dataset[source]
+
+
Copy a dataset into a new, empty dataset. This dataset should:
    +
  • Contain the same structure as the input dataset (only include +requested variables, if variable subset)

  • +
  • Contain the same global metadata as the input dataset

  • +
  • Contain a history field which describes this subset operation.

  • +
+
+
+
+
Parameters:
+

dataset (xarray.Dataset) – The dataset to copy into a empty dataset.

+
+
Returns:
+

The new dataset which has no data.

+
+
Return type:
+

xarray.Dataset

+
+
+
+ +
+
+podaac.subsetter.xarray_enhancements.get_indexers_from_1d(cond: Dataset) dict[source]
+

Get indexers from a dataset with 1 dimension.

+
+
Parameters:
+

cond (xarray.Dataset) – Contains the result of the initial lat lon condition.

+
+
Returns:
+

Indexer dictionary for the provided condition.

+
+
Return type:
+

dict

+
+
+
+ +
+
+podaac.subsetter.xarray_enhancements.get_indexers_from_nd(cond: Dataset, cut: bool) dict[source]
+

Get indexers from a dataset with more than one dimension.

+
+
Parameters:
+
    +
  • cond (xarray.Dataset) – Contains the result of the initial lat lon condition.

  • +
  • cut (bool) – True if the scanline should be cut.

  • +
+
+
Returns:
+

Indexer dictionary for the provided condition.

+
+
Return type:
+

dict

+
+
+
+ +
+
+podaac.subsetter.xarray_enhancements.get_variables_with_indexers(dataset, indexers)[source]
+

returns a list of variables with bounding box dimensions and variables that +don’t have bounding box dimensions

+
+ +
+
+podaac.subsetter.xarray_enhancements.where(dataset: Dataset, cond: Dataset | DataArray, cut: bool) Dataset[source]
+

Return a dataset which meets the given condition.

+

This is a modification of the existing xarray ‘where’ function. +https://github.com/pydata/xarray/blob/master/xarray/core/common.py#L999

+
+
Parameters:
+
    +
  • dataset (xarray.Dataset) – The dataset to filter and return.

  • +
  • cond (DataArray or Dataset with boolean dtype) – Locations at which to preserve this object’s values.

  • +
  • cut (boolean) – True if the scanline should be cut, False if the scanline should +not be cut.

  • +
+
+
Returns:
+

The filtered Dataset

+
+
Return type:
+

xarray.Dataset

+
+
+

Notes

+

The cond variable contains a boolean mask of valid data indices. +However in that mask, True represents valid data and False +represents invalid data.

+
+ +
+
+

Indices and tables

+ +
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/2.12.0a2/objects.inv b/2.12.0a2/objects.inv new file mode 100644 index 00000000..b562a49c Binary files /dev/null and b/2.12.0a2/objects.inv differ diff --git a/2.12.0a2/py-modindex.html b/2.12.0a2/py-modindex.html new file mode 100644 index 00000000..fe9176ed --- /dev/null +++ b/2.12.0a2/py-modindex.html @@ -0,0 +1,142 @@ + + + + + + Python Module Index — l2ss-py 2.12.0a2 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Python Module Index

+ +
+ p +
+ + + + + + + + + + + + + + + + + + + +
 
+ p
+ podaac +
    + podaac.subsetter.run_subsetter +
    + podaac.subsetter.subset +
    + podaac.subsetter.subset_harmony +
    + podaac.subsetter.xarray_enhancements +
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/2.12.0a2/search.html b/2.12.0a2/search.html new file mode 100644 index 00000000..e5ea152a --- /dev/null +++ b/2.12.0a2/search.html @@ -0,0 +1,122 @@ + + + + + + Search — l2ss-py 2.12.0a2 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + + + +
+ +
+ +
+
+ +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/2.12.0a2/searchindex.js b/2.12.0a2/searchindex.js new file mode 100644 index 00000000..17d87bf7 --- /dev/null +++ b/2.12.0a2/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"alltitles": {"How to test l2ss-py locally": [[0, "how-to-test-l2ss-py-locally"]], "Indices and tables": [[0, "indices-and-tables"]], "Initial setup, with poetry": [[0, "initial-setup-with-poetry"]], "Module Documentation": [[0, "module-podaac.subsetter.subset"]], "Reference Guide for l2ss-py": [[0, null]], "Running Harmony locally": [[0, "running-harmony-locally"]], "Unit tests": [[0, "unit-tests"]], "l2ss-py": [[0, "l2ss-py"]], "l2ss-py script": [[0, "l2ss-py-script"]], "subset.py": [[0, "subset-py"]], "subset_harmony.py": [[0, "subset-harmony-py"]], "xarray_enhancements.py": [[0, "xarray-enhancements-py"]]}, "docnames": ["index"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1}, "filenames": ["index.rst"], "indexentries": {"__init__() (podaac.subsetter.subset_harmony.l2subsetterservice method)": [[0, "podaac.subsetter.subset_harmony.L2SubsetterService.__init__", false]], "apply_scale_offset() (in module podaac.subsetter.subset)": [[0, "podaac.subsetter.subset.apply_scale_offset", false]], "build_temporal_cond() (in module podaac.subsetter.subset)": [[0, "podaac.subsetter.subset.build_temporal_cond", false]], "calculate_chunks() (in module podaac.subsetter.subset)": [[0, "podaac.subsetter.subset.calculate_chunks", false]], "cast_type() (in module podaac.subsetter.xarray_enhancements)": [[0, "podaac.subsetter.xarray_enhancements.cast_type", false]], "cmd() (podaac.subsetter.subset_harmony.l2subsetterservice method)": [[0, "podaac.subsetter.subset_harmony.L2SubsetterService.cmd", false]], "compute_coordinate_variable_names() (in module podaac.subsetter.subset)": [[0, "podaac.subsetter.subset.compute_coordinate_variable_names", false]], "compute_time_variable_name() (in module podaac.subsetter.subset)": [[0, "podaac.subsetter.subset.compute_time_variable_name", false]], "compute_utc_name() (in module podaac.subsetter.subset)": [[0, "podaac.subsetter.subset.compute_utc_name", false]], "convert_bbox() (in module podaac.subsetter.subset)": [[0, "podaac.subsetter.subset.convert_bbox", false]], "convert_bound() (in module podaac.subsetter.subset)": [[0, "podaac.subsetter.subset.convert_bound", false]], "copy_empty_dataset() (in module podaac.subsetter.xarray_enhancements)": [[0, "podaac.subsetter.xarray_enhancements.copy_empty_dataset", false]], "datetime_from_mjd() (in module podaac.subsetter.subset)": [[0, "podaac.subsetter.subset.datetime_from_mjd", false]], "find_matching_coords() (in module podaac.subsetter.subset)": [[0, "podaac.subsetter.subset.find_matching_coords", false]], "get_base_group_names() (in module podaac.subsetter.subset)": [[0, "podaac.subsetter.subset.get_base_group_names", false]], "get_coordinate_variable_names() (in module podaac.subsetter.subset)": [[0, "podaac.subsetter.subset.get_coordinate_variable_names", false]], "get_indexers_from_1d() (in module podaac.subsetter.xarray_enhancements)": [[0, "podaac.subsetter.xarray_enhancements.get_indexers_from_1d", false]], "get_indexers_from_nd() (in module podaac.subsetter.xarray_enhancements)": [[0, "podaac.subsetter.xarray_enhancements.get_indexers_from_nd", false]], "get_spatial_bounds() (in module podaac.subsetter.subset)": [[0, "podaac.subsetter.subset.get_spatial_bounds", false]], "get_time_epoch_var() (in module podaac.subsetter.subset)": [[0, "podaac.subsetter.subset.get_time_epoch_var", false]], "get_variables_with_indexers() (in module podaac.subsetter.xarray_enhancements)": [[0, "podaac.subsetter.xarray_enhancements.get_variables_with_indexers", false]], "harmony_to_podaac_bbox() (in module podaac.subsetter.subset_harmony)": [[0, "podaac.subsetter.subset_harmony.harmony_to_podaac_bbox", false]], "is_360() (in module podaac.subsetter.subset)": [[0, "podaac.subsetter.subset.is_360", false]], "is_time_mjd() (in module podaac.subsetter.subset)": [[0, "podaac.subsetter.subset.is_time_mjd", false]], "l2subsetterservice (class in podaac.subsetter.subset_harmony)": [[0, "podaac.subsetter.subset_harmony.L2SubsetterService", false]], "main() (in module podaac.subsetter.run_subsetter)": [[0, "podaac.subsetter.run_subsetter.main", false]], "main() (in module podaac.subsetter.subset_harmony)": [[0, "podaac.subsetter.subset_harmony.main", false]], "module": [[0, "module-podaac.subsetter.run_subsetter", false], [0, "module-podaac.subsetter.subset", false], [0, "module-podaac.subsetter.subset_harmony", false], [0, "module-podaac.subsetter.xarray_enhancements", false]], "open_as_nc_dataset() (in module podaac.subsetter.subset)": [[0, "podaac.subsetter.subset.open_as_nc_dataset", false]], "override_decode_cf_datetime() (in module podaac.subsetter.subset)": [[0, "podaac.subsetter.subset.override_decode_cf_datetime", false]], "parse_args() (in module podaac.subsetter.run_subsetter)": [[0, "podaac.subsetter.run_subsetter.parse_args", false]], "podaac.subsetter.run_subsetter": [[0, "module-podaac.subsetter.run_subsetter", false]], "podaac.subsetter.subset": [[0, "module-podaac.subsetter.subset", false]], "podaac.subsetter.subset_harmony": [[0, "module-podaac.subsetter.subset_harmony", false]], "podaac.subsetter.xarray_enhancements": [[0, "module-podaac.subsetter.xarray_enhancements", false]], "podaac_to_harmony_bbox() (in module podaac.subsetter.subset_harmony)": [[0, "podaac.subsetter.subset_harmony.podaac_to_harmony_bbox", false]], "prepare_output_dir() (podaac.subsetter.subset_harmony.l2subsetterservice method)": [[0, "podaac.subsetter.subset_harmony.L2SubsetterService.prepare_output_dir", false]], "process_item() (podaac.subsetter.subset_harmony.l2subsetterservice method)": [[0, "podaac.subsetter.subset_harmony.L2SubsetterService.process_item", false]], "remove_scale_offset() (in module podaac.subsetter.subset)": [[0, "podaac.subsetter.subset.remove_scale_offset", false]], "run_subsetter() (in module podaac.subsetter.run_subsetter)": [[0, "podaac.subsetter.run_subsetter.run_subsetter", false]], "set_json_history() (in module podaac.subsetter.subset)": [[0, "podaac.subsetter.subset.set_json_history", false]], "set_version_history() (in module podaac.subsetter.subset)": [[0, "podaac.subsetter.subset.set_version_history", false]], "subset() (in module podaac.subsetter.subset)": [[0, "podaac.subsetter.subset.subset", false]], "subset_with_bbox() (in module podaac.subsetter.subset)": [[0, "podaac.subsetter.subset.subset_with_bbox", false]], "subset_with_shapefile() (in module podaac.subsetter.subset)": [[0, "podaac.subsetter.subset.subset_with_shapefile", false]], "test_access_sst_dtime_values() (in module podaac.subsetter.subset)": [[0, "podaac.subsetter.subset.test_access_sst_dtime_values", false]], "translate_longitude() (in module podaac.subsetter.subset)": [[0, "podaac.subsetter.subset.translate_longitude", false]], "translate_timestamp() (in module podaac.subsetter.subset)": [[0, "podaac.subsetter.subset.translate_timestamp", false]], "where() (in module podaac.subsetter.xarray_enhancements)": [[0, "podaac.subsetter.xarray_enhancements.where", false]]}, "objects": {"podaac.subsetter": [[0, 0, 0, "-", "run_subsetter"], [0, 0, 0, "-", "subset"], [0, 0, 0, "-", "subset_harmony"], [0, 0, 0, "-", "xarray_enhancements"]], "podaac.subsetter.run_subsetter": [[0, 1, 1, "", "main"], [0, 1, 1, "", "parse_args"], [0, 1, 1, "", "run_subsetter"]], "podaac.subsetter.subset": [[0, 1, 1, "", "apply_scale_offset"], [0, 1, 1, "", "build_temporal_cond"], [0, 1, 1, "", "calculate_chunks"], [0, 1, 1, "", "compute_coordinate_variable_names"], [0, 1, 1, "", "compute_time_variable_name"], [0, 1, 1, "", "compute_utc_name"], [0, 1, 1, "", "convert_bbox"], [0, 1, 1, "", "convert_bound"], [0, 1, 1, "", "datetime_from_mjd"], [0, 1, 1, "", "find_matching_coords"], [0, 1, 1, "", "get_base_group_names"], [0, 1, 1, "", "get_coordinate_variable_names"], [0, 1, 1, "", "get_spatial_bounds"], [0, 1, 1, "", "get_time_epoch_var"], [0, 1, 1, "", "is_360"], [0, 1, 1, "", "is_time_mjd"], [0, 1, 1, "", "open_as_nc_dataset"], [0, 1, 1, "", "override_decode_cf_datetime"], [0, 1, 1, "", "remove_scale_offset"], [0, 1, 1, "", "set_json_history"], [0, 1, 1, "", "set_version_history"], [0, 1, 1, "", "subset"], [0, 1, 1, "", "subset_with_bbox"], [0, 1, 1, "", "subset_with_shapefile"], [0, 1, 1, "", "test_access_sst_dtime_values"], [0, 1, 1, "", "translate_longitude"], [0, 1, 1, "", "translate_timestamp"]], "podaac.subsetter.subset_harmony": [[0, 2, 1, "", "L2SubsetterService"], [0, 1, 1, "", "harmony_to_podaac_bbox"], [0, 1, 1, "", "main"], [0, 1, 1, "", "podaac_to_harmony_bbox"]], "podaac.subsetter.subset_harmony.L2SubsetterService": [[0, 3, 1, "", "__init__"], [0, 3, 1, "", "cmd"], [0, 3, 1, "", "prepare_output_dir"], [0, 3, 1, "", "process_item"]], "podaac.subsetter.xarray_enhancements": [[0, 1, 1, "", "cast_type"], [0, 1, 1, "", "copy_empty_dataset"], [0, 1, 1, "", "get_indexers_from_1d"], [0, 1, 1, "", "get_indexers_from_nd"], [0, 1, 1, "", "get_variables_with_indexers"], [0, 1, 1, "", "where"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "method", "Python method"]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:method"}, "terms": {"": 0, "0": 0, "00": 0, "02t09": 0, "02t10": 0, "07": 0, "1": 0, "10": 0, "180": 0, "2": 0, "2000": 0, "2015": 0, "2fx": 0, "3000": 0, "360": 0, "3a10": 0, "4000": 0, "50": 0, "500": 0, "7210": 0, "8601": 0, "90": 0, "A": 0, "AT": 0, "As": 0, "For": 0, "If": 0, "In": 0, "The": 0, "There": 0, "These": 0, "__init__": 0, "abov": 0, "absolut": 0, "access": 0, "access_success": 0, "achiev": 0, "act": 0, "action": 0, "actual": 0, "adapt": 0, "add": 0, "addit": 0, "addition": 0, "after": 0, "all": 0, "alreadi": 0, "alt": 0, "alwai": 0, "an": 0, "ani": 0, "api": 0, "append": 0, "appli": 0, "applic": 0, "apply_scale_offset": 0, "appropri": 0, "ar": 0, "arg": 0, "argument": 0, "arrai": 0, "assum": 0, "assumpt": 0, "attempt": 0, "attribut": 0, "aw": 0, "backup": 0, "badg": 0, "base": 0, "basegeometri": 0, "bbox": 0, "been": 0, "being": 0, "between": 0, "blob": 0, "bool": 0, "boolean": 0, "both": 0, "bound": 0, "box": 0, "branch": 0, "build": 0, "build_temporal_cond": 0, "calcul": 0, "calculate_chunk": 0, "call": 0, "can": 0, "case": 0, "cast": 0, "cast_typ": 0, "catalog": 0, "chang": 0, "check": 0, "chosen": 0, "chunk": 0, "class": 0, "cloud": 0, "cmd": 0, "code": 0, "collect": 0, "com": 0, "command": 0, "common": 0, "comprehens": 0, "comput": 0, "compute_coordinate_variable_nam": 0, "compute_time_variable_nam": 0, "compute_utc_nam": 0, "concept": 0, "cond": 0, "condit": 0, "config": 0, "configur": 0, "construct": 0, "contain": 0, "contribut": 0, "convert": 0, "convert_bbox": 0, "convert_bound": 0, "coord": 0, "coord_max": 0, "coord_var": 0, "coordin": 0, "copi": 0, "copy_empty_dataset": 0, "core": 0, "could": 0, "cov": 0, "coverag": 0, "current": 0, "cut": 0, "daac": 0, "data": 0, "dataarrai": 0, "datafil": 0, "dataset": 0, "date": 0, "datetim": 0, "datetime_from_mjd": 0, "decod": 0, "default": 0, "defin": 0, "delet": 0, "delta": 0, "depend": 0, "depth": 0, "deriv": 0, "describ": 0, "desir": 0, "determin": 0, "develop": 0, "dict": 0, "dictionari": 0, "differ": 0, "dim": 0, "dimens": 0, "dimension": 0, "directori": 0, "do": 0, "docstr": 0, "don": 0, "done": 0, "drop": 0, "dtype": 0, "e": 0, "each": 0, "earliest": 0, "earthdata": 0, "easier": 0, "east": 0, "either": 0, "element": 0, "empti": 0, "ensur": 0, "entri": 0, "environ": 0, "epoch": 0, "equat": 0, "essenti": 0, "event": 0, "ever": 0, "exampl": 0, "execut": 0, "exist": 0, "exit": 0, "explicitli": 0, "extra": 0, "fals": 0, "field": 0, "file": 0, "file_to_subset": 0, "filenam": 0, "filepath": 0, "filter": 0, "find": 0, "find_matching_coord": 0, "first": 0, "fit": 0, "fix": 0, "flatten": 0, "float": 0, "follow": 0, "form": 0, "format": 0, "found": 0, "from": 0, "fulli": 0, "function": 0, "g": 0, "gener": 0, "geojson": 0, "geometri": 0, "get": 0, "get_base_group_nam": 0, "get_coordinate_variable_nam": 0, "get_indexers_from_1d": 0, "get_indexers_from_nd": 0, "get_spatial_bound": 0, "get_time_epoch_var": 0, "get_variables_with_index": 0, "github": 0, "given": 0, "global": 0, "granul": 0, "group": 0, "h": 0, "ha": 0, "harmony_to_podaac_bbox": 0, "hasn": 0, "have": 0, "header": 0, "help": 0, "here": 0, "hint": 0, "histori": 0, "howev": 0, "html": 0, "http": 0, "i": 0, "ice_ag": 0, "id": 0, "imag": 0, "implement": 0, "improv": 0, "includ": 0, "index": 0, "input": 0, "input_fil": 0, "instal": 0, "instanc": 0, "instruct": 0, "int": 0, "integ": 0, "integr": 0, "interact": 0, "interpret": 0, "invalid": 0, "invok": 0, "is_360": 0, "is_time_mjd": 0, "iso": 0, "issu": 0, "item": 0, "its": 0, "json": 0, "json_histori": 0, "julian": 0, "junitxml": 0, "kei": 0, "l2": 0, "l2subsetterservic": 0, "l999": 0, "larger": 0, "lat": 0, "lat_var": 0, "lat_var_nam": 0, "latitud": 0, "layer": 0, "level": 0, "lib": 0, "like": 0, "line": 0, "list": 0, "localhost": 0, "locat": 0, "log": 0, "lon": 0, "lon_var": 0, "lon_var_nam": 0, "long": 0, "longitud": 0, "look": 0, "lower": 0, "m": 0, "mai": 0, "main": 0, "major": 0, "make": 0, "mani": 0, "manual": 0, "mask": 0, "master": 0, "match": 0, "match_list": 0, "max": 0, "max_lat": 0, "max_lon": 0, "max_tim": 0, "maxresult": 0, "meet": 0, "memori": 0, "meridian": 0, "messag": 0, "metadata": 0, "min": 0, "min_lat": 0, "min_lon": 0, "min_tim": 0, "modif": 0, "modifi": 0, "more": 0, "multipl": 0, "must": 0, "name": 0, "nasa": 0, "nc": 0, "nd": 0, "ndarrai": 0, "need": 0, "netcdf": 0, "netcdf4": 0, "new": 0, "newli": 0, "none": 0, "noop": 0, "normal": 0, "north": 0, "note": 0, "np": 0, "number": 0, "numpi": 0, "object": 0, "off": 0, "offset": 0, "ogc": 0, "one": 0, "onli": 0, "open": 0, "open_as_nc_dataset": 0, "oper": 0, "optim": 0, "option": 0, "order": 0, "origin": 0, "origin_sourc": 0, "other": 0, "otherwis": 0, "output": 0, "output_dir": 0, "output_fil": 0, "overrid": 0, "override_decode_cf_datetim": 0, "packag": 0, "page": 0, "param": 0, "paramet": 0, "pars": 0, "parsabl": 0, "parse_arg": 0, "pass": 0, "path": 0, "perform": 0, "pipelin": 0, "po": 0, "podaac": 0, "podaac_to_harmony_bbox": 0, "point": 0, "posit": 0, "possibl": 0, "prepare_output_dir": 0, "present": 0, "preserv": 0, "prime": 0, "problem": 0, "process_item": 0, "provid": 0, "push": 0, "pydata": 0, "pystac": 0, "pytest": 0, "python": 0, "rais": 0, "rang": 0, "rangeset": 0, "recreat": 0, "reflect": 0, "relat": 0, "remov": 0, "remove_scale_offset": 0, "report": 0, "repositori": 0, "repres": 0, "request": 0, "requir": 0, "respect": 0, "respond": 0, "result": 0, "retriev": 0, "return": 0, "rfc": 0, "run_subsett": 0, "runtim": 0, "same": 0, "scale": 0, "scanlin": 0, "search": 0, "second": 0, "see": 0, "separ": 0, "servic": 0, "set": 0, "set_json_histori": 0, "set_version_histori": 0, "shape": 0, "shapefil": 0, "shell": 0, "should": 0, "show": 0, "shp": 0, "sinc": 0, "singl": 0, "size": 0, "solv": 0, "some": 0, "sourc": 0, "south": 0, "space": 0, "spatial": 0, "specif": 0, "specifi": 0, "sst": 0, "sst_dtime": 0, "sst_error": 0, "stac": 0, "str": 0, "str_timestamp": 0, "string": 0, "structur": 0, "subset_with_bbox": 0, "subset_with_shapefil": 0, "subsett": 0, "support": 0, "svg": 0, "t": 0, "target": 0, "tempor": 0, "test_access_sst_dtime_valu": 0, "test_subset_harmoni": 0, "than": 0, "thei": 0, "them": 0, "thi": 0, "those": 0, "time": 0, "time_var_nam": 0, "timedelta": 0, "timestamp": 0, "todo": 0, "total_time_var": 0, "transform": 0, "translat": 0, "translate_longitud": 0, "translate_timestamp": 0, "true": 0, "try": 0, "tupl": 0, "type": 0, "uat": 0, "uniqu": 0, "up": 0, "upon": 0, "upper": 0, "us": 0, "usag": 0, "utc": 0, "util": 0, "valid": 0, "valu": 0, "valueerror": 0, "var": 0, "var_typ": 0, "variabl": 0, "version": 0, "wa": 0, "warn": 0, "well": 0, "west": 0, "where": 0, "which": 0, "wind_dir": 0, "wind_spe": 0, "without": 0, "workflow": 0, "worth": 0, "would": 0, "xarrai": 0, "xml": 0, "xr": 0, "yml": 0, "you": 0, "your": 0, "your_collection_id": 0}, "titles": ["Reference Guide for l2ss-py"], "titleterms": {"document": 0, "guid": 0, "harmoni": 0, "how": 0, "indic": 0, "initi": 0, "l2ss": 0, "local": 0, "modul": 0, "poetri": 0, "py": 0, "refer": 0, "run": 0, "script": 0, "setup": 0, "subset": 0, "subset_harmoni": 0, "tabl": 0, "test": 0, "unit": 0, "xarray_enhanc": 0}}) \ No newline at end of file