diff --git a/docs/build/doctrees/404.doctree b/docs/build/doctrees/404.doctree index ade5e4e..5084b28 100644 Binary files a/docs/build/doctrees/404.doctree and b/docs/build/doctrees/404.doctree differ diff --git a/docs/build/doctrees/about/installation.doctree b/docs/build/doctrees/about/installation.doctree index afc2d43..285a6e8 100644 Binary files a/docs/build/doctrees/about/installation.doctree and b/docs/build/doctrees/about/installation.doctree differ diff --git a/docs/build/doctrees/about/introduction.doctree b/docs/build/doctrees/about/introduction.doctree index 63ee405..012555a 100644 Binary files a/docs/build/doctrees/about/introduction.doctree and b/docs/build/doctrees/about/introduction.doctree differ diff --git a/docs/build/doctrees/about/pipeline.doctree b/docs/build/doctrees/about/pipeline.doctree index 3158263..2b10359 100644 Binary files a/docs/build/doctrees/about/pipeline.doctree and b/docs/build/doctrees/about/pipeline.doctree differ diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle index fa143e8..6959e38 100644 Binary files a/docs/build/doctrees/environment.pickle and b/docs/build/doctrees/environment.pickle differ diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree index d002da6..e803e74 100644 Binary files a/docs/build/doctrees/index.doctree and b/docs/build/doctrees/index.doctree differ diff --git a/docs/build/doctrees/modules/GeoDataGetter.doctree b/docs/build/doctrees/modules/GeoDataGetter.doctree index 07943e3..b1ceb99 100644 Binary files a/docs/build/doctrees/modules/GeoDataGetter.doctree and b/docs/build/doctrees/modules/GeoDataGetter.doctree differ diff --git a/docs/build/doctrees/modules/Geocoder_special.doctree b/docs/build/doctrees/modules/Geocoder_special.doctree index 0a7ce45..4d517b3 100644 Binary files a/docs/build/doctrees/modules/Geocoder_special.doctree and b/docs/build/doctrees/modules/Geocoder_special.doctree differ diff --git a/docs/build/doctrees/modules/OtherGeoObjects.doctree b/docs/build/doctrees/modules/OtherGeoObjects.doctree index 8e0a17d..4383ba9 100644 Binary files a/docs/build/doctrees/modules/OtherGeoObjects.doctree and b/docs/build/doctrees/modules/OtherGeoObjects.doctree differ diff --git a/docs/build/doctrees/modules/StreetExtractor.doctree b/docs/build/doctrees/modules/StreetExtractor.doctree index 4bd0a10..a269aa7 100644 Binary files a/docs/build/doctrees/modules/StreetExtractor.doctree and b/docs/build/doctrees/modules/StreetExtractor.doctree differ diff --git a/docs/build/doctrees/modules/Streets.doctree b/docs/build/doctrees/modules/Streets.doctree index 85d7be3..bd47615 100644 Binary files a/docs/build/doctrees/modules/Streets.doctree and b/docs/build/doctrees/modules/Streets.doctree differ diff --git a/docs/build/doctrees/modules/VKParser.doctree b/docs/build/doctrees/modules/VKParser.doctree index 120600f..e3d07df 100644 Binary files a/docs/build/doctrees/modules/VKParser.doctree and b/docs/build/doctrees/modules/VKParser.doctree differ diff --git a/docs/build/doctrees/modules/city_services_extract.doctree b/docs/build/doctrees/modules/city_services_extract.doctree index fb32248..c4815e1 100644 Binary files a/docs/build/doctrees/modules/city_services_extract.doctree and b/docs/build/doctrees/modules/city_services_extract.doctree differ diff --git a/docs/build/doctrees/modules/data_getter.doctree b/docs/build/doctrees/modules/data_getter.doctree index 81c37bc..3c5f780 100644 Binary files a/docs/build/doctrees/modules/data_getter.doctree and b/docs/build/doctrees/modules/data_getter.doctree differ diff --git a/docs/build/doctrees/modules/emotion_classifier.doctree b/docs/build/doctrees/modules/emotion_classifier.doctree index 6322205..d8ffb76 100644 Binary files a/docs/build/doctrees/modules/emotion_classifier.doctree and b/docs/build/doctrees/modules/emotion_classifier.doctree differ diff --git a/docs/build/doctrees/modules/event_dynamic_prediction.doctree b/docs/build/doctrees/modules/event_dynamic_prediction.doctree index b2ea3a2..8587362 100644 Binary files a/docs/build/doctrees/modules/event_dynamic_prediction.doctree and b/docs/build/doctrees/modules/event_dynamic_prediction.doctree differ diff --git a/docs/build/doctrees/modules/geocoder.doctree b/docs/build/doctrees/modules/geocoder.doctree index fc6558e..d392f75 100644 Binary files a/docs/build/doctrees/modules/geocoder.doctree and b/docs/build/doctrees/modules/geocoder.doctree differ diff --git a/docs/build/doctrees/modules/regional_activity.doctree b/docs/build/doctrees/modules/regional_activity.doctree index f3311f8..5e1a7d1 100644 Binary files a/docs/build/doctrees/modules/regional_activity.doctree and b/docs/build/doctrees/modules/regional_activity.doctree differ diff --git a/docs/build/doctrees/modules/semantic_graph.doctree b/docs/build/doctrees/modules/semantic_graph.doctree index b4018e5..5582b85 100644 Binary files a/docs/build/doctrees/modules/semantic_graph.doctree and b/docs/build/doctrees/modules/semantic_graph.doctree differ diff --git a/docs/build/doctrees/modules/text_classifier.doctree b/docs/build/doctrees/modules/text_classifier.doctree index acc4c19..dad37b2 100644 Binary files a/docs/build/doctrees/modules/text_classifier.doctree and b/docs/build/doctrees/modules/text_classifier.doctree differ diff --git a/docs/build/doctrees/modules/topic_modeler.doctree b/docs/build/doctrees/modules/topic_modeler.doctree index 7d28a01..1c6bbad 100644 Binary files a/docs/build/doctrees/modules/topic_modeler.doctree and b/docs/build/doctrees/modules/topic_modeler.doctree differ diff --git a/docs/build/doctrees/modules/visualize_graph.doctree b/docs/build/doctrees/modules/visualize_graph.doctree index 379b138..8ae8ad0 100644 Binary files a/docs/build/doctrees/modules/visualize_graph.doctree and b/docs/build/doctrees/modules/visualize_graph.doctree differ diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo index fc68774..8ae4c39 100644 --- a/docs/build/html/.buildinfo +++ b/docs/build/html/.buildinfo @@ -1,4 +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: 34fe29b96d534ed85aad7b7243c9abd1 +config: f61a6e53f7100386fd88718507394ad6 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/build/html/404.html b/docs/build/html/404.html index 07aaf15..a98403c 100644 --- a/docs/build/html/404.html +++ b/docs/build/html/404.html @@ -5,11 +5,11 @@ - - Page Not Found - sloyka 0.1.0 documentation + + Page Not Found - sloyka 0.2.1 documentation - - + + @@ -89,19 +89,6 @@ - - Auto light/dark mode - - - - - - - - - - Auto light/dark, in light mode - @@ -180,7 +167,7 @@
-
sloyka 0.1.0 documentation
 +
sloyka 0.2.1 documentation
@@ -207,7 +194,7 @@
- sloyka 0.1.0 documentation + sloyka 0.2.1 documentation
- + \ No newline at end of file diff --git a/docs/build/html/_modules/index.html b/docs/build/html/_modules/index.html index 8026f93..2d5b4e7 100644 --- a/docs/build/html/_modules/index.html +++ b/docs/build/html/_modules/index.html @@ -4,11 +4,11 @@ - - Overview: module code - sloyka 0.1.0 documentation + + Overview: module code - sloyka 0.2.1 documentation - - + + @@ -88,19 +88,6 @@ - - Auto light/dark mode - - - - - - - - - - Auto light/dark, in light mode - @@ -179,7 +166,7 @@
-
sloyka 0.1.0 documentation
 +
sloyka 0.2.1 documentation
@@ -206,7 +193,7 @@
- sloyka 0.1.0 documentation + sloyka 0.2.1 documentation @@ -294,6 +281,9 @@

All modules for which code is available

  • sloyka.src.risks.event_detector
  • sloyka.src.risks.text_classifier
  • sloyka.src.semantic_graph.semantic_graph_builder
    • +
  • sloyka.src.utils.data_getter.geo_data_getter
    • +
  • sloyka.src.utils.data_getter.street_getter
    • +
  • sloyka.src.utils.data_getter.vk_data_getter
  • sloyka.src.utils.data_processing.city_services_extract
  • sloyka.src.visual.graph_visualization
    • @@ -327,9 +317,9 @@

    All modules for which code is available

    - + - + \ No newline at end of file diff --git a/docs/build/html/_modules/sloyka/src/geocoder/city_objects_extractor.html b/docs/build/html/_modules/sloyka/src/geocoder/city_objects_extractor.html index a96e67f..0ea86f3 100644 --- a/docs/build/html/_modules/sloyka/src/geocoder/city_objects_extractor.html +++ b/docs/build/html/_modules/sloyka/src/geocoder/city_objects_extractor.html @@ -4,11 +4,11 @@ - - sloyka.src.geocoder.city_objects_extractor - sloyka 0.1.0 documentation + + sloyka.src.geocoder.city_objects_extractor - sloyka 0.2.1 documentation - - + + @@ -88,19 +88,6 @@ - - Auto light/dark mode - - - - - - - - - - Auto light/dark, in light mode - @@ -179,7 +166,7 @@
    -
    sloyka 0.1.0 documentation
     +
    sloyka 0.2.1 documentation
    @@ -206,7 +193,7 @@
    - sloyka 0.1.0 documentation + sloyka 0.2.1 documentation @@ -290,7 +277,6 @@

    Source code for sloyka.src.geocoder.city_objects_extractor

    from typing import List import re import pandas as pd -import osmnx as ox from shapely.geometry import Point, Polygon, MultiPolygon from loguru import logger import pymorphy2 @@ -411,20 +397,23 @@

    Source code for sloyka.src.geocoder.city_objects_extractor

    @staticmethod def restoration_of_normal_form(other_geo_obj, osm_combined_df, threshold=0.7) -> List[str]: """ - This function compares the extracted location entity with an OSM array and returns a normalized form if the percentage of similarity is at least 70%. + This function compares the extracted location entity with an OSM array + and returns a normalized form if the percentage of similarity is at least 70%. """ osm_name_obj = osm_combined_df["name"].tolist() similarity_matrix = np.zeros((len(other_geo_obj), len(osm_name_obj))) def extract_numbers(s): return re.findall(r"\d+", s) + + percents = 100 for i, word1 in enumerate(other_geo_obj): numbers_from_extraction = extract_numbers(word1) for j, word2 in enumerate(osm_name_obj): numbers_from_OSM_name = extract_numbers(word2) if numbers_from_extraction == numbers_from_OSM_name: - similarity = fuzz.ratio(word1, word2) / 100.0 + similarity = fuzz.ratio(word1, word2) / percents else: similarity = 0 similarity_matrix[i, j] = similarity @@ -440,10 +429,13 @@

    Source code for sloyka.src.geocoder.city_objects_extractor

    return restoration_list
    +
    +[docs] @staticmethod - def find_num_city_obj(text, NUM_CITY_OBJ) -> List[str]: + def find_num_city_obj(text) -> List[str]: """ - This function searches for urban objects in the text, the names of which are represented as a number. For example, "school No. 6". + This function searches for urban objects in the text, + the names of which are represented as a number. For example, "school No. 6". """ text = str(text) text = text.lower() @@ -464,8 +456,11 @@

    Source code for sloyka.src.geocoder.city_objects_extractor

    else: num_obj_list_clear[key] = obj - return list(num_obj_list_clear.values()) + return list(num_obj_list_clear.values())
    + +
    +[docs] @staticmethod def combine_city_obj(df_obj) -> pd.DataFrame: """ @@ -473,8 +468,11 @@

    Source code for sloyka.src.geocoder.city_objects_extractor

    """ df_obj["other_geo_obj"] = df_obj["other_geo_obj"] + df_obj["other_geo_obj_num"] df_obj.drop(columns=["other_geo_obj_num"], inplace=True) - return df_obj + return df_obj
    + +
    +[docs] @staticmethod def expand_toponym(df_obj) -> pd.DataFrame: """ @@ -485,8 +483,11 @@

    Source code for sloyka.src.geocoder.city_objects_extractor

    lambda x: x if isinstance(x, list) and x else None ) expanded_df = expanded_df.explode("other_geo_obj").reset_index(drop=True) - return expanded_df + return expanded_df
    + +
    +[docs] @staticmethod def find_geometry(toponym, osm_combined_df) -> Point: """ @@ -498,8 +499,11 @@

    Source code for sloyka.src.geocoder.city_objects_extractor

    if not match.empty: return match.iloc[0, 1] else: - return None + return None
    + +
    +[docs] @staticmethod def find_geo_obj_tag(toponym, osm_combined_df) -> str: """ @@ -511,11 +515,15 @@

    Source code for sloyka.src.geocoder.city_objects_extractor

    if not match.empty: return match.iloc[0, -1] else: - return None + return None
    + +
    +[docs] @staticmethod def get_unique_part_types(df): - return df["other_geo_obj"].unique() + return df["other_geo_obj"].unique()
    +
    [docs] @@ -530,7 +538,7 @@

    Source code for sloyka.src.geocoder.city_objects_extractor

    df_obj["other_geo_obj"] = df_obj[text_column].apply(OtherGeoObjects.extract_geo_obj) df_obj["other_geo_obj_num"] = df_obj[text_column].apply( - lambda x: OtherGeoObjects.find_num_city_obj(x, NUM_CITY_OBJ) + lambda x: OtherGeoObjects.find_num_city_obj(x) ) df_obj = OtherGeoObjects.combine_city_obj(df_obj) @@ -583,9 +591,9 @@

    Source code for sloyka.src.geocoder.city_objects_extractor

    +
    - + \ No newline at end of file diff --git a/docs/build/html/_modules/sloyka/src/geocoder/geocoder.html b/docs/build/html/_modules/sloyka/src/geocoder/geocoder.html index 387b2ab..a39cebf 100644 --- a/docs/build/html/_modules/sloyka/src/geocoder/geocoder.html +++ b/docs/build/html/_modules/sloyka/src/geocoder/geocoder.html @@ -4,11 +4,11 @@ - - sloyka.src.geocoder.geocoder - sloyka 0.1.0 documentation + + sloyka.src.geocoder.geocoder - sloyka 0.2.1 documentation - - + + @@ -88,19 +88,6 @@ - - Auto light/dark mode - - - - - - - - - - Auto light/dark, in light mode - @@ -179,7 +166,7 @@
    -
    sloyka 0.1.0 documentation
     +
    sloyka 0.2.1 documentation
    @@ -206,7 +193,7 @@
    - sloyka 0.1.0 documentation + sloyka 0.2.1 documentation @@ -214,15 +201,21 @@
    -

    About:

    +

    General:

    Receiving:

    @@ -287,26 +281,26 @@

    Source code for sloyka.src.geocoder.geocoder

    location in the text. 
 
 @class:Location:
-A class aimed to efficiently geocode addresses using Nominatim. Geocoded addresses are stored in the 'book' dictionary argument. 
+A class aimed to efficiently geocode addresses using Nominatim. 
+Geocoded addresses are stored in the 'book' dictionary argument. 
 Thus, if the address repeats, it would be taken from the book.
 
 @class:Streets: 
 A class encapsulating functionality for retrieving street data
-for a specified city from OSM and processing it to extract useful information for geocoding purposes.
+for a specified city from OSM and processing it to extract useful information
+for geocoding purposes.
 
 @class:Geocoder:
 A class providing functionality for simple geocoding and address extraction.
 """
-import numpy as np
+
 import re
-import warnings
-import os
 import flair
+from sloyka.src.utils.constants import GLOBAL_CRS
 import geopandas as gpd
 import pandas as pd
 import pymorphy2
 import torch
-import string
 import math
 from rapidfuzz import fuzz
 from nltk.stem.snowball import SnowballStemmer
@@ -321,49 +315,19 @@ 
    Source code for sloyka.src.geocoder.geocoder
    from flair.models import SequenceTagger
 from shapely.geometry import Point
 from tqdm import tqdm
-# from natasha import (
-#     Segmenter,
-#     MorphVocab,
-#     NewsEmbedding,
-#     NewsMorphTagger,
-#     NewsSyntaxParser,
-#     NewsNERTagger,
-#     Doc,
-# )
 
 from loguru import logger
 
 from pandarallel import pandarallel
-from sloyka.src.geocoder.city_objects_getter import OtherGeoObjects
+from sloyka.src.geocoder.city_objects_extractor import OtherGeoObjects
 from sloyka.src.utils.data_getter.street_getter import Streets
 from sloyka.src.utils.data_getter.location_getter import Location
 from sloyka.src.utils.data_getter.geo_data_getter import GeoDataGetter
+from sloyka.src.utils.data_preprocessing.preprocessor import PreprocessorInput
 from sloyka.src.geocoder.street_extractor import StreetExtractor
 from sloyka.src.geocoder.word_form_matcher import WordFormFinder
 
-import warnings
-
-warnings.simplefilter("ignore")
-warnings.filterwarnings("ignore", category=DeprecationWarning)
-
 pandarallel.initialize(progress_bar=True, nb_workers=-1)
-
-# segmenter = Segmenter()
-# morph_vocab = MorphVocab()
-morph = pymorphy2.MorphAnalyzer()
-
-# emb = NewsEmbedding()
-# morph_tagger = NewsMorphTagger(emb)
-# syntax_parser = NewsSyntaxParser(emb)
-# ner_tagger = NewsNERTagger(emb)
-warnings.simplefilter(action="ignore", category=FutureWarning)
-warnings.filterwarnings("ignore", category=DeprecationWarning)
-
-
-
-
-stemmer = SnowballStemmer("russian")
-
 tqdm.pandas()
 
 
@@ -374,17 +338,18 @@ 
    Source code for sloyka.src.geocoder.geocoder
        This class provides a functionality of simple geocoder
     """
 
-    dir_path = os.path.dirname(os.path.realpath(__file__))
-
-    global_crs: int = 4326
-
     def __init__(
         self,
+        df,
         model_path: str = "Geor111y/flair-ner-addresses-extractor",
         device: str = "cpu",
         osm_id: int = None,
-        city_tags: dict ={"place": ["state"]}
+        city_tags: dict ={"place": ["state"]},
+        stemmer_lang: str = "russian",
+        text_column_name:str = 'text'
     ):
+        self.text_column_name = text_column_name
+        self.df = PreprocessorInput().run(df, text_column_name)
         self.device = device
         flair.device = torch.device(device)
         self.classifier = SequenceTagger.load(model_path)
@@ -395,8 +360,12 @@ 
    Source code for sloyka.src.geocoder.geocoder
    .iloc[0]["name"]
         )
         self.street_names = Streets.run(self.osm_id)
+        self.stemmer = SnowballStemmer(stemmer_lang)
+        
 
 
+
    
+[docs]
     @staticmethod
     def get_stem(street_names_df: pd.DataFrame) -> pd.DataFrame:
         """
@@ -412,9 +381,12 @@ 
    Source code for sloyka.src.geocoder.geocoder
    street_names_df[case] = street_names_df["street_name"].apply(
                 lambda x: morph.parse(x)[0].inflect({case}).word if morph.parse(x)[0].inflect({case}) else None
             )
-        return street_names_df
+        return street_names_df
    
 
 
+
+
    
+[docs]
     @staticmethod
     def get_level(row: pd.Series) -> str:
         """
@@ -430,9 +402,12 @@ 
    Source code for sloyka.src.geocoder.geocoder
    elif (not pd.isna(row["Street"])) and (row["Numbers"] != ""):
             return "house"
         else:
-            return "global"
+            return "global"
    
+
 
  
+
    
+[docs]
     def create_gdf(self, df: pd.DataFrame) -> gpd.GeoDataFrame:
         """
         Function simply creates gdf from the recognised geocoded geometries.
@@ -444,10 +419,13 @@ 
    Source code for sloyka.src.geocoder.geocoder
    df["geometry"] = df['Location'].apply(lambda x: Point(x.longitude, x.latitude))
         df["Location"] = df['Location'].apply(lambda x: x.address)
         df["Numbers"].astype(str)
-        gdf = gpd.GeoDataFrame(df, geometry="geometry", crs=Geocoder.global_crs)
+        gdf = gpd.GeoDataFrame(df, geometry="geometry", crs=GLOBAL_CRS)
+
+        return gdf
    
 
-        return gdf
 
+
    
+[docs]
     def set_global_repr_point(self, gdf: gpd.GeoDataFrame) -> gpd.GeoDataFrame:
         """
         This function set the centroid (actually, representative point) of the
@@ -462,8 +440,11 @@ 
    Source code for sloyka.src.geocoder.geocoder
    except AttributeError:
             pass
 
-        return gdf
+        return gdf
    
+
 
+
    
+[docs]
     def merge_to_initial_df(self, gdf: gpd.GeoDataFrame, initial_df: pd.DataFrame) -> gpd.GeoDataFrame:
         """
         This function merges geocoded df to the initial df in order to keep
@@ -486,15 +467,23 @@ 
    Source code for sloyka.src.geocoder.geocoder
    ],
             how="outer",
         )
-        gdf = gpd.GeoDataFrame(gdf, geometry="geometry", crs=Geocoder.global_crs)
+        gdf = gpd.GeoDataFrame(gdf, geometry="geometry", crs=GLOBAL_CRS)
+
+        return
    
 
-        return
 
+
    
+[docs]
     def assign_street(variable):
+        '''Simple workaround'''
+
         if isinstance(variable, float) and math.isnan(variable):
             return "street"
-        return variable
+        return variable
    
+
 
+
    
+[docs]
     def get_df_areas(self, osm_id, tags):
         """
         Retrieves the GeoDataFrame of areas corresponding to the given OSM ID and tags.
@@ -517,8 +506,11 @@ 
    Source code for sloyka.src.geocoder.geocoder
    df_areas = geo_data_getter.get_features_from_id(osm_id=osm_id, tags=tags)
             df_areas = df_areas[df_areas["element_type"] != "way"]
             area_cache[osm_id] = df_areas
-        return area_cache[osm_id]
+        return area_cache[osm_id]
    
+
 
+
    
+[docs]
     def preprocess_group_name(self, group_name):
         """
         Preprocesses a group name by converting it to lowercase, removing special characters, and removing specified stopwords.
@@ -534,8 +526,11 @@ 
    Source code for sloyka.src.geocoder.geocoder
    words_to_remove = GROUP_STOPWORDS
         for word in words_to_remove:
             group_name = re.sub(word, "", group_name, flags=re.IGNORECASE)
-        return group_name
+        return group_name
    
 
+
+
    
+[docs]
     def preprocess_area_names(self, df_areas):
         """
         Preprocesses the area names in the given DataFrame by removing specified stopwords, converting the names to lowercase,
@@ -558,10 +553,13 @@ 
    Source code for sloyka.src.geocoder.geocoder
    REGEX_PATTERN, REPLACEMENT_STRING, regex=True
         )
         df_areas["area_stems"] = df_areas["area_name_processed"].apply(
-            lambda x: [stemmer.stem(word) for word in x.split()]
+            lambda x: [self.stemmer.stem(word) for word in x.split()]
         )
-        return df_areas
+        return df_areas
    
+
 
+
    
+[docs]
     def match_group_to_area(self, group_name, df_areas):
         """
         Matches a given group name to an area in a DataFrame of areas.
@@ -574,7 +572,7 @@ 
    Source code for sloyka.src.geocoder.geocoder
                tuple: A tuple containing the best match for the group name and the admin level of the match.
                    If no match is found, returns (None, None).
         """
-        group_name_stems = [stemmer.stem(word) for word in group_name.split()]
+        group_name_stems = [self.stemmer.stem(word) for word in group_name.split()]
         max_partial_ratio = 20
         max_token_sort_ratio = 20
         best_match = None
@@ -592,12 +590,14 @@ 
    Source code for sloyka.src.geocoder.geocoder
    best_match = row["area_name"]
                 admin_level = row["key"]
 
-        return best_match, admin_level
+        return best_match, admin_level
    
+
 
 
    
 [docs]
     def run(
-        self, df: pd.DataFrame, tags:dict|None=None, text_column: str = "text", group_column: str | None = "group_name", search_for_objects=False
+        self, df: pd.DataFrame = None, tags:dict|None=None, 
+        group_column: str | None = "group_name", search_for_objects=False
     ):
         """
         Runs the data processing pipeline on the input DataFrame.
@@ -617,8 +617,14 @@ 
    Source code for sloyka.src.geocoder.geocoder
            objects and street names, preprocesses the street names, finds the word form, creates a GeoDataFrame,
         merges it with the other geographic objects, assigns the street tag, and returns the final GeoDataFrame.
         """
+        df = self.df
+        initial_df = df.copy()
+        text_column = self.text_column_name
+
+        if search_for_objects:
+            df_obj = OtherGeoObjects.run(self.osm_id, df, text_column)
+            
 
-        # initial_df = df.copy()
         if tags:
             df_areas = self.get_df_areas(self.osm_id, tags)
             df_areas = self.preprocess_area_names(df_areas)
@@ -630,10 +636,8 @@ 
    Source code for sloyka.src.geocoder.geocoder
    df.at[i, "territory"] = best_match
                     df.at[i, "key"] = admin_level
             del df_areas
-        # df = AreaMatcher.run(self, df, osm_id, tags, date)
 
         df[text_column] = df[text_column].astype(str).str.replace('\n', ' ')
-        df_reconstruction = df.copy()
         df[text_column] = df[text_column].apply(str)
         
 
@@ -644,250 +648,19 @@ 
    Source code for sloyka.src.geocoder.geocoder
    del street_names
         gdf = self.create_gdf(df)
-        del df
 
         if search_for_objects:
-            df_obj = OtherGeoObjects.run(self.osm_id, df, text_column)
             gdf = pd.concat([gdf, df_obj], ignore_index=True)
             del df_obj
             gdf["geo_obj_tag"] = gdf["geo_obj_tag"].apply(Geocoder.assign_street)
 
-        gdf = pd.concat(
-            [gdf, df_reconstruction[~df_reconstruction[text_column].isin(gdf[text_column])]], ignore_index=True
-        )
-
-        # gdf2 = self.merge_to_initial_df(gdf, initial_df)
+        gdf = pd.merge(gdf, initial_df, on=text_column, how='right')
 
-        # # Add a new 'level' column using the get_level function
-        # gdf2["level"] = gdf2.progress_apply(self.get_level, axis=1)
-        # gdf2 = self.set_global_repr_point(gdf2)
-        gdf.set_crs(4326, inplace=True)
+        gdf.set_crs(GLOBAL_CRS, inplace=True)
         return gdf
    
 
    
 
     
-
-    # def extract_ner_street(self, text: str) -> pd.Series:
-    #     """
-    #     Function calls the pre-trained custom NER model to extract mentioned
-    #     addresses from the texts (usually comment) in social networks in
-    #     russian language.
-    #     The model scores 0.8 in F1 and other metrics.
-    #     """
-
-    #     try:
-    #         text = re.sub(r"\[.*?\]", "", text)
-    #     except Exception:
-    #         return pd.Series([None, None])
-
-    #     sentence = Sentence(text)
-    #     self.classifier.predict(sentence)
-    #     try:
-    #         res = sentence.get_labels("ner")[0].labeled_identifier.split("]: ")[1].split("/")[0].replace('"', "")
-    #         score = round(sentence.get_labels("ner")[0].score, 3)
-    #         if score > 0.7:
-    #             return pd.Series([res, score])
-    #         else:
-    #             return pd.Series([None, None])
-
-    #     except IndexError:
-    #         return pd.Series([None, None])
-
-    # @staticmethod
-    # def extract_building_num(text, street_name, number) -> string:
-    #     """
-    #     The function finds the already extracted street name in the text
-    #     and searches for numbers related to building numbers in a certain range of indexes
-    #     around the street name.
-    #     """
-    #     if pd.notna(number) and number != "":
-    #         return number
-    #     if isinstance(text, float) and math.isnan(text):
-    #         return ""
-
-    #     clear_text = str(text).translate(str.maketrans("", "", string.punctuation))
-    #     clear_text = clear_text.lower().split(" ")
-    #     positions = [index for index, item in enumerate(clear_text) if item == street_name]
-
-    #     if not positions:
-    #         return ""
-
-    #     position = positions[0]
-    #     search_start = max(0, position)
-    #     search_end = min(len(clear_text), position + END_INDEX_POSITION)
-
-    #     num_result = []
-
-    #     for f_index in range(max(0, search_start), min(len(clear_text), search_end)):
-    #         element = clear_text[f_index]
-    #         if any(character.isdigit() for character in str(element)) and len(str(element)) <= 3:
-    #             num_result.append(element)
-    #             break
-
-    #     if num_result:
-    #         return num_result[0]
-    #     else:
-    #         return ""
-
-    # @staticmethod
-    # def extract_toponym(text, street_name) -> string:
-    #     """
-    #     The function finds the already extracted street name in the text
-    #     and searches for words related to toponyms in a certain range of indexes
-    #     around the street name.
-    #     """
-    #     if isinstance(text, float) and math.isnan(text):
-    #         return None
-
-    #     clear_text = str(text).translate(str.maketrans("", "", string.punctuation))
-    #     clear_text = clear_text.lower().split(" ")
-    #     positions = [index for index, item in enumerate(clear_text) if item == street_name]
-
-    #     if not positions:
-    #         return None
-
-    #     position = positions[0]
-    #     search_start = max(0, position - int(START_INDEX_POSITION))
-    #     search_end = min(len(clear_text), position + int(END_INDEX_POSITION))
-
-    #     ad_result = []
-    #     for i in range(search_start, min(search_end + 1, len(clear_text))):
-    #         word = clear_text[i]
-    #         normal_form = morph.parse(word)[0].normal_form
-    #         if normal_form in TARGET_TOPONYMS:
-    #             ad_result.append(REPLACEMENT_DICT.get(normal_form, normal_form))
-
-    #     if ad_result:
-    #         return ad_result[0]
-    #     else:
-    #         return None
-
-       # def get_street(self, df: pd.DataFrame, text_column: str) -> gpd.GeoDataFrame:
-    #     """
-    #     Function calls NER model and post-process result in order to extract
-    #     the address mentioned in the text.
-    #     """
-    #     logger.info("get_street started")
-
-    #     df[text_column].dropna(inplace=True)
-    #     df[text_column] = df[text_column].astype(str)
-
-    #     logger.info("extract_ner_street started")
-
-    #     df[["Street", "Score"]] = df[text_column].progress_apply(lambda t: self.extract_ner_street(t))
-    #     df["Street"] = df[[text_column, "Street"]].progress_apply(
-    #         lambda row: Geocoder.get_ner_address_natasha(row, text_column),
-    #         axis=1,
-    #     )
-
-    #     df = df[df.Street.notna()]
-    #     df = df[df["Street"].str.contains("[а-яА-Я]")]
-
-    #     logger.info("pattern1.sub started")
-
-    #     pattern1 = re.compile(r"(\D)(\d)(\D)")
-    #     df["Street"] = df["Street"].progress_apply(lambda x: pattern1.sub(r"\1 \2\3", x))
-
-    #     logger.info("pattern2.findall started")
-
-    #     pattern2 = re.compile(r"\d+")
-    #     df["Numbers"] = df["Street"].progress_apply(lambda x: " ".join(pattern2.findall(x)))
-
-    #     logger.info("pattern2.sub started")
-
-    #     df["Street"] = df["Street"].progress_apply(lambda x: pattern2.sub("", x).strip())
-
-    #     df["initial_street"] = df["Street"].copy()
-
-    #     df["Street"] = df["Street"].str.lower()
-
-    #     logger.info("extract_building_num started")
-
-    #     df["Numbers"] = df.progress_apply(
-    #         lambda row: Geocoder.extract_building_num(row[text_column], row["Street"], row["Numbers"]),
-    #         axis=1,
-    #     )
-
-    #     logger.info("extract_toponym started")
-
-    #     df["Toponims"] = df.progress_apply(
-    #         lambda row: Geocoder.extract_toponym(row[text_column], row["Street"]),
-    #         axis=1,
-    #     )
-    #     return df
-
-    # df = pd.DataFrame(data={'text': 'На биржевой 14 что-то произошло'}, index=[0])
-    # print(Geocoder().run(df=df, text_column='text'))
-
-
-    # def find_word_form(self, df: pd.DataFrame, strts_df: pd.DataFrame) -> pd.DataFrame:
-    #     """
-    #     In Russian language any word has different forms.
-    #     Since addresses are extracted from the texts in social networks,
-    #     they might be in any possible form. This function is aimed to match that
-    #     free form to the one that is used in the OSM database.
-
-    #     Since the stem is found there would be several streets with that stem
-    #     in their name.
-    #     However, the searching street name has its specific ending (form) and
-    #     not each matched street name could have it.
-    #     """
-
-    #     df["full_street_name"] = None
-
-    #     for idx, row in df.iterrows():
-    #         search_val = row["Street"]
-    #         search_top = row["Toponims"]
-    #         val_num = row["Numbers"]
-
-    #         for col in strts_df.columns[2:]:
-    #             search_rows = strts_df.loc[strts_df[col] == search_val]
-    #             matching_rows = search_rows[search_rows["toponim_name"] == search_top]
-
-    #             if not matching_rows.empty:
-    #                 only_streets_full = matching_rows["street"].values
-    #                 streets_full = [
-    #                     street + f" {val_num}" + f" {self.osm_city_name}" + " Россия" for street in only_streets_full
-    #                 ]
-
-    #                 df.loc[idx, "full_street_name"] = ",".join(streets_full)
-    #                 df.loc[idx, "only_full_street_name"] = ",".join(only_streets_full)
-
-    #             else:
-    #                 if search_val in strts_df[col].values:
-    #                     only_streets_full = strts_df.loc[strts_df[col] == search_val, "street"].values
-    #                     streets_full = [
-    #                         street + f" {val_num}" + f" {self.osm_city_name}" + " Россия"
-    #                         for street in only_streets_full
-    #                     ]
-
-    #                     df.loc[idx, "full_street_name"] = ",".join(streets_full)
-    #                     df.loc[idx, "only_full_street_name"] = ",".join(only_streets_full)
-
-    #     df.dropna(subset=["full_street_name", "only_full_street_name"], inplace=True)
-    #     df["location_options"] = df["full_street_name"].str.split(",")
-    #     df["only_full_street_name"] = df["only_full_street_name"].str.split(",")
-
-    #     tmp_df_1 = df["location_options"].explode()
-    #     tmp_df_1.name = "addr_to_geocode"
-    #     tmp_df_2 = df["only_full_street_name"].explode()
-    #     tmp_df_2.name = "only_full_street_name"
-    #     new_df = tmp_df_1.to_frame().join(tmp_df_2.to_frame())
-
-    #     df.drop(columns=["only_full_street_name"], inplace=True)
-    #     df = df.merge(new_df, left_on=df.index, right_on=new_df.index)
-    #     df.drop(columns=["key_0"], inplace=True)
-
-    #     # new_df = df["only_full_street_name"].explode()
-    #     # new_df.name = "only_full_street_name"
-    #     # df.drop(columns=['key_0', 'only_full_street_name'], inplace=True)
-    #     # df = df.merge(new_df, left_on=df.index, right_on=new_df.index)
-
-    #     # print(df.head())
-    #     df["only_full_street_name"] = df["only_full_street_name"].astype(str)
-    #     df["location_options"] = df["location_options"].astype(str)
-
-    #     return df
 
    
         
       
    
@@ -919,9 +692,9 @@ 
    Source code for sloyka.src.geocoder.geocoder
       
    
-
    
+
    
     
     
-    
+    
     
 
\ No newline at end of file
diff --git a/docs/build/html/_modules/sloyka/src/geocoder/street_extractor.html b/docs/build/html/_modules/sloyka/src/geocoder/street_extractor.html
index ecea240..94c6819 100644
--- a/docs/build/html/_modules/sloyka/src/geocoder/street_extractor.html
+++ b/docs/build/html/_modules/sloyka/src/geocoder/street_extractor.html
@@ -4,11 +4,11 @@
     
     
 
-    
-        sloyka.src.geocoder.street_extractor - sloyka 0.1.0 documentation
+    
+        sloyka.src.geocoder.street_extractor - sloyka 0.2.1 documentation
       
-    
-    
+    
+    
     
     
     
@@ -88,19 +88,6 @@
       
     
   
-  
-    Auto light/dark mode
-    
-      
-      
-      
-      
-      
-      
-      
-    
-  
   
     Auto light/dark, in light mode
     
       
       
-      
     
   
   
@@ -179,7 +166,7 @@
       
     
    
     
    
-      
    sloyka 0.1.0 documentation
    
+      
    sloyka 0.2.1 documentation
    
     
    
     
    
       
    
@@ -206,7 +193,7 @@
     
   
    
   
-  sloyka 0.1.0 documentation
+  sloyka 0.2.1 documentation
   
 
 
    
-  
    About:
    
+  
    General:
    
 
 
    Receiving:
    
 
    
@@ -331,7 +325,7 @@ 
    Source code for sloyka.src.geocoder.street_extractor
    texts = StreetExtractor._preprocess_text_column(local_df, text_column)
         extracted_streets = StreetExtractor._extract_streets(texts, classifier)
         refined_streets = StreetExtractor._refine_street_data(extracted_streets)
-        building_numbers = StreetExtractor._extract_building_numbers(texts, refined_streets)
+        building_numbers = StreetExtractor._get_number(texts, refined_streets)
         toponyms = StreetExtractor._extract_toponyms(texts, refined_streets)
 
         # Combine results into a DataFrame
@@ -417,6 +411,7 @@ 
    Source code for sloyka.src.geocoder.street_extractor
    refined_streets.append(None)
             else:
                 refined_streets.append(None)
+                
         return refined_streets
 
     @staticmethod
@@ -432,14 +427,14 @@ 
    Source code for sloyka.src.geocoder.street_extractor
            """
         try:
             street = re.sub(r"(\D)(\d)(\D)", r"\1 \2\3", street)
-            street = re.sub(r"\d+", "", street).strip().lower()
+            street = re.sub(r"\d+|-| ", "", street).strip().lower()
             return street
         except Exception as e:
             logger.warning(f"Error in _refine_street_name with street '{street}': {e}")
             return ""
 
     @staticmethod
-    def _extract_building_numbers(texts: List[str], streets: List[Optional[str]]) -> List[Optional[str]]:
+    def _get_number(texts: List[str], streets: List[Optional[str]]) -> List[Optional[str]]:
         """
         Extract building numbers from the text data.
 
@@ -454,7 +449,7 @@ 
    Source code for sloyka.src.geocoder.street_extractor
    for text, street in zip(texts, streets):
             if street:
                 try:
-                    building_numbers.append(StreetExtractor._extract_building_number(text, street))
+                    building_numbers.append(StreetExtractor._extract_building_number_from_text(text, street))
                 except Exception as e:
                     logger.warning(f"Error extracting building number from text '{text}' with street '{street}': {e}")
                     building_numbers.append(None)
@@ -463,7 +458,7 @@ 
    Source code for sloyka.src.geocoder.street_extractor
    return building_numbers
 
     @staticmethod
-    def _extract_building_number(text: str, street: str) -> str:
+    def _extract_building_number_from_text(text: str, street: str) -> str:
         """
         Extract building number from the text.
 
@@ -476,9 +471,9 @@ 
    Source code for sloyka.src.geocoder.street_extractor
            """
         try:
             numbers = " ".join(re.findall(r"\d+", text))
-            return StreetExtractor.extract_building_num(text, street, numbers)
+            return StreetExtractor._check_if_extracted_number_legit(text, street, numbers)
         except Exception as e:
-            logger.warning(f"Error in _extract_building_number with text '{text}' and street '{street}': {e}")
+            logger.warning(f"Error in _extract_building_number_from_text with text '{text}' and street '{street}': {e}")
             return ""
 
     @staticmethod
@@ -546,32 +541,32 @@ 
    Source code for sloyka.src.geocoder.street_extractor
    return None
    
 
 
-    @staticmethod
-    def _clean_text(text: str) -> str:
-        """
-        Clean the input text by removing punctuation and converting to lowercase.
+    # @staticmethod
+    # def _clean_text(text: str) -> str:
+    #     """
+    #     Clean the input text by removing punctuation and converting to lowercase.
 
-        Args:
-            text (str): The input text.
+    #     Args:
+    #         text (str): The input text.
 
-        Returns:
-            str: The cleaned text.
-        """
-        return text.translate(str.maketrans("", "", string.punctuation)).lower()
+    #     Returns:
+    #         str: The cleaned text.
+    #     """
+    #     return text.translate(str.maketrans("", "", string.punctuation)).lower()
 
-    @staticmethod
-    def _find_street_name_positions(words: List[str], street_name: str) -> List[int]:
-        """
-        Find positions of the street name in the list of words.
+    # @staticmethod
+    # def _find_street_name_positions(words: List[str], street_name: str) -> List[int]:
+    #     """
+    #     Find positions of the street name in the list of words.
 
-        Args:
-            words (List[str]): List of words from the cleaned text.
-            street_name (str): The name of the street to find.
+    #     Args:
+    #         words (List[str]): List of words from the cleaned text.
+    #         street_name (str): The name of the street to find.
 
-        Returns:
-            List[int]: List of positions where the street name occurs.
-        """
-        return [index for index, word in enumerate(words) if word == street_name]
+    #     Returns:
+    #         List[int]: List of positions where the street name occurs.
+    #     """
+    #     return [index for index, word in enumerate(words) if word == street_name]
 
     @staticmethod
     def _search_toponyms(words: List[str], position: int) -> Optional[str]:
@@ -589,22 +584,21 @@ 
    Source code for sloyka.src.geocoder.street_extractor
    search_end = min(len(words), position + END_INDEX_POSITION)
 
         for i in range(search_start, search_end + 1):
-            word = words[i]
+            
             try:
+                word = words[i]
                 normal_form = morph.parse(word)[0].normal_form
+            
+                if normal_form in TARGET_TOPONYMS:
+                    return REPLACEMENT_DICT.get(normal_form, normal_form)
+            
             except Exception as e:
                 logger.warning(f"Error parsing word '{word}': {e}")
                 continue
-
-            if normal_form in TARGET_TOPONYMS:
-                return REPLACEMENT_DICT.get(normal_form, normal_form)
-
         return None
 
-
    
-[docs]
     @staticmethod
-    def extract_building_num(text: str, street_name: str, number: Optional[str]) -> str:
+    def _check_if_extracted_number_legit(text: str, street_name: str, number: Optional[str]) -> str:
         """
         Extract building numbers near the specified street name in the text.
 
@@ -620,9 +614,6 @@ 
    Source code for sloyka.src.geocoder.street_extractor
                str: The first building number found if present, otherwise an empty string.
         """
         try:
-            if pd.notna(number) and number != "":
-                return number
-
             if isinstance(text, float) and math.isnan(text):
                 return ""
 
@@ -638,8 +629,7 @@ 
    Source code for sloyka.src.geocoder.street_extractor
    except Exception as e:
             logger.warning(f"Error in extract_building_num with text '{text}', street_name '{street_name}', number '{number}': {e}")
-            return ""
    
-
+            return ""
 
 
     @staticmethod
@@ -654,7 +644,7 @@ 
    Source code for sloyka.src.geocoder.street_extractor
            Returns:
             List[int]: List of positions where the street name occurs.
         """
-        return [index for index, word in enumerate(words) if word == street_name]
+        return [index for index, word in enumerate(words) if word.lower() == street_name]
 
     @staticmethod
     def _search_building_number(words: List[str], position: int) -> str:
@@ -821,9 +811,9 @@ 
    Source code for sloyka.src.geocoder.street_extractor
    
+
    
     
     
-    
+    
     
 
\ No newline at end of file
diff --git a/docs/build/html/_modules/sloyka/src/risks/emotion_classifier.html b/docs/build/html/_modules/sloyka/src/risks/emotion_classifier.html
index fa61e2b..cba2229 100644
--- a/docs/build/html/_modules/sloyka/src/risks/emotion_classifier.html
+++ b/docs/build/html/_modules/sloyka/src/risks/emotion_classifier.html
@@ -4,11 +4,11 @@
     
     
 
-    
-        sloyka.src.risks.emotion_classifier - sloyka 0.1.0 documentation
+    
+        sloyka.src.risks.emotion_classifier - sloyka 0.2.1 documentation
       
-    
-    
+    
+    
     
     
     
@@ -88,19 +88,6 @@
       
     
   
-  
-    Auto light/dark mode
-    
-      
-      
-      
-      
-      
-      
-      
-    
-  
   
     Auto light/dark, in light mode
     
       
       
-      
     
   
   
@@ -179,7 +166,7 @@
       
     
    
     
    
-      
    sloyka 0.1.0 documentation
    
+      
    sloyka 0.2.1 documentation
    
     
    
     
    
       
    
@@ -206,7 +193,7 @@
     
   
    
   
-  sloyka 0.1.0 documentation
+  sloyka 0.2.1 documentation
   
 
 
    
-  
    About:
    
+  
    General:
    
 
 
    Receiving:
    
 
    
@@ -318,8 +312,8 @@ 
    Source code for sloyka.src.risks.emotion_classifier
        - text_column: The name of the column containing the text to be analyzed.
     """
 
-    def __init__(self, model_name=HuggingFaceModel.Text.Bert_Large, device=None):
-        self.device = device if device is not None else ("cuda" if torch.cuda.is_available() else "cpu")
+    def __init__(self, model_name=HuggingFaceModel.Text.Bert_Tiny, device='cpu'):
+        self.device = device
         self.model_name = model_name
 
         # Define the default model names to avoid repeated initialization
@@ -330,14 +324,19 @@ 
    Source code for sloyka.src.risks.emotion_classifier
    HuggingFaceModel.Text.Bert_Tiny2,
         ]
 
+        self.recognizer = TextRecognizer(model=self.model_name, device=self.device)
+
+    #def init_base_recognizer(self):
+    #    self.recognizer = TextRecognizer(model=self.model_name, device=self.device)
+
+
 
    
 [docs]
     def recognize_emotion(self, text):
         """
         Return the emotion for a given text.
         """
-        recognizer = TextRecognizer(model=self.model_name, device=self.device)
-        emotion = recognizer.recognize(text, return_single_label=True)
+        emotion = self.recognizer.recognize(text, return_single_label=True)
         return emotion
    
 
 
@@ -431,9 +430,9 @@ 
    Source code for sloyka.src.risks.emotion_classifier
    
+
    
     
     
-    
+    
     
 
\ No newline at end of file
diff --git a/docs/build/html/_modules/sloyka/src/risks/event_detector.html b/docs/build/html/_modules/sloyka/src/risks/event_detector.html
index eadb556..47e2beb 100644
--- a/docs/build/html/_modules/sloyka/src/risks/event_detector.html
+++ b/docs/build/html/_modules/sloyka/src/risks/event_detector.html
@@ -4,11 +4,11 @@
     
     
 
-    
-        sloyka.src.risks.event_detector - sloyka 0.1.0 documentation
+    
+        sloyka.src.risks.event_detector - sloyka 0.2.1 documentation
       
-    
-    
+    
+    
     
     
     
@@ -88,19 +88,6 @@
       
     
   
-  
-    Auto light/dark mode
-    
-      
-      
-      
-      
-      
-      
-      
-    
-  
   
     Auto light/dark, in light mode
     
       
       
-      
     
   
   
@@ -179,7 +166,7 @@
       
     
    
     
    
-      
    sloyka 0.1.0 documentation
    
+      
    sloyka 0.2.1 documentation
    
     
    
     
    
       
    
@@ -206,7 +193,7 @@
     
   
    
   
-  sloyka 0.1.0 documentation
+  sloyka 0.2.1 documentation
   
 
 
    
-  
    About:
    
+  
    General:
    
 
 
    Receiving:
    
 
    
@@ -298,6 +292,7 @@ 
    Source code for sloyka.src.risks.event_detector
    <
 @method:_preprocess:
 Preprocess the data.
 """
+
 import re
 from itertools import chain, combinations
 
@@ -816,9 +811,9 @@ 
    Source code for sloyka.src.risks.event_detector
    <
       
     
   
    
-
    
+
    
     
     
-    
+    
     
 
\ No newline at end of file
diff --git a/docs/build/html/_modules/sloyka/src/risks/text_classifier.html b/docs/build/html/_modules/sloyka/src/risks/text_classifier.html
index 3d725fc..38ef820 100644
--- a/docs/build/html/_modules/sloyka/src/risks/text_classifier.html
+++ b/docs/build/html/_modules/sloyka/src/risks/text_classifier.html
@@ -4,11 +4,11 @@
     
     
 
-    
-        sloyka.src.risks.text_classifier - sloyka 0.1.0 documentation
+    
+        sloyka.src.risks.text_classifier - sloyka 0.2.1 documentation
       
-    
-    
+    
+    
     
     
     
@@ -88,19 +88,6 @@
       
     
   
-  
-    Auto light/dark mode
-    
-      
-      
-      
-      
-      
-      
-      
-    
-  
   
     Auto light/dark, in light mode
     
       
       
-      
     
   
   
@@ -179,7 +166,7 @@
       
     
    
     
    
-      
    sloyka 0.1.0 documentation
    
+      
    sloyka 0.2.1 documentation
    
     
    
     
    
       
    
@@ -206,7 +193,7 @@
     
   
    
   
-  sloyka 0.1.0 documentation
+  sloyka 0.2.1 documentation
   
 
 
    
-  
    About:
    
+  
    General:
    
 
 
    Receiving:
    
 
    
@@ -301,6 +295,7 @@ 
    Source code for sloyka.src.risks.text_classifier
    
 @method:run_text_classifier: 
  Takes a text as input and returns the predicted categories and probabilities.
 """
+
 import pandas as pd
 from transformers import pipeline
 from sloyka.src.utils.exceptions import InvalidInputError, ClassifierInitializationError, ClassificationError
@@ -392,9 +387,9 @@ 
    Source code for sloyka.src.risks.text_classifier
    
       
     
   
    
-
    
+
    
     
     
-    
+    
     
 
\ No newline at end of file
diff --git a/docs/build/html/_modules/sloyka/src/semantic_graph/semantic_graph_builder.html b/docs/build/html/_modules/sloyka/src/semantic_graph/semantic_graph_builder.html
index debfb18..92625b4 100644
--- a/docs/build/html/_modules/sloyka/src/semantic_graph/semantic_graph_builder.html
+++ b/docs/build/html/_modules/sloyka/src/semantic_graph/semantic_graph_builder.html
@@ -4,11 +4,11 @@
     
     
 
-    
-        sloyka.src.semantic_graph.semantic_graph_builder - sloyka 0.1.0 documentation
+    
+        sloyka.src.semantic_graph.semantic_graph_builder - sloyka 0.2.1 documentation
       
-    
-    
+    
+    
     
     
     
@@ -88,19 +88,6 @@
       
     
   
-  
-    Auto light/dark mode
-    
-      
-      
-      
-      
-      
-      
-      
-    
-  
   
     Auto light/dark, in light mode
     
       
       
-      
     
   
   
@@ -179,7 +166,7 @@
       
     
    
     
    
-      
    sloyka 0.1.0 documentation
    
+      
    sloyka 0.2.1 documentation
    
     
    
     
    
       
    
@@ -206,7 +193,7 @@
     
   
    
   
-  sloyka 0.1.0 documentation
+  sloyka 0.2.1 documentation
   
 
 
    
-  
    About:
    
+  
    General:
    
 
 
    Receiving:
    
 
    
@@ -320,7 +313,7 @@ 
    Source code for sloyka.src.semantic_graph.semantic_graph_builder
    clean_from_links,
 )
 
-nltk.download("stopwords")
+
 
 
 from sloyka.src.utils.constants import TAG_ROUTER
@@ -349,6 +342,7 @@ 
    Source code for sloyka.src.semantic_graph.semantic_graph_builder
    self.model_name = bert_name
         self.model = BertModel.from_pretrained(bert_name).to(device)
 
+
 
    
 [docs]
     @staticmethod
@@ -425,6 +419,7 @@ 
    Source code for sloyka.src.semantic_graph.semantic_graph_builder
    data = clean_from_links(data, text_column)
 
         extracted = extract_keywords(
+            self,
             data,
             text_column,
             text_type_column,
@@ -442,7 +437,7 @@ 
    Source code for sloyka.src.semantic_graph.semantic_graph_builder
    preprocessed_df = self.convert_df_to_edge_df(data=df, toponym_column=toponym_column)
 
-        words_df = get_semantic_closeness(preprocessed_df, "TO", semantic_score_filter)
+        words_df = get_semantic_closeness(self, preprocessed_df, "TO", semantic_score_filter)
 
         graph_df = pd.concat([preprocessed_df, words_df], ignore_index=True)
         if directed:
@@ -551,46 +546,6 @@ 
    Source code for sloyka.src.semantic_graph.semantic_graph_builder
    return joined_G
    
 
    
 
-
-
-# debugging
-# if __name__ == '__main__':
-#     file = open("C:\\Users\\thebe\\Downloads\\test.geojson", encoding='utf-8')
-#     test_gdf = gpd.read_file(file)
-#
-#     sm = Semgraph()
-#
-#     G = sm.build_graph(test_gdf[:3000],
-#                        id_column='id',
-#                        text_column='text',
-#                        text_type_column='type',
-#                        toponym_column='only_full_street_name_numbers',
-#                        toponym_name_column='initial_street',
-#                        toponym_type_column='Toponims',
-#                        post_id_column='post_id',
-#                        parents_stack_column='parents_stack',
-#                        location_column='Location',
-#                        geometry_column='geometry')
-#
-#     # print(len(G.nodes))
-#     #
-#     # G = sm.update_graph(G,
-#     #                     test_gdf[3000:],
-#     #                     id_column='id',
-#     #                     text_column='text',
-#     #                     text_type_column='type',
-#     #                     toponym_column='only_full_street_name',
-#     #                     toponym_name_column='initial_street',
-#     #                     toponym_type_column='Toponims',
-#     #                     post_id_column='post_id',
-#     #                     parents_stack_column='parents_stack',
-#     #                     counts_attribute='counts',
-#     #                     location_column='Location',
-#     #                     geometry_column='geometry')
-#     #
-#     # print(len(G.nodes))
-#     #
-#     # nx.write_graphml(G, 'name.graphml', encoding='utf-8')
 
    
         
       
    
@@ -622,9 +577,9 @@ 
    Source code for sloyka.src.semantic_graph.semantic_graph_builder
    
   
    
-
    
+
    - + \ No newline at end of file diff --git a/docs/build/html/_modules/sloyka/src/utils/data_getter/geo_data_getter.html b/docs/build/html/_modules/sloyka/src/utils/data_getter/geo_data_getter.html new file mode 100644 index 0000000..512a5d7 --- /dev/null +++ b/docs/build/html/_modules/sloyka/src/utils/data_getter/geo_data_getter.html @@ -0,0 +1,485 @@ + + + + + + + + sloyka.src.utils.data_getter.geo_data_getter - sloyka 0.2.1 documentation + + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark, in light mode + + + + + + + + + + + + + + + Auto light/dark, in dark mode + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    + +
    +
    +
    sloyka 0.2.1 documentation
     +
    +
    +
    + +
    + +
    +
    + +
    +
    +
    + + + + + Back to top + +
    +
    + +
    + +
    +
    +

    Source code for sloyka.src.utils.data_getter.geo_data_getter

    +import warnings
+warnings.filterwarnings("ignore")
+
+from contextlib import suppress
+import osmnx as ox
+import geopandas as gpd
+import pandas as pd
+from sloyka.src.utils.constants import (
+    GLOBAL_CRS,
+    GLOBAL_METRIC_CRS,
+)
+from tqdm import tqdm
+import requests
+import osm2geojson
+import networkx as nx
+from loguru import logger
+
+from sloyka.src.utils.exceptions import *
+
+
    
+[docs]
+class GeoDataGetter:
+    """
+    This class is used to retrieve geospatial data from OpenStreetMap (OSM) based on given OSM ID and tags.
+
+    Methods:
+    - get_features_from_id: Retrieves features from the given OSM ID using the provided tags and OSM type, and returns the results as a GeoDataFrame.
+    - _get_place_from_id: Retrieves the place from the given OSM ID and OSM type.
+    - _process_tags: Processes the provided tags and returns a list of GeoDataFrames.
+    - _get_features_from_place: Retrieves features from a specific place based on category and tag.
+    - _handle_error: Handles any errors that occur during the process and prints an error message.
+    """
+
    
+[docs]
+    @staticmethod
+    def get_osm_data(osm_id: int, tags: dict) -> pd.DataFrame:
+        """
+        Retrieves spatial data from OSM for given tags using OSM ID and returns a DataFrame.
+        """
+        try:
+            osm_id_rel = f"R{osm_id}"
+            city_boundary_gdf = ox.geocode_to_gdf(osm_id_rel, by_osmid=True)
+            polygon = city_boundary_gdf["geometry"].iloc[0]
+            data = ox.features_from_polygon(polygon, tags)
+            df = pd.DataFrame(data)
+            df = df.dropna(subset=["name"])
+            df = df.loc[:, ["name", "geometry"] + list(tags.keys())]
+            return df
+        except Exception as e:
+            raise ConectionError(f"Error retrieving OSM data for {osm_id_rel}: {e}")
    
+
+
+
    
+[docs]
+    @staticmethod
+    def get_city_bounds(osm_id: int) -> gpd.GeoDataFrame:
+        """
+        Method retrieves the boundary of a specified city from OSM
+        using Overpass API and returns a GeoDataFrame representing
+        the boundary as a polygon.
+        """
+        # Streets.logger.info(f"Retrieving city bounds for osm_id {osm_id}")
+        overpass_url = "http://overpass-api.de/api/interpreter"
+        overpass_query = f"""
+        [out:json];
+            (
+            relation({osm_id});
+            );
+            out geom;
+            """
+
+        try:
+            result = requests.get(overpass_url, params={"data": overpass_query},timeout=30).json()
+            resp = osm2geojson.json2geojson(result)
+            city_bounds = gpd.GeoDataFrame.from_features(resp["features"]).set_crs(GLOBAL_CRS)
+            # Streets.logger.debug(f"City bounds retrieved: {city_bounds}")
+            return city_bounds
+        except requests.exceptions.RequestException as exc:
+            with suppress(ConectionError):
+                raise ConectionError(f'unable to get city bounds') from exc
    
+
+
+
    
+[docs]
+    @staticmethod
+    def get_features_from_id(
+        osm_id: int,
+        tags: dict,
+        osm_type="R",
+        selected_columns=["tag", "element_type", "osmid", "name", "geometry", "centroid"],
+    ) -> gpd.GeoDataFrame:
+        """
+        Get features from the given OSM ID using the provided tags and OSM type, and return the results as a GeoDataFrame.
+
+        Args:
+            osm_id (int): The OpenStreetMap ID.
+            tags (dict): The tags to filter by.
+            osm_type (str, optional): The OpenStreetMap type. Defaults to "R".
+            selected_columns (list, optional): The selected columns to include in the result GeoDataFrame.
+            Defaults to ['tag', 'element_type', 'osmid', 'name', 'geometry', 'centroid'].
+
+        Returns:
+            gpd.GeoDataFrame: The GeoDataFrame containing the features.
+        """
+        place = GeoDataGetter._get_place_from_id(osm_id, osm_type)
+        gdf_list = GeoDataGetter._process_tags(tags, place)
+
+        if len(gdf_list) > 0:
+            merged_gdf = pd.concat(gdf_list).reset_index().loc[:, selected_columns]
+        else:
+            merged_gdf = pd.DataFrame(columns=selected_columns)
+
+        return merged_gdf
    
+
+
+    @staticmethod
+    def _get_place_from_id(osm_id, osm_type):
+        place = ox.project_gdf(ox.geocode_to_gdf(osm_type + str(osm_id), by_osmid=True))
+        return place
+
+    @staticmethod
+    def _process_tags(tags, place):
+        gdf_list = []
+        place_name = place.name.iloc[0]
+        for category, category_tags in tags.items():
+            for tag in tqdm(category_tags, desc=f"Processing category {category}"):
+                try:
+                    gdf = GeoDataGetter._get_features_from_place(place_name, category, tag)
+                    gdf_list.append(gdf)
+                except AttributeError:
+                    logger.warning(f'Error processing {tags, place}')
+                    pass
+        return gdf_list
+
+    @staticmethod
+    def _get_features_from_place(place_name, category, tag):
+        gdf = ox.features_from_place(place_name, tags={category: tag})
+        gdf.geometry.dropna(inplace=True)
+        gdf["tag"] = category
+        gdf["centroid"] = gdf["geometry"]
+
+        tmpgdf = ox.projection.project_gdf(gdf, to_crs=GLOBAL_METRIC_CRS, to_latlong=False)
+        tmpgdf["centroid"] = tmpgdf["geometry"].centroid
+        tmpgdf = tmpgdf.to_crs(GLOBAL_CRS)
+        gdf["centroid"] = tmpgdf["centroid"]
+        tmpgdf = None
+
+        return gdf
+    
+
    
+[docs]
+    @staticmethod
+    def get_drive_graph(city_bounds: gpd.GeoDataFrame) -> nx.MultiDiGraph:
+        """
+        Method uses the OSMnx library to retrieve the street network for a
+        specified city and returns it as a NetworkX MultiDiGraph object, where
+        each edge represents a street segment and each node represents
+        an intersection.
+        """
+
+        try:
+            G_drive = ox.graph_from_polygon(city_bounds.dissolve()["geometry"].squeeze(), network_type="drive")
+            logger.debug(f"Drive graph retrieved: {G_drive}")
+            if isinstance(G_drive, nx.Graph):
+                return G_drive
+            else:
+                raise AttributeError
+        except AttributeError as exc:
+            with suppress(ConectionError):
+                raise ConectionError(f"Error retrieving drive graph: {exc}") from exc
    
+
    
+
+
    +
    +
    +
    + +
    + + +
    +
    +
    +
    + Copyright © 2024, itmo_idu +
    + Made with + Furo + +
    +
    + +
    +
    + +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/docs/build/html/_modules/sloyka/src/utils/data_getter/street_getter.html b/docs/build/html/_modules/sloyka/src/utils/data_getter/street_getter.html new file mode 100644 index 0000000..0c2d448 --- /dev/null +++ b/docs/build/html/_modules/sloyka/src/utils/data_getter/street_getter.html @@ -0,0 +1,441 @@ + + + + + + + + sloyka.src.utils.data_getter.street_getter - sloyka 0.2.1 documentation + + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark, in light mode + + + + + + + + + + + + + + + Auto light/dark, in dark mode + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    + +
    +
    +
    sloyka 0.2.1 documentation
     +
    +
    +
    + +
    + +
    +
    + +
    +
    +
    + + + + + Back to top + +
    +
    + +
    + +
    +
    +

    Source code for sloyka.src.utils.data_getter.street_getter

    +import re
+import geopandas as gpd
+import pandas as pd
+
+import warnings
+
+from sloyka.src.utils.data_getter.geo_data_getter import GeoDataGetter as dg
+from sloyka.src.utils.data_preprocessing import preprocessor as pp
+from sloyka.src.utils.constants import TOPONYM_PATTERN
+
+warnings.simplefilter("ignore")
+warnings.filterwarnings("ignore", category=DeprecationWarning)
+
+class StreetsError(Exception):
+    """Custom exception for streets-related errors"""
+
+    pass
+
+
+
    
+[docs]
+class Streets:
+    """
+    This class encapsulates functionality for retrieving street data
+    for a specified city from OSM and processing it to extract useful
+    information for geocoding purposes.
+    """
+
+
    
+[docs]
+    @staticmethod
+    def get_street_names(gdf: gpd.GeoDataFrame) -> pd.DataFrame:
+        """
+        Method extracts the unique street names from a
+        GeoDataFrame of street segments.
+        """
+        # Streets.logger.info("Extracting street names")
+        names = set(gdf["name"].explode().dropna())
+        df_streets = pd.DataFrame(names, columns=["street"])
+        # Streets.logger.debug(f"Street names extracted: {df_streets}")
+        return df_streets
    
+
+
+
    
+[docs]
+    @staticmethod
+    def find_toponim_words_from_name(x: str) -> str:
+        """
+        A method to find toponim words from the given name string.
+
+        Args:
+            x (str): The input name string.
+
+        Returns:
+            str: The found toponim word from the input name string, or None if not found.
+        """
+        # Streets.logger.debug(f"Finding toponim words in {x}")
+        pattern = re.compile(
+            TOPONYM_PATTERN,
+            re.IGNORECASE,
+        )
+
+        match = pattern.search(x)
+
+        if match:
+            return match.group().strip().lower()
+        else:
+            return None
    
+
+
+
    
+[docs]
+    @staticmethod
+    def drop_words_from_name(x: str) -> str:
+        """
+        This function drops parts of street names that are not the name
+        of the street (e.g. avenue).
+        """
+        # Streets.logger.debug(f"Dropping words from {x}")
+        try:
+            lst = re.split(
+                TOPONYM_PATTERN,
+                x,
+            )
+            lst.remove("")
+
+            return lst[0].strip().lower()
+
+        except ValueError:
+            return x
    
+
+
+
    
+[docs]
+    @staticmethod
+    def clear_names(streets_df: pd.DataFrame) -> pd.DataFrame:
+        """
+        This function pre-process the street names from the OSM.
+        This step is necessary to match recognised street addresses later.
+        We need to do this match because Nominatim is very sensitive geocoder
+        and requires almost exact match between addresses in the OSM database
+        and the geocoding address.
+        """
+        # Streets.logger.info("Clearing street names")
+        streets_df["toponim_name"] = streets_df["street"].map(Streets.find_toponim_words_from_name)
+        streets_df["street_name"] = streets_df["street"].map(Streets.drop_words_from_name)
+        # Streets.logger.debug(f"Street names cleared: {streets_df}")
+        return streets_df
    
+
+
+
    
+[docs]
+    @staticmethod
+    def run(osm_id: int) -> pd.DataFrame:
+        """
+        A static method to run the process of getting street data based on the given
+        OSM id, returning a pandas DataFrame.
+        """
+        # Streets.logger.info(f"Running street data retrieval for osm_id {osm_id}")
+        city_bounds = dg.get_city_bounds(osm_id)
+        streets_graph = dg.get_drive_graph(city_bounds)
+        streets_gdf = pp.graph_to_gdf(streets_graph)
+        streets_df = Streets.get_street_names(streets_gdf)
+        streets_df = Streets.clear_names(streets_df)
+        # Streets.logger.info(f"Street data retrieval complete: {streets_df}")
+        return streets_df
    
+
    
+
+
    +
    +
    +
    + +
    + + +
    +
    +
    +
    + Copyright © 2024, itmo_idu +
    + Made with + Furo + +
    +
    + +
    +
    + +
    +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/docs/build/html/_modules/sloyka/src/utils/data_getter/vk_data_getter.html b/docs/build/html/_modules/sloyka/src/utils/data_getter/vk_data_getter.html index 00061d5..485474f 100644 --- a/docs/build/html/_modules/sloyka/src/utils/data_getter/vk_data_getter.html +++ b/docs/build/html/_modules/sloyka/src/utils/data_getter/vk_data_getter.html @@ -4,11 +4,11 @@ - - sloyka.src.utils.data_getter.vk_data_getter - sloyka 0.1.0 documentation + + sloyka.src.utils.data_getter.vk_data_getter - sloyka 0.2.1 documentation - - + + @@ -88,19 +88,6 @@ - - Auto light/dark mode - - - - - - - - - - Auto light/dark, in light mode - @@ -179,7 +166,7 @@
    -
    sloyka 0.1.0 documentation
     +
    sloyka 0.2.1 documentation
    @@ -206,7 +193,7 @@
    - sloyka 0.1.0 documentation + sloyka 0.2.1 documentation
    -

    About:

    +

    General:

    Receiving:

    @@ -293,29 +287,15 @@

    Source code for sloyka.src.utils.data_getter.vk_data_getter

    A class for working with street data. """ -import osmnx as ox -import geopandas as gpd import pandas as pd -from sloyka.src.utils.constants import ( - GLOBAL_CRS, - GLOBAL_METRIC_CRS, -) -from shapely.ops import transform from tqdm import tqdm import requests -import sys import datetime import time -import osm2geojson import random -from typing import List, Optional -from osmapi import OsmApi -import networkx as nx -from loguru import logger -
    -[docs] +[docs] class VKParser: API_VERISON = "5.131" COUNT_ITEMS = 100 @@ -323,7 +303,7 @@

    Source code for sloyka.src.utils.data_getter.vk_data_getter

    TIMEOUT_LIMIT = 15
    -[docs] +[docs] @staticmethod def get_group_name(domain, accsess_token): params = {"group_id": domain, "access_token": accsess_token, "v": VKParser.API_VERISON} @@ -338,7 +318,7 @@

    Source code for sloyka.src.utils.data_getter.vk_data_getter

    -[docs] +[docs] @staticmethod def get_owner_id_by_domain(domain, access_token): """ @@ -366,7 +346,7 @@

    Source code for sloyka.src.utils.data_getter.vk_data_getter

    -[docs] +[docs] @staticmethod def get_group_post_ids(domain, access_token, post_num_limit, step) -> list: """ @@ -400,9 +380,9 @@

    Source code for sloyka.src.utils.data_getter.vk_data_getter

    -[docs] +[docs] @staticmethod - def get_subcomments(owner_id, post_id, access_token, params): + def get_subcomments(params): """ Retrieves subcomments from the VK API. @@ -433,8 +413,8 @@

    Source code for sloyka.src.utils.data_getter.vk_data_getter

    -[docs] - def get_comments(owner_id, post_id, access_token): +[docs] + def get_comments(self, owner_id, post_id, access_token): """ Get comments for a post on VK using the specified owner ID, post ID, and access token. @@ -473,13 +453,13 @@

    Source code for sloyka.src.utils.data_getter.vk_data_getter

    comments.append(item) if item["thread"]["count"] > 0: params["comment_id"] = item["id"] - subcomments = VKParser.get_subcomments(owner_id, post_id, access_token, params) + subcomments = VKParser.get_subcomments(params) comments.extend(subcomments) return comments
    -[docs] +[docs] @staticmethod def comments_to_dataframe(comments): """ @@ -497,7 +477,7 @@

    Source code for sloyka.src.utils.data_getter.vk_data_getter

    -[docs] +[docs] @staticmethod def run_posts(domain, access_token, cutoff_date, number_of_messages=float("inf"), step=50): """ @@ -514,7 +494,6 @@

    Source code for sloyka.src.utils.data_getter.vk_data_getter

    pandas.DataFrame: A DataFrame containing the retrieved posts. """ - domain = domain offset = 0 all_posts = [] if step > number_of_messages: @@ -558,23 +537,27 @@

    Source code for sloyka.src.utils.data_getter.vk_data_getter

    -[docs] +[docs] @staticmethod def run_comments(domain, post_ids, access_token): owner_id = VKParser.get_owner_id_by_domain(domain, access_token) all_comments = [] for post_id in tqdm(post_ids): - comments = VKParser.get_comments(owner_id, post_id, access_token) + comments = VKParser().get_comments(owner_id, post_id, access_token) all_comments.extend(comments) - df = VKParser.comments_to_dataframe(all_comments) - df["type"] = "comment" - df = df.reset_index(drop=True) - print("comments downloaded") - return df
    + if len(all_comments) > 0: + df = VKParser.comments_to_dataframe(all_comments) + df["type"] = "comment" + df = df.reset_index(drop=True) + print("comments downloaded") + return df + else: + print("no comments") + return None
    -[docs] +[docs] @staticmethod def run_parser(domain, access_token, cutoff_date, number_of_messages=float("inf"), step=100): """ @@ -592,17 +575,20 @@

    Source code for sloyka.src.utils.data_getter.vk_data_getter

    post_ids = df_posts["id"].tolist() df_comments = VKParser.run_comments(domain=owner_id, post_ids=post_ids, access_token=access_token) - df_comments.loc[df_comments["parents_stack"].apply(lambda x: len(x) > 0), "type"] = "reply" - for i in range(len(df_comments)): - tmp = df_comments["parents_stack"].iloc[i] - if tmp is not None: - if len(tmp) > 0: - df_comments["parents_stack"].iloc[i] = tmp[0] - else: - df_comments["parents_stack"].iloc[i] = None - - df_combined = df_comments.join(df_posts, on="post_id", rsuffix="_post") - df_combined = pd.concat([df_posts, df_comments], ignore_index=True) + if df_comments is not None: + df_comments.loc[df_comments["parents_stack"].apply(lambda x: len(x) > 0), "type"] = "reply" + for i in range(len(df_comments)): + tmp = df_comments["parents_stack"].iloc[i] + if tmp is not None: + if len(tmp) > 0: + df_comments["parents_stack"].iloc[i] = tmp[0] + else: + df_comments["parents_stack"].iloc[i] = None + + df_combined = df_comments.join(df_posts, on="post_id", rsuffix="_post") + df_combined = pd.concat([df_posts, df_comments], ignore_index=True) + else: + df_combined = df_posts df_group_name = VKParser.get_group_name(domain, access_token) df_combined["group_name"] = df_group_name["group_name"][0] @@ -640,9 +626,9 @@

    Source code for sloyka.src.utils.data_getter.vk_data_getter

    +
    - + \ No newline at end of file diff --git a/docs/build/html/_modules/sloyka/src/utils/data_processing/city_services_extract.html b/docs/build/html/_modules/sloyka/src/utils/data_processing/city_services_extract.html index 988ad40..b7d7d14 100644 --- a/docs/build/html/_modules/sloyka/src/utils/data_processing/city_services_extract.html +++ b/docs/build/html/_modules/sloyka/src/utils/data_processing/city_services_extract.html @@ -4,11 +4,11 @@ - - sloyka.src.utils.data_processing.city_services_extract - sloyka 0.1.0 documentation + + sloyka.src.utils.data_processing.city_services_extract - sloyka 0.2.1 documentation - - + + @@ -88,19 +88,6 @@ - - Auto light/dark mode - - - - - - - - - - Auto light/dark, in light mode - @@ -179,7 +166,7 @@
    -
    sloyka 0.1.0 documentation
     +
    sloyka 0.2.1 documentation
    @@ -206,7 +193,7 @@
    - sloyka 0.1.0 documentation + sloyka 0.2.1 documentation
    -

    About:

    +

    General:

    Receiving:

    @@ -280,25 +274,25 @@

    Source code for sloyka.src.utils.data_processing.city_services_extract

    -import pandas as pd
-import numpy as np
+import numpy as np
 from flair.models import SequenceTagger
 from flair.data import Sentence
 from rapidfuzz import fuzz
-from typing import List
 from sloyka.src.utils.constants import CITY_SERVICES_NAMES
-
-tagger = SequenceTagger.load("Glebosol/city_services")
-
+from sloyka.src.utils.data_preprocessing.preprocessor import PreprocessorInput
 
 
    
 [docs]
 class City_services:
+
+    def __init__(self, model_name:str="Glebosol/city_services"):
+        self.tagger = SequenceTagger.load(model_name)
+
 
    
 [docs]
-    def extraction_services(text):
+    def extraction_services(self, text):
         sentence = Sentence(text)
-        tagger.predict(sentence)
+        self.tagger.predict(sentence)
         entities = sentence.get_spans("ner")
         entity_names = [entity.text for entity in entities]
         return entity_names
    
@@ -311,10 +305,6 @@ 
    Source code for sloyka.src.utils.data_processing.city_services_extract
    <
         return reduced_words
    
 
 
-    # def replace_with_most_similar(entity_names: List[str], CITY_SERVICES_NAMES: List[str]) -> List[str]:
-    #     true_city_services_names = [difflib.get_close_matches(word_entity_names, CITY_SERVICES_NAMES, n=1, cutoff=0.0)[0] for word_entity_names in entity_names]
-    #     return true_city_services_names
-
 
    
 [docs]
     def replace_with_most_similar(list_of_entities):
@@ -333,11 +323,11 @@ 
    Source code for sloyka.src.utils.data_processing.city_services_extract
    <
 
    
 [docs]
     def run(self, df, text_column):
-        df["City_services_extraced"] = df[text_column].apply(lambda text: City_services.extraction_services(text))
-        df["City_services_cuted"] = df["City_services_extraced"].apply(
-            lambda row: City_services.remove_last_letter(row)
-        )
-        df["City_services"] = df["City_services_cuted"].apply(lambda row: City_services.replace_with_most_similar(row))
+        df = PreprocessorInput.run(df, text_column)
+        city_services = City_services()
+        df["City_services_extraced"] = df[text_column].apply(city_services.extraction_services)
+        df["City_services_cuted"] = df["City_services_extraced"].apply(City_services.remove_last_letter)
+        df["City_services"] = df["City_services_cuted"].apply(City_services.replace_with_most_similar)
         df.drop("City_services_cuted", axis=1, inplace=True)
         return df
    
 
    
@@ -373,9 +363,9 @@ 
    Source code for sloyka.src.utils.data_processing.city_services_extract
    <
    -
    +
    - + \ No newline at end of file diff --git a/docs/build/html/_modules/sloyka/src/visual/graph_visualization.html b/docs/build/html/_modules/sloyka/src/visual/graph_visualization.html index 7e130a7..f2dd706 100644 --- a/docs/build/html/_modules/sloyka/src/visual/graph_visualization.html +++ b/docs/build/html/_modules/sloyka/src/visual/graph_visualization.html @@ -4,11 +4,11 @@ - - sloyka.src.visual.graph_visualization - sloyka 0.1.0 documentation + + sloyka.src.visual.graph_visualization - sloyka 0.2.1 documentation - - + + @@ -88,19 +88,6 @@ - - Auto light/dark mode - - - - - - - - - - Auto light/dark, in light mode - @@ -179,7 +166,7 @@
    -
    sloyka 0.1.0 documentation
     +
    sloyka 0.2.1 documentation
    @@ -206,7 +193,7 @@
    - sloyka 0.1.0 documentation + sloyka 0.2.1 documentation
    -

    About:

    +

    General:

    Receiving:

    @@ -280,87 +274,70 @@

    Source code for sloyka.src.visual.graph_visualization

    -import networkx as nx
-import folium
+import folium
 import random
-from folium.plugins import MarkerCluster
 
 
-
    
-[docs]
-def draw_graph_folium(graph_path, output_file=None):
+
    
+[docs]
+def visualize_graph(G, zoom: int):
     """
     Visualizes a graph from the given graph_path using Folium and MarkerCluster.
-
+    
     Args:
-        graph_path (str): The path to the graphml file.
         output_file (str, optional): The file to save the visualization to. Defaults to None.
-
+        
     Returns:
         folium.Map: The folium map object representing the visualized graph.
     """
-    G = nx.read_graphml(graph_path)
-
-    color_mapping = {
-        -1: "gray",
-        0: "blue",
-        1: "green",
-        2: "purple",
-        3: "cyan",
-        4: "brown",
-        5: "orange",
-        6: "pink",
-        7: "darkred",
-        8: "yellow",
-        9: "beige",
-        10: "darkgreen",
-        11: "lightgreen",
-        12: "darkblue",
-        13: "lightblue",
-        14: "darkpurple",
-        15: "cadetblue",
-        16: "red",
-        17: "lightgreen",
-        18: "lightblue",
-    }
-
-    target_clusters = range(1, 19)
 
     m = folium.Map(
-        location=[59.9343, 30.3351],
-        zoom_start=10,
-        tiles="cartodbdark_matter",
+        zoom_start=zoom,
+        tiles="cartodb_positron",
         control_scale=True,
     )
 
-    for c in target_clusters:
-        mc = MarkerCluster(name=f"{c} | cluster")
+    nodes_group = folium.FeatureGroup(name='Nodes')
+    neighbors_group = folium.FeatureGroup(name='Neighbors')
+    lines_group = folium.FeatureGroup(name='Lines')
 
-        for node, data in G.nodes(data=True):
-            if "Lat" in data and "Lon" in data:
-                main_node_location = [data["Lat"], data["Lon"]]
-                for n in G.neighbors(node):
-                    if "Cluster" in G.nodes[n] and G.nodes[n]["Cluster"] == c:
-                        neighbor_data = G.nodes[n]
-                        neighbor_location = [
-                            main_node_location[1] + random.uniform(-0.0008, 0.0008),
-                            main_node_location[0] + random.uniform(-0.0008, 0.0008),
-                        ]
-                        folium.CircleMarker(
-                            location=neighbor_location,
-                            radius=10,
-                            color=color_mapping[G.nodes[n]["Cluster"]],
-                            fill=True,
-                            fill_color=color_mapping[G.nodes[n]["Cluster"]],
-                            popup=neighbor_data,
-                            name=f'cluster_{G.nodes[n]["Cluster"]}',
-                        ).add_to(mc)
-        mc.add_to(m)
+    for node, data in G.nodes(data=True):
+        if "Lat" in data and "Lon" in data:
+            main_node_location = [data["Lon"], data["Lat"]]
+            folium.Marker(
+                location=main_node_location,
+                popup=node,
+                icon=folium.DivIcon(
+                    icon_size=(60,20),
+                    icon_anchor=(0,0),
+                    html='<div style="font-size: 6pt; color: blue">%s</div>' % node,
+                )
+            ).add_to(nodes_group)
+            
+            for n in G.neighbors(node):
+                neighbor_location = [
+                    main_node_location[0] + random.uniform(-0.0008, 0.0008),
+                    main_node_location[1] + random.uniform(-0.0008, 0.0008),
+                ]
+                folium.Marker(
+                    location=neighbor_location,
+                    popup=n,
+                    icon=folium.DivIcon(
+                        icon_size=(150,50),
+                        icon_anchor=(0,0),
+                        html=f'<div style="font-size: 10pt;color: darkred">{n}</div>',
+                    )
+                ).add_to(neighbors_group)
+                
+                folium.PolyLine([main_node_location, neighbor_location], color="purple", weight=1, opacity=1).add_to(lines_group)
 
-    folium.LayerControl().add_to(m)
-    if not output_file is None:
-        m.save(output_file)
+   
+    m.add_child(nodes_group)
+    m.add_child(neighbors_group)
+    m.add_child(lines_group)
 
+    folium.LayerControl().add_to(m)
+    
     return m
    @@ -394,9 +371,9 @@

    Source code for sloyka.src.visual.graph_visualization

    +
    - + \ No newline at end of file diff --git a/docs/build/html/_sources/about/introduction.rst.txt b/docs/build/html/_sources/about/introduction.rst.txt index a31cce5..95c22a9 100644 --- a/docs/build/html/_sources/about/introduction.rst.txt +++ b/docs/build/html/_sources/about/introduction.rst.txt @@ -14,7 +14,7 @@ or to visualize already existing nodes and links and their further interpretatio SLOYKA also provides methods for modeling social risks regarding the emotional evaluation of mentioned places. Main features --------- +-------------- * Social media parsing: getting posts, comments and replys * City services and places extraction * Emotion and text classifiers categorizing diff --git a/docs/build/html/_sources/about/pipeline.rst.txt b/docs/build/html/_sources/about/pipeline.rst.txt index 0b6ee8a..c19fc24 100644 --- a/docs/build/html/_sources/about/pipeline.rst.txt +++ b/docs/build/html/_sources/about/pipeline.rst.txt @@ -1,5 +1,5 @@ Main pipeline -============ +=================== By selecting a limited urbanized area and a list of online communities in a social network, it is possible to run this dataset across all major library functions. However, in some cases, @@ -17,8 +17,7 @@ text data mentioning urban sites, otherwise the steps are very important - :ref: * Data tagging: Characterization of messages and urban objects, which can be carried out in any order: :ref:`emotion_classifier` :ref:`text_classifier` :ref:`city_services` :ref:`topic_modeler` -* Data modelling: Section consists of further synthesis of the obtained data, risk assessment and forecasting. -Each of the methods in this group requires certain labeling columns: :ref:`sem_graph` :ref:`regional_activity` +* Data modelling: Section consists of further synthesis of the obtained data, risk assessment and forecasting. Each of the methods in this group requires certain labeling columns: :ref:`sem_graph` :ref:`regional_activity` * Data visualization: The last step is applied to the already generated semantic graph - :ref:`graph_visualization` diff --git a/docs/build/html/_sources/modules/GeoDataGetter.rst.txt b/docs/build/html/_sources/modules/GeoDataGetter.rst.txt index 359b53a..e007103 100644 --- a/docs/build/html/_sources/modules/GeoDataGetter.rst.txt +++ b/docs/build/html/_sources/modules/GeoDataGetter.rst.txt @@ -4,6 +4,6 @@ GeoDataGetter ========================== This class is used to retrieve geospatial data from OpenStreetMap (OSM) based on given OSM ID and tags. -.. autoclass:: sloyka.src.utils.data_getter.GeoDataGetter +.. autoclass:: sloyka.src.utils.data_getter.geo_data_getter.GeoDataGetter :members: :undoc-members: \ No newline at end of file diff --git a/docs/build/html/_sources/modules/Geocoder_special.rst.txt b/docs/build/html/_sources/modules/Geocoder_special.rst.txt index e2390e1..f8254b7 100644 --- a/docs/build/html/_sources/modules/Geocoder_special.rst.txt +++ b/docs/build/html/_sources/modules/Geocoder_special.rst.txt @@ -1,4 +1,5 @@ .. _Geocoder_special: + Geocoder ================== .. autoclass:: sloyka.src.geocoder.geocoder.Geocoder @@ -6,4 +7,4 @@ Geocoder :undoc-members: :no-members: run -Back to all :ref:`geocoder` \ No newline at end of file +Back to all :ref:`geocoder` diff --git a/docs/build/html/_sources/modules/OtherGeoObjects.rst.txt b/docs/build/html/_sources/modules/OtherGeoObjects.rst.txt index 332483c..061ae50 100644 --- a/docs/build/html/_sources/modules/OtherGeoObjects.rst.txt +++ b/docs/build/html/_sources/modules/OtherGeoObjects.rst.txt @@ -4,7 +4,7 @@ OtherGeoObjects ================== .. currentmodule:: sloyka.src.geocoder -.. autoclass:: city_objects_extractor.OtherGeoObjects +.. autoclass:: sloyka.src.geocoder.city_objects_extractor.OtherGeoObjects :members: :undoc-members: diff --git a/docs/build/html/_sources/modules/Streets.rst.txt b/docs/build/html/_sources/modules/Streets.rst.txt index 24453b1..f04cb31 100644 --- a/docs/build/html/_sources/modules/Streets.rst.txt +++ b/docs/build/html/_sources/modules/Streets.rst.txt @@ -3,6 +3,7 @@ Streets ========================== A class for working with street data. -.. autoclass:: sloyka.src.utils.data_getter.Streets + +.. autoclass:: sloyka.src.utils.data_getter.street_getter.Streets :members: - :undoc-members: \ No newline at end of file + :undoc-members: diff --git a/docs/build/html/_sources/modules/VKParser.rst.txt b/docs/build/html/_sources/modules/VKParser.rst.txt index 2e20215..4020c27 100644 --- a/docs/build/html/_sources/modules/VKParser.rst.txt +++ b/docs/build/html/_sources/modules/VKParser.rst.txt @@ -2,6 +2,6 @@ VKparser ========================== -.. autoclass:: sloyka.src.utils.data_getter.VKParser +.. autoclass:: sloyka.src.utils.data_getter.vk_data_getter.VKParser :members: :undoc-members: \ No newline at end of file diff --git a/docs/build/html/_sources/modules/city_services_extract.rst.txt b/docs/build/html/_sources/modules/city_services_extract.rst.txt index 6e1be51..38388fd 100644 --- a/docs/build/html/_sources/modules/city_services_extract.rst.txt +++ b/docs/build/html/_sources/modules/city_services_extract.rst.txt @@ -3,9 +3,10 @@ Services extraction ========================== The City_services class is designed to extract city service names from text using a string comparison algorithm, taking into account - the changing service endings in the text. Using the flair library, the City_services.run() method in messages extracts named entities - from the Sentence object as a list, as well as the most probable service type, and stores them in new columns of the original DataFrame(). +the changing service endings in the text. Using the flair library, the City_services.run() method in messages extracts named entities +from the Sentence object as a list, as well as the most probable service type, and stores them in new columns of the original DataFrame(). + .. automodule:: sloyka.src.utils.data_processing.city_services_extract - :members: - :undoc-members: + :members: + :undoc-members: \ No newline at end of file diff --git a/docs/build/html/_sources/modules/geocoder.rst.txt b/docs/build/html/_sources/modules/geocoder.rst.txt index b5a6f00..4ef23d8 100644 --- a/docs/build/html/_sources/modules/geocoder.rst.txt +++ b/docs/build/html/_sources/modules/geocoder.rst.txt @@ -1,14 +1,14 @@ .. _geocoder: ================== + Geocoding ================== -To perform classification with generalized linear models, see -:ref:`Geocoder_special`. +To perform classification with generalized linear models, see :ref:`Geocoder_special`. Geocoder ------------------- .. autoclass:: sloyka.src.geocoder.geocoder.Geocoder - :members: run + :members: run OtherGeoObjects --------------------- diff --git a/docs/build/html/_sources/modules/visualize_graph.rst.txt b/docs/build/html/_sources/modules/visualize_graph.rst.txt index 4db45d1..f5e1255 100644 --- a/docs/build/html/_sources/modules/visualize_graph.rst.txt +++ b/docs/build/html/_sources/modules/visualize_graph.rst.txt @@ -6,4 +6,4 @@ The function results in an interactive map, which will display graph nodes group Each cluster will have its own color and name. Node markers will have a random offset to avoid overlapping. .. automodule:: sloyka.src.visual.graph_visualization - :members: draw_graph_folium \ No newline at end of file + :members: visualize_graph \ No newline at end of file diff --git a/docs/build/html/_static/documentation_options.js b/docs/build/html/_static/documentation_options.js index 13d90ff..add8e0c 100644 --- a/docs/build/html/_static/documentation_options.js +++ b/docs/build/html/_static/documentation_options.js @@ -1,5 +1,5 @@ const DOCUMENTATION_OPTIONS = { - VERSION: '0.1.0', + VERSION: '0.2.1', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/docs/build/html/_static/scripts/furo.js b/docs/build/html/_static/scripts/furo.js index 0267c7e..0abb2af 100644 --- a/docs/build/html/_static/scripts/furo.js +++ b/docs/build/html/_static/scripts/furo.js @@ -1,3 +1,3 @@ /*! For license information please see furo.js.LICENSE.txt */ -(()=>{var t={856:function(t,e,n){var o,r;r=void 0!==n.g?n.g:"undefined"!=typeof window?window:this,o=function(){return function(t){"use strict";var e={navClass:"active",contentClass:"active",nested:!1,nestedClass:"active",offset:0,reflow:!1,events:!0},n=function(t,e,n){if(n.settings.events){var o=new CustomEvent(t,{bubbles:!0,cancelable:!0,detail:n});e.dispatchEvent(o)}},o=function(t){var e=0;if(t.offsetParent)for(;t;)e+=t.offsetTop,t=t.offsetParent;return e>=0?e:0},r=function(t){t&&t.sort((function(t,e){return o(t.content)=Math.max(document.body.scrollHeight,document.documentElement.scrollHeight,document.body.offsetHeight,document.documentElement.offsetHeight,document.body.clientHeight,document.documentElement.clientHeight)},l=function(t,e){var n=t[t.length-1];if(function(t,e){return!(!s()||!c(t.content,e,!0))}(n,e))return n;for(var o=t.length-1;o>=0;o--)if(c(t[o].content,e))return t[o]},a=function(t,e){if(e.nested&&t.parentNode){var n=t.parentNode.closest("li");n&&(n.classList.remove(e.nestedClass),a(n,e))}},i=function(t,e){if(t){var o=t.nav.closest("li");o&&(o.classList.remove(e.navClass),t.content.classList.remove(e.contentClass),a(o,e),n("gumshoeDeactivate",o,{link:t.nav,content:t.content,settings:e}))}},u=function(t,e){if(e.nested){var n=t.parentNode.closest("li");n&&(n.classList.add(e.nestedClass),u(n,e))}};return function(o,c){var s,a,d,f,m,v={setup:function(){s=document.querySelectorAll(o),a=[],Array.prototype.forEach.call(s,(function(t){var e=document.getElementById(decodeURIComponent(t.hash.substr(1)));e&&a.push({nav:t,content:e})})),r(a)},detect:function(){var t=l(a,m);t?d&&t.content===d.content||(i(d,m),function(t,e){if(t){var o=t.nav.closest("li");o&&(o.classList.add(e.navClass),t.content.classList.add(e.contentClass),u(o,e),n("gumshoeActivate",o,{link:t.nav,content:t.content,settings:e}))}}(t,m),d=t):d&&(i(d,m),d=null)}},h=function(e){f&&t.cancelAnimationFrame(f),f=t.requestAnimationFrame(v.detect)},g=function(e){f&&t.cancelAnimationFrame(f),f=t.requestAnimationFrame((function(){r(a),v.detect()}))};return v.destroy=function(){d&&i(d,m),t.removeEventListener("scroll",h,!1),m.reflow&&t.removeEventListener("resize",g,!1),a=null,s=null,d=null,f=null,m=null},m=function(){var t={};return Array.prototype.forEach.call(arguments,(function(e){for(var n in e){if(!e.hasOwnProperty(n))return;t[n]=e[n]}})),t}(e,c||{}),v.setup(),v.detect(),t.addEventListener("scroll",h,!1),m.reflow&&t.addEventListener("resize",g,!1),v}}(r)}.apply(e,[]),void 0===o||(t.exports=o)}},e={};function n(o){var r=e[o];if(void 0!==r)return r.exports;var c=e[o]={exports:{}};return t[o].call(c.exports,c,c.exports,n),c.exports}n.n=t=>{var e=t&&t.__esModule?()=>t.default:()=>t;return n.d(e,{a:e}),e},n.d=(t,e)=>{for(var o in e)n.o(e,o)&&!n.o(t,o)&&Object.defineProperty(t,o,{enumerable:!0,get:e[o]})},n.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(t){if("object"==typeof window)return window}}(),n.o=(t,e)=>Object.prototype.hasOwnProperty.call(t,e),(()=>{"use strict";var t=n(856),e=n.n(t),o=null,r=null,c=window.pageYOffset||document.documentElement.scrollTop;const s=64;function l(){const t=localStorage.getItem("theme")||"auto";var e;"light"!==(e=window.matchMedia("(prefers-color-scheme: dark)").matches?"auto"===t?"light":"light"==t?"dark":"auto":"auto"===t?"dark":"dark"==t?"light":"auto")&&"dark"!==e&&"auto"!==e&&(console.error(`Got invalid theme mode: ${e}. Resetting to auto.`),e="auto"),document.body.dataset.theme=e,localStorage.setItem("theme",e),console.log(`Changed to ${e} mode.`)}function a(){!function(){const t=document.getElementsByClassName("theme-toggle");Array.from(t).forEach((t=>{t.addEventListener("click",l)}))}(),function(){let t=0,e=!1;window.addEventListener("scroll",(function(n){t=window.scrollY,e||(window.requestAnimationFrame((function(){var n;n=t,0==Math.floor(r.getBoundingClientRect().top)?r.classList.add("scrolled"):r.classList.remove("scrolled"),function(t){tc&&document.documentElement.classList.remove("show-back-to-top"),c=t}(n),function(t){null!==o&&(0==t?o.scrollTo(0,0):Math.ceil(t)>=Math.floor(document.documentElement.scrollHeight-window.innerHeight)?o.scrollTo(0,o.scrollHeight):document.querySelector(".scroll-current"))}(n),e=!1})),e=!0)})),window.scroll()}(),null!==o&&new(e())(".toc-tree a",{reflow:!0,recursive:!0,navClass:"scroll-current",offset:()=>{let t=parseFloat(getComputedStyle(document.documentElement).fontSize);return r.getBoundingClientRect().height+2.5*t+1}})}document.addEventListener("DOMContentLoaded",(function(){document.body.parentNode.classList.remove("no-js"),r=document.querySelector("header"),o=document.querySelector(".toc-scroll"),a()}))})()})(); +(()=>{var t={856:function(t,e,n){var o,r;r=void 0!==n.g?n.g:"undefined"!=typeof window?window:this,o=function(){return function(t){"use strict";var e={navClass:"active",contentClass:"active",nested:!1,nestedClass:"active",offset:0,reflow:!1,events:!0},n=function(t,e,n){if(n.settings.events){var o=new CustomEvent(t,{bubbles:!0,cancelable:!0,detail:n});e.dispatchEvent(o)}},o=function(t){var e=0;if(t.offsetParent)for(;t;)e+=t.offsetTop,t=t.offsetParent;return e>=0?e:0},r=function(t){t&&t.sort((function(t,e){return o(t.content)=Math.max(document.body.scrollHeight,document.documentElement.scrollHeight,document.body.offsetHeight,document.documentElement.offsetHeight,document.body.clientHeight,document.documentElement.clientHeight)},l=function(t,e){var n=t[t.length-1];if(function(t,e){return!(!s()||!c(t.content,e,!0))}(n,e))return n;for(var o=t.length-1;o>=0;o--)if(c(t[o].content,e))return t[o]},a=function(t,e){if(e.nested&&t.parentNode){var n=t.parentNode.closest("li");n&&(n.classList.remove(e.nestedClass),a(n,e))}},i=function(t,e){if(t){var o=t.nav.closest("li");o&&(o.classList.remove(e.navClass),t.content.classList.remove(e.contentClass),a(o,e),n("gumshoeDeactivate",o,{link:t.nav,content:t.content,settings:e}))}},u=function(t,e){if(e.nested){var n=t.parentNode.closest("li");n&&(n.classList.add(e.nestedClass),u(n,e))}};return function(o,c){var s,a,d,f,m,v={setup:function(){s=document.querySelectorAll(o),a=[],Array.prototype.forEach.call(s,(function(t){var e=document.getElementById(decodeURIComponent(t.hash.substr(1)));e&&a.push({nav:t,content:e})})),r(a)},detect:function(){var t=l(a,m);t?d&&t.content===d.content||(i(d,m),function(t,e){if(t){var o=t.nav.closest("li");o&&(o.classList.add(e.navClass),t.content.classList.add(e.contentClass),u(o,e),n("gumshoeActivate",o,{link:t.nav,content:t.content,settings:e}))}}(t,m),d=t):d&&(i(d,m),d=null)}},h=function(e){f&&t.cancelAnimationFrame(f),f=t.requestAnimationFrame(v.detect)},g=function(e){f&&t.cancelAnimationFrame(f),f=t.requestAnimationFrame((function(){r(a),v.detect()}))};return v.destroy=function(){d&&i(d,m),t.removeEventListener("scroll",h,!1),m.reflow&&t.removeEventListener("resize",g,!1),a=null,s=null,d=null,f=null,m=null},m=function(){var t={};return Array.prototype.forEach.call(arguments,(function(e){for(var n in e){if(!e.hasOwnProperty(n))return;t[n]=e[n]}})),t}(e,c||{}),v.setup(),v.detect(),t.addEventListener("scroll",h,!1),m.reflow&&t.addEventListener("resize",g,!1),v}}(r)}.apply(e,[]),void 0===o||(t.exports=o)}},e={};function n(o){var r=e[o];if(void 0!==r)return r.exports;var c=e[o]={exports:{}};return t[o].call(c.exports,c,c.exports,n),c.exports}n.n=t=>{var e=t&&t.__esModule?()=>t.default:()=>t;return n.d(e,{a:e}),e},n.d=(t,e)=>{for(var o in e)n.o(e,o)&&!n.o(t,o)&&Object.defineProperty(t,o,{enumerable:!0,get:e[o]})},n.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(t){if("object"==typeof window)return window}}(),n.o=(t,e)=>Object.prototype.hasOwnProperty.call(t,e),(()=>{"use strict";var t=n(856),e=n.n(t),o=null,r=null,c=document.documentElement.scrollTop;const s=64;function l(){const t=localStorage.getItem("theme")||"auto";var e;"light"!==(e=window.matchMedia("(prefers-color-scheme: dark)").matches?"auto"===t?"light":"light"==t?"dark":"auto":"auto"===t?"dark":"dark"==t?"light":"auto")&&"dark"!==e&&"auto"!==e&&(console.error(`Got invalid theme mode: ${e}. Resetting to auto.`),e="auto"),document.body.dataset.theme=e,localStorage.setItem("theme",e),console.log(`Changed to ${e} mode.`)}function a(){!function(){const t=document.getElementsByClassName("theme-toggle");Array.from(t).forEach((t=>{t.addEventListener("click",l)}))}(),function(){let t=0,e=!1;window.addEventListener("scroll",(function(n){t=window.scrollY,e||(window.requestAnimationFrame((function(){var n;(function(t){const e=Math.floor(r.getBoundingClientRect().top);console.log(`headerTop: ${e}`),0==e&&t!=e?r.classList.add("scrolled"):r.classList.remove("scrolled")})(n=t),function(t){tc&&document.documentElement.classList.remove("show-back-to-top"),c=t}(n),function(t){null!==o&&(0==t?o.scrollTo(0,0):Math.ceil(t)>=Math.floor(document.documentElement.scrollHeight-window.innerHeight)?o.scrollTo(0,o.scrollHeight):document.querySelector(".scroll-current"))}(n),e=!1})),e=!0)})),window.scroll()}(),null!==o&&new(e())(".toc-tree a",{reflow:!0,recursive:!0,navClass:"scroll-current",offset:()=>{let t=parseFloat(getComputedStyle(document.documentElement).fontSize);return r.getBoundingClientRect().height+2.5*t+1}})}document.addEventListener("DOMContentLoaded",(function(){document.body.parentNode.classList.remove("no-js"),r=document.querySelector("header"),o=document.querySelector(".toc-scroll"),a()}))})()})(); //# sourceMappingURL=furo.js.map \ No newline at end of file diff --git a/docs/build/html/_static/scripts/furo.js.map b/docs/build/html/_static/scripts/furo.js.map index c3b37aa..80ea12b 100644 --- a/docs/build/html/_static/scripts/furo.js.map +++ b/docs/build/html/_static/scripts/furo.js.map @@ -1 +1 @@ -{"version":3,"file":"scripts/furo.js","mappings":";iCAAA,MAQWA,SAWS,IAAX,EAAAC,EACH,EAAAA,EACkB,oBAAXC,OACLA,OACAC,KAbO,EAAF,WACP,OAaJ,SAAUD,GACR,aAMA,IAAIE,EAAW,CAEbC,SAAU,SACVC,aAAc,SAGdC,QAAQ,EACRC,YAAa,SAGbC,OAAQ,EACRC,QAAQ,EAGRC,QAAQ,GA6BNC,EAAY,SAAUC,EAAMC,EAAMC,GAEpC,GAAKA,EAAOC,SAASL,OAArB,CAGA,IAAIM,EAAQ,IAAIC,YAAYL,EAAM,CAChCM,SAAS,EACTC,YAAY,EACZL,OAAQA,IAIVD,EAAKO,cAAcJ,EAVgB,CAWrC,EAOIK,EAAe,SAAUR,GAC3B,IAAIS,EAAW,EACf,GAAIT,EAAKU,aACP,KAAOV,GACLS,GAAYT,EAAKW,UACjBX,EAAOA,EAAKU,aAGhB,OAAOD,GAAY,EAAIA,EAAW,CACpC,EAMIG,EAAe,SAAUC,GACvBA,GACFA,EAASC,MAAK,SAAUC,EAAOC,GAG7B,OAFcR,EAAaO,EAAME,SACnBT,EAAaQ,EAAMC,UACF,EACxB,CACT,GAEJ,EAwCIC,EAAW,SAAUlB,EAAME,EAAUiB,GACvC,IAAIC,EAASpB,EAAKqB,wBACd1B,EAnCU,SAAUO,GAExB,MAA+B,mBAApBA,EAASP,OACX2B,WAAWpB,EAASP,UAItB2B,WAAWpB,EAASP,OAC7B,CA2Be4B,CAAUrB,GACvB,OAAIiB,EAEAK,SAASJ,EAAOD,OAAQ,KACvB/B,EAAOqC,aAAeC,SAASC,gBAAgBC,cAG7CJ,SAASJ,EAAOS,IAAK,KAAOlC,CACrC,EAMImC,EAAa,WACf,OACEC,KAAKC,KAAK5C,EAAOqC,YAAcrC,EAAO6C,cAnCjCF,KAAKG,IACVR,SAASS,KAAKC,aACdV,SAASC,gBAAgBS,aACzBV,SAASS,KAAKE,aACdX,SAASC,gBAAgBU,aACzBX,SAASS,KAAKP,aACdF,SAASC,gBAAgBC,aAkC7B,EAmBIU,EAAY,SAAUzB,EAAUX,GAClC,IAAIqC,EAAO1B,EAASA,EAAS2B,OAAS,GACtC,GAbgB,SAAUC,EAAMvC,GAChC,SAAI4B,MAAgBZ,EAASuB,EAAKxB,QAASf,GAAU,GAEvD,CAUMwC,CAAYH,EAAMrC,GAAW,OAAOqC,EACxC,IAAK,IAAII,EAAI9B,EAAS2B,OAAS,EAAGG,GAAK,EAAGA,IACxC,GAAIzB,EAASL,EAAS8B,GAAG1B,QAASf,GAAW,OAAOW,EAAS8B,EAEjE,EAOIC,EAAmB,SAAUC,EAAK3C,GAEpC,GAAKA,EAAST,QAAWoD,EAAIC,WAA7B,CAGA,IAAIC,EAAKF,EAAIC,WAAWE,QAAQ,MAC3BD,IAGLA,EAAGE,UAAUC,OAAOhD,EAASR,aAG7BkD,EAAiBG,EAAI7C,GAV0B,CAWjD,EAOIiD,EAAa,SAAUC,EAAOlD,GAEhC,GAAKkD,EAAL,CAGA,IAAIL,EAAKK,EAAMP,IAAIG,QAAQ,MACtBD,IAGLA,EAAGE,UAAUC,OAAOhD,EAASX,UAC7B6D,EAAMnC,QAAQgC,UAAUC,OAAOhD,EAASV,cAGxCoD,EAAiBG,EAAI7C,GAGrBJ,EAAU,oBAAqBiD,EAAI,CACjCM,KAAMD,EAAMP,IACZ5B,QAASmC,EAAMnC,QACff,SAAUA,IAjBM,CAmBpB,EAOIoD,EAAiB,SAAUT,EAAK3C,GAElC,GAAKA,EAAST,OAAd,CAGA,IAAIsD,EAAKF,EAAIC,WAAWE,QAAQ,MAC3BD,IAGLA,EAAGE,UAAUM,IAAIrD,EAASR,aAG1B4D,EAAeP,EAAI7C,GAVS,CAW9B,EA6LA,OA1JkB,SAAUsD,EAAUC,GAKpC,IACIC,EAAU7C,EAAU8C,EAASC,EAAS1D,EADtC2D,EAAa,CAUjBA,MAAmB,WAEjBH,EAAWhC,SAASoC,iBAAiBN,GAGrC3C,EAAW,GAGXkD,MAAMC,UAAUC,QAAQC,KAAKR,GAAU,SAAUjB,GAE/C,IAAIxB,EAAUS,SAASyC,eACrBC,mBAAmB3B,EAAK4B,KAAKC,OAAO,KAEjCrD,GAGLJ,EAAS0D,KAAK,CACZ1B,IAAKJ,EACLxB,QAASA,GAEb,IAGAL,EAAaC,EACf,EAKAgD,OAAoB,WAElB,IAAIW,EAASlC,EAAUzB,EAAUX,GAG5BsE,EASDb,GAAWa,EAAOvD,UAAY0C,EAAQ1C,UAG1CkC,EAAWQ,EAASzD,GAzFT,SAAUkD,EAAOlD,GAE9B,GAAKkD,EAAL,CAGA,IAAIL,EAAKK,EAAMP,IAAIG,QAAQ,MACtBD,IAGLA,EAAGE,UAAUM,IAAIrD,EAASX,UAC1B6D,EAAMnC,QAAQgC,UAAUM,IAAIrD,EAASV,cAGrC8D,EAAeP,EAAI7C,GAGnBJ,EAAU,kBAAmBiD,EAAI,CAC/BM,KAAMD,EAAMP,IACZ5B,QAASmC,EAAMnC,QACff,SAAUA,IAjBM,CAmBpB,CAqEIuE,CAASD,EAAQtE,GAGjByD,EAAUa,GAfJb,IACFR,EAAWQ,EAASzD,GACpByD,EAAU,KAchB,GAMIe,EAAgB,SAAUvE,GAExByD,GACFxE,EAAOuF,qBAAqBf,GAI9BA,EAAUxE,EAAOwF,sBAAsBf,EAAWgB,OACpD,EAMIC,EAAgB,SAAU3E,GAExByD,GACFxE,EAAOuF,qBAAqBf,GAI9BA,EAAUxE,EAAOwF,uBAAsB,WACrChE,EAAaC,GACbgD,EAAWgB,QACb,GACF,EAkDA,OA7CAhB,EAAWkB,QAAU,WAEfpB,GACFR,EAAWQ,EAASzD,GAItBd,EAAO4F,oBAAoB,SAAUN,GAAe,GAChDxE,EAASN,QACXR,EAAO4F,oBAAoB,SAAUF,GAAe,GAItDjE,EAAW,KACX6C,EAAW,KACXC,EAAU,KACVC,EAAU,KACV1D,EAAW,IACb,EAOEA,EA3XS,WACX,IAAI+E,EAAS,CAAC,EAOd,OANAlB,MAAMC,UAAUC,QAAQC,KAAKgB,WAAW,SAAUC,GAChD,IAAK,IAAIC,KAAOD,EAAK,CACnB,IAAKA,EAAIE,eAAeD,GAAM,OAC9BH,EAAOG,GAAOD,EAAIC,EACpB,CACF,IACOH,CACT,CAkXeK,CAAOhG,EAAUmE,GAAW,CAAC,GAGxCI,EAAW0B,QAGX1B,EAAWgB,SAGXzF,EAAOoG,iBAAiB,SAAUd,GAAe,GAC7CxE,EAASN,QACXR,EAAOoG,iBAAiB,SAAUV,GAAe,GAS9CjB,CACT,CAOF,CArcW4B,CAAQvG,EAChB,UAFM,SAEN,uBCXDwG,EAA2B,CAAC,EAGhC,SAASC,EAAoBC,GAE5B,IAAIC,EAAeH,EAAyBE,GAC5C,QAAqBE,IAAjBD,EACH,OAAOA,EAAaE,QAGrB,IAAIC,EAASN,EAAyBE,GAAY,CAGjDG,QAAS,CAAC,GAOX,OAHAE,EAAoBL,GAAU1B,KAAK8B,EAAOD,QAASC,EAAQA,EAAOD,QAASJ,GAGpEK,EAAOD,OACf,CCrBAJ,EAAoBO,EAAKF,IACxB,IAAIG,EAASH,GAAUA,EAAOI,WAC7B,IAAOJ,EAAiB,QACxB,IAAM,EAEP,OADAL,EAAoBU,EAAEF,EAAQ,CAAEG,EAAGH,IAC5BA,CAAM,ECLdR,EAAoBU,EAAI,CAACN,EAASQ,KACjC,IAAI,IAAInB,KAAOmB,EACXZ,EAAoBa,EAAED,EAAYnB,KAASO,EAAoBa,EAAET,EAASX,IAC5EqB,OAAOC,eAAeX,EAASX,EAAK,CAAEuB,YAAY,EAAMC,IAAKL,EAAWnB,IAE1E,ECNDO,EAAoBxG,EAAI,WACvB,GAA0B,iBAAf0H,WAAyB,OAAOA,WAC3C,IACC,OAAOxH,MAAQ,IAAIyH,SAAS,cAAb,EAChB,CAAE,MAAOC,GACR,GAAsB,iBAAX3H,OAAqB,OAAOA,MACxC,CACA,CAPuB,GCAxBuG,EAAoBa,EAAI,CAACrB,EAAK6B,IAAUP,OAAOzC,UAAUqB,eAAenB,KAAKiB,EAAK6B,4CCK9EC,EAAY,KACZC,EAAS,KACTC,EAAgB/H,OAAO6C,aAAeP,SAASC,gBAAgByF,UACnE,MAAMC,EAAmB,GA2EzB,SAASC,IACP,MAAMC,EAAeC,aAAaC,QAAQ,UAAY,OAZxD,IAAkBC,EACH,WADGA,EAaItI,OAAOuI,WAAW,gCAAgCC,QAI/C,SAAjBL,EACO,QACgB,SAAhBA,EACA,OAEA,OAIU,SAAjBA,EACO,OACgB,QAAhBA,EACA,QAEA,SA9BoB,SAATG,GAA4B,SAATA,IACzCG,QAAQC,MAAM,2BAA2BJ,yBACzCA,EAAO,QAGThG,SAASS,KAAK4F,QAAQC,MAAQN,EAC9BF,aAAaS,QAAQ,QAASP,GAC9BG,QAAQK,IAAI,cAAcR,UA0B5B,CAkDA,SAASnC,KART,WAEE,MAAM4C,EAAUzG,SAAS0G,uBAAuB,gBAChDrE,MAAMsE,KAAKF,GAASlE,SAASqE,IAC3BA,EAAI9C,iBAAiB,QAAS8B,EAAe,GAEjD,CAGEiB,GA9CF,WAEE,IAAIC,EAA6B,EAC7BC,GAAU,EAEdrJ,OAAOoG,iBAAiB,UAAU,SAAUuB,GAC1CyB,EAA6BpJ,OAAOsJ,QAE/BD,IACHrJ,OAAOwF,uBAAsB,WAzDnC,IAAuB+D,IA0DDH,EA9GkC,GAAlDzG,KAAK6G,MAAM1B,EAAO7F,wBAAwBQ,KAC5CqF,EAAOjE,UAAUM,IAAI,YAErB2D,EAAOjE,UAAUC,OAAO,YAI5B,SAAmCyF,GAC7BA,EAAYtB,EACd3F,SAASC,gBAAgBsB,UAAUC,OAAO,oBAEtCyF,EAAYxB,EACdzF,SAASC,gBAAgBsB,UAAUM,IAAI,oBAC9BoF,EAAYxB,GACrBzF,SAASC,gBAAgBsB,UAAUC,OAAO,oBAG9CiE,EAAgBwB,CAClB,CAoCEE,CAA0BF,GAlC5B,SAA6BA,GACT,OAAd1B,IAKa,GAAb0B,EACF1B,EAAU6B,SAAS,EAAG,GAGtB/G,KAAKC,KAAK2G,IACV5G,KAAK6G,MAAMlH,SAASC,gBAAgBS,aAAehD,OAAOqC,aAE1DwF,EAAU6B,SAAS,EAAG7B,EAAU7E,cAGhBV,SAASqH,cAAc,mBAc3C,CAKEC,CAAoBL,GAwDdF,GAAU,CACZ,IAEAA,GAAU,EAEd,IACArJ,OAAO6J,QACT,CA6BEC,GA1BkB,OAAdjC,GAKJ,IAAI,IAAJ,CAAY,cAAe,CACzBrH,QAAQ,EACRuJ,WAAW,EACX5J,SAAU,iBACVI,OAAQ,KACN,IAAIyJ,EAAM9H,WAAW+H,iBAAiB3H,SAASC,iBAAiB2H,UAChE,OAAOpC,EAAO7F,wBAAwBkI,OAAS,IAAMH,EAAM,CAAC,GAiBlE,CAcA1H,SAAS8D,iBAAiB,oBAT1B,WACE9D,SAASS,KAAKW,WAAWG,UAAUC,OAAO,SAE1CgE,EAASxF,SAASqH,cAAc,UAChC9B,EAAYvF,SAASqH,cAAc,eAEnCxD,GACF","sources":["webpack:///./src/furo/assets/scripts/gumshoe-patched.js","webpack:///webpack/bootstrap","webpack:///webpack/runtime/compat get default export","webpack:///webpack/runtime/define property getters","webpack:///webpack/runtime/global","webpack:///webpack/runtime/hasOwnProperty shorthand","webpack:///./src/furo/assets/scripts/furo.js"],"sourcesContent":["/*!\n * gumshoejs v5.1.2 (patched by @pradyunsg)\n * A simple, framework-agnostic scrollspy script.\n * (c) 2019 Chris Ferdinandi\n * MIT License\n * http://github.com/cferdinandi/gumshoe\n */\n\n(function (root, factory) {\n if (typeof define === \"function\" && define.amd) {\n define([], function () {\n return factory(root);\n });\n } else if (typeof exports === \"object\") {\n module.exports = factory(root);\n } else {\n root.Gumshoe = factory(root);\n }\n})(\n typeof global !== \"undefined\"\n ? global\n : typeof window !== \"undefined\"\n ? window\n : this,\n function (window) {\n \"use strict\";\n\n //\n // Defaults\n //\n\n var defaults = {\n // Active classes\n navClass: \"active\",\n contentClass: \"active\",\n\n // Nested navigation\n nested: false,\n nestedClass: \"active\",\n\n // Offset & reflow\n offset: 0,\n reflow: false,\n\n // Event support\n events: true,\n };\n\n //\n // Methods\n //\n\n /**\n * Merge two or more objects together.\n * @param {Object} objects The objects to merge together\n * @returns {Object} Merged values of defaults and options\n */\n var extend = function () {\n var merged = {};\n Array.prototype.forEach.call(arguments, function (obj) {\n for (var key in obj) {\n if (!obj.hasOwnProperty(key)) return;\n merged[key] = obj[key];\n }\n });\n return merged;\n };\n\n /**\n * Emit a custom event\n * @param {String} type The event type\n * @param {Node} elem The element to attach the event to\n * @param {Object} detail Any details to pass along with the event\n */\n var emitEvent = function (type, elem, detail) {\n // Make sure events are enabled\n if (!detail.settings.events) return;\n\n // Create a new event\n var event = new CustomEvent(type, {\n bubbles: true,\n cancelable: true,\n detail: detail,\n });\n\n // Dispatch the event\n elem.dispatchEvent(event);\n };\n\n /**\n * Get an element's distance from the top of the Document.\n * @param {Node} elem The element\n * @return {Number} Distance from the top in pixels\n */\n var getOffsetTop = function (elem) {\n var location = 0;\n if (elem.offsetParent) {\n while (elem) {\n location += elem.offsetTop;\n elem = elem.offsetParent;\n }\n }\n return location >= 0 ? location : 0;\n };\n\n /**\n * Sort content from first to last in the DOM\n * @param {Array} contents The content areas\n */\n var sortContents = function (contents) {\n if (contents) {\n contents.sort(function (item1, item2) {\n var offset1 = getOffsetTop(item1.content);\n var offset2 = getOffsetTop(item2.content);\n if (offset1 < offset2) return -1;\n return 1;\n });\n }\n };\n\n /**\n * Get the offset to use for calculating position\n * @param {Object} settings The settings for this instantiation\n * @return {Float} The number of pixels to offset the calculations\n */\n var getOffset = function (settings) {\n // if the offset is a function run it\n if (typeof settings.offset === \"function\") {\n return parseFloat(settings.offset());\n }\n\n // Otherwise, return it as-is\n return parseFloat(settings.offset);\n };\n\n /**\n * Get the document element's height\n * @private\n * @returns {Number}\n */\n var getDocumentHeight = function () {\n return Math.max(\n document.body.scrollHeight,\n document.documentElement.scrollHeight,\n document.body.offsetHeight,\n document.documentElement.offsetHeight,\n document.body.clientHeight,\n document.documentElement.clientHeight,\n );\n };\n\n /**\n * Determine if an element is in view\n * @param {Node} elem The element\n * @param {Object} settings The settings for this instantiation\n * @param {Boolean} bottom If true, check if element is above bottom of viewport instead\n * @return {Boolean} Returns true if element is in the viewport\n */\n var isInView = function (elem, settings, bottom) {\n var bounds = elem.getBoundingClientRect();\n var offset = getOffset(settings);\n if (bottom) {\n return (\n parseInt(bounds.bottom, 10) <\n (window.innerHeight || document.documentElement.clientHeight)\n );\n }\n return parseInt(bounds.top, 10) <= offset;\n };\n\n /**\n * Check if at the bottom of the viewport\n * @return {Boolean} If true, page is at the bottom of the viewport\n */\n var isAtBottom = function () {\n if (\n Math.ceil(window.innerHeight + window.pageYOffset) >=\n getDocumentHeight()\n )\n return true;\n return false;\n };\n\n /**\n * Check if the last item should be used (even if not at the top of the page)\n * @param {Object} item The last item\n * @param {Object} settings The settings for this instantiation\n * @return {Boolean} If true, use the last item\n */\n var useLastItem = function (item, settings) {\n if (isAtBottom() && isInView(item.content, settings, true)) return true;\n return false;\n };\n\n /**\n * Get the active content\n * @param {Array} contents The content areas\n * @param {Object} settings The settings for this instantiation\n * @return {Object} The content area and matching navigation link\n */\n var getActive = function (contents, settings) {\n var last = contents[contents.length - 1];\n if (useLastItem(last, settings)) return last;\n for (var i = contents.length - 1; i >= 0; i--) {\n if (isInView(contents[i].content, settings)) return contents[i];\n }\n };\n\n /**\n * Deactivate parent navs in a nested navigation\n * @param {Node} nav The starting navigation element\n * @param {Object} settings The settings for this instantiation\n */\n var deactivateNested = function (nav, settings) {\n // If nesting isn't activated, bail\n if (!settings.nested || !nav.parentNode) return;\n\n // Get the parent navigation\n var li = nav.parentNode.closest(\"li\");\n if (!li) return;\n\n // Remove the active class\n li.classList.remove(settings.nestedClass);\n\n // Apply recursively to any parent navigation elements\n deactivateNested(li, settings);\n };\n\n /**\n * Deactivate a nav and content area\n * @param {Object} items The nav item and content to deactivate\n * @param {Object} settings The settings for this instantiation\n */\n var deactivate = function (items, settings) {\n // Make sure there are items to deactivate\n if (!items) return;\n\n // Get the parent list item\n var li = items.nav.closest(\"li\");\n if (!li) return;\n\n // Remove the active class from the nav and content\n li.classList.remove(settings.navClass);\n items.content.classList.remove(settings.contentClass);\n\n // Deactivate any parent navs in a nested navigation\n deactivateNested(li, settings);\n\n // Emit a custom event\n emitEvent(\"gumshoeDeactivate\", li, {\n link: items.nav,\n content: items.content,\n settings: settings,\n });\n };\n\n /**\n * Activate parent navs in a nested navigation\n * @param {Node} nav The starting navigation element\n * @param {Object} settings The settings for this instantiation\n */\n var activateNested = function (nav, settings) {\n // If nesting isn't activated, bail\n if (!settings.nested) return;\n\n // Get the parent navigation\n var li = nav.parentNode.closest(\"li\");\n if (!li) return;\n\n // Add the active class\n li.classList.add(settings.nestedClass);\n\n // Apply recursively to any parent navigation elements\n activateNested(li, settings);\n };\n\n /**\n * Activate a nav and content area\n * @param {Object} items The nav item and content to activate\n * @param {Object} settings The settings for this instantiation\n */\n var activate = function (items, settings) {\n // Make sure there are items to activate\n if (!items) return;\n\n // Get the parent list item\n var li = items.nav.closest(\"li\");\n if (!li) return;\n\n // Add the active class to the nav and content\n li.classList.add(settings.navClass);\n items.content.classList.add(settings.contentClass);\n\n // Activate any parent navs in a nested navigation\n activateNested(li, settings);\n\n // Emit a custom event\n emitEvent(\"gumshoeActivate\", li, {\n link: items.nav,\n content: items.content,\n settings: settings,\n });\n };\n\n /**\n * Create the Constructor object\n * @param {String} selector The selector to use for navigation items\n * @param {Object} options User options and settings\n */\n var Constructor = function (selector, options) {\n //\n // Variables\n //\n\n var publicAPIs = {};\n var navItems, contents, current, timeout, settings;\n\n //\n // Methods\n //\n\n /**\n * Set variables from DOM elements\n */\n publicAPIs.setup = function () {\n // Get all nav items\n navItems = document.querySelectorAll(selector);\n\n // Create contents array\n contents = [];\n\n // Loop through each item, get it's matching content, and push to the array\n Array.prototype.forEach.call(navItems, function (item) {\n // Get the content for the nav item\n var content = document.getElementById(\n decodeURIComponent(item.hash.substr(1)),\n );\n if (!content) return;\n\n // Push to the contents array\n contents.push({\n nav: item,\n content: content,\n });\n });\n\n // Sort contents by the order they appear in the DOM\n sortContents(contents);\n };\n\n /**\n * Detect which content is currently active\n */\n publicAPIs.detect = function () {\n // Get the active content\n var active = getActive(contents, settings);\n\n // if there's no active content, deactivate and bail\n if (!active) {\n if (current) {\n deactivate(current, settings);\n current = null;\n }\n return;\n }\n\n // If the active content is the one currently active, do nothing\n if (current && active.content === current.content) return;\n\n // Deactivate the current content and activate the new content\n deactivate(current, settings);\n activate(active, settings);\n\n // Update the currently active content\n current = active;\n };\n\n /**\n * Detect the active content on scroll\n * Debounced for performance\n */\n var scrollHandler = function (event) {\n // If there's a timer, cancel it\n if (timeout) {\n window.cancelAnimationFrame(timeout);\n }\n\n // Setup debounce callback\n timeout = window.requestAnimationFrame(publicAPIs.detect);\n };\n\n /**\n * Update content sorting on resize\n * Debounced for performance\n */\n var resizeHandler = function (event) {\n // If there's a timer, cancel it\n if (timeout) {\n window.cancelAnimationFrame(timeout);\n }\n\n // Setup debounce callback\n timeout = window.requestAnimationFrame(function () {\n sortContents(contents);\n publicAPIs.detect();\n });\n };\n\n /**\n * Destroy the current instantiation\n */\n publicAPIs.destroy = function () {\n // Undo DOM changes\n if (current) {\n deactivate(current, settings);\n }\n\n // Remove event listeners\n window.removeEventListener(\"scroll\", scrollHandler, false);\n if (settings.reflow) {\n window.removeEventListener(\"resize\", resizeHandler, false);\n }\n\n // Reset variables\n contents = null;\n navItems = null;\n current = null;\n timeout = null;\n settings = null;\n };\n\n /**\n * Initialize the current instantiation\n */\n var init = function () {\n // Merge user options into defaults\n settings = extend(defaults, options || {});\n\n // Setup variables based on the current DOM\n publicAPIs.setup();\n\n // Find the currently active content\n publicAPIs.detect();\n\n // Setup event listeners\n window.addEventListener(\"scroll\", scrollHandler, false);\n if (settings.reflow) {\n window.addEventListener(\"resize\", resizeHandler, false);\n }\n };\n\n //\n // Initialize and return the public APIs\n //\n\n init();\n return publicAPIs;\n };\n\n //\n // Return the Constructor\n //\n\n return Constructor;\n },\n);\n","// The module cache\nvar __webpack_module_cache__ = {};\n\n// The require function\nfunction __webpack_require__(moduleId) {\n\t// Check if module is in cache\n\tvar cachedModule = __webpack_module_cache__[moduleId];\n\tif (cachedModule !== undefined) {\n\t\treturn cachedModule.exports;\n\t}\n\t// Create a new module (and put it into the cache)\n\tvar module = __webpack_module_cache__[moduleId] = {\n\t\t// no module.id needed\n\t\t// no module.loaded needed\n\t\texports: {}\n\t};\n\n\t// Execute the module function\n\t__webpack_modules__[moduleId].call(module.exports, module, module.exports, __webpack_require__);\n\n\t// Return the exports of the module\n\treturn module.exports;\n}\n\n","// getDefaultExport function for compatibility with non-harmony modules\n__webpack_require__.n = (module) => {\n\tvar getter = module && module.__esModule ?\n\t\t() => (module['default']) :\n\t\t() => (module);\n\t__webpack_require__.d(getter, { a: getter });\n\treturn getter;\n};","// define getter functions for harmony exports\n__webpack_require__.d = (exports, definition) => {\n\tfor(var key in definition) {\n\t\tif(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {\n\t\t\tObject.defineProperty(exports, key, { enumerable: true, get: definition[key] });\n\t\t}\n\t}\n};","__webpack_require__.g = (function() {\n\tif (typeof globalThis === 'object') return globalThis;\n\ttry {\n\t\treturn this || new Function('return this')();\n\t} catch (e) {\n\t\tif (typeof window === 'object') return window;\n\t}\n})();","__webpack_require__.o = (obj, prop) => (Object.prototype.hasOwnProperty.call(obj, prop))","import Gumshoe from \"./gumshoe-patched.js\";\n\n////////////////////////////////////////////////////////////////////////////////\n// Scroll Handling\n////////////////////////////////////////////////////////////////////////////////\nvar tocScroll = null;\nvar header = null;\nvar lastScrollTop = window.pageYOffset || document.documentElement.scrollTop;\nconst GO_TO_TOP_OFFSET = 64;\n\nfunction scrollHandlerForHeader() {\n if (Math.floor(header.getBoundingClientRect().top) == 0) {\n header.classList.add(\"scrolled\");\n } else {\n header.classList.remove(\"scrolled\");\n }\n}\n\nfunction scrollHandlerForBackToTop(positionY) {\n if (positionY < GO_TO_TOP_OFFSET) {\n document.documentElement.classList.remove(\"show-back-to-top\");\n } else {\n if (positionY < lastScrollTop) {\n document.documentElement.classList.add(\"show-back-to-top\");\n } else if (positionY > lastScrollTop) {\n document.documentElement.classList.remove(\"show-back-to-top\");\n }\n }\n lastScrollTop = positionY;\n}\n\nfunction scrollHandlerForTOC(positionY) {\n if (tocScroll === null) {\n return;\n }\n\n // top of page.\n if (positionY == 0) {\n tocScroll.scrollTo(0, 0);\n } else if (\n // bottom of page.\n Math.ceil(positionY) >=\n Math.floor(document.documentElement.scrollHeight - window.innerHeight)\n ) {\n tocScroll.scrollTo(0, tocScroll.scrollHeight);\n } else {\n // somewhere in the middle.\n const current = document.querySelector(\".scroll-current\");\n if (current == null) {\n return;\n }\n\n // https://github.com/pypa/pip/issues/9159 This breaks scroll behaviours.\n // // scroll the currently \"active\" heading in toc, into view.\n // const rect = current.getBoundingClientRect();\n // if (0 > rect.top) {\n // current.scrollIntoView(true); // the argument is \"alignTop\"\n // } else if (rect.bottom > window.innerHeight) {\n // current.scrollIntoView(false);\n // }\n }\n}\n\nfunction scrollHandler(positionY) {\n scrollHandlerForHeader();\n scrollHandlerForBackToTop(positionY);\n scrollHandlerForTOC(positionY);\n}\n\n////////////////////////////////////////////////////////////////////////////////\n// Theme Toggle\n////////////////////////////////////////////////////////////////////////////////\nfunction setTheme(mode) {\n if (mode !== \"light\" && mode !== \"dark\" && mode !== \"auto\") {\n console.error(`Got invalid theme mode: ${mode}. Resetting to auto.`);\n mode = \"auto\";\n }\n\n document.body.dataset.theme = mode;\n localStorage.setItem(\"theme\", mode);\n console.log(`Changed to ${mode} mode.`);\n}\n\nfunction cycleThemeOnce() {\n const currentTheme = localStorage.getItem(\"theme\") || \"auto\";\n const prefersDark = window.matchMedia(\"(prefers-color-scheme: dark)\").matches;\n\n if (prefersDark) {\n // Auto (dark) -> Light -> Dark\n if (currentTheme === \"auto\") {\n setTheme(\"light\");\n } else if (currentTheme == \"light\") {\n setTheme(\"dark\");\n } else {\n setTheme(\"auto\");\n }\n } else {\n // Auto (light) -> Dark -> Light\n if (currentTheme === \"auto\") {\n setTheme(\"dark\");\n } else if (currentTheme == \"dark\") {\n setTheme(\"light\");\n } else {\n setTheme(\"auto\");\n }\n }\n}\n\n////////////////////////////////////////////////////////////////////////////////\n// Setup\n////////////////////////////////////////////////////////////////////////////////\nfunction setupScrollHandler() {\n // Taken from https://developer.mozilla.org/en-US/docs/Web/API/Document/scroll_event\n let last_known_scroll_position = 0;\n let ticking = false;\n\n window.addEventListener(\"scroll\", function (e) {\n last_known_scroll_position = window.scrollY;\n\n if (!ticking) {\n window.requestAnimationFrame(function () {\n scrollHandler(last_known_scroll_position);\n ticking = false;\n });\n\n ticking = true;\n }\n });\n window.scroll();\n}\n\nfunction setupScrollSpy() {\n if (tocScroll === null) {\n return;\n }\n\n // Scrollspy -- highlight table on contents, based on scroll\n new Gumshoe(\".toc-tree a\", {\n reflow: true,\n recursive: true,\n navClass: \"scroll-current\",\n offset: () => {\n let rem = parseFloat(getComputedStyle(document.documentElement).fontSize);\n return header.getBoundingClientRect().height + 2.5 * rem + 1;\n },\n });\n}\n\nfunction setupTheme() {\n // Attach event handlers for toggling themes\n const buttons = document.getElementsByClassName(\"theme-toggle\");\n Array.from(buttons).forEach((btn) => {\n btn.addEventListener(\"click\", cycleThemeOnce);\n });\n}\n\nfunction setup() {\n setupTheme();\n setupScrollHandler();\n setupScrollSpy();\n}\n\n////////////////////////////////////////////////////////////////////////////////\n// Main entrypoint\n////////////////////////////////////////////////////////////////////////////////\nfunction main() {\n document.body.parentNode.classList.remove(\"no-js\");\n\n header = document.querySelector(\"header\");\n tocScroll = document.querySelector(\".toc-scroll\");\n\n setup();\n}\n\ndocument.addEventListener(\"DOMContentLoaded\", main);\n"],"names":["root","g","window","this","defaults","navClass","contentClass","nested","nestedClass","offset","reflow","events","emitEvent","type","elem","detail","settings","event","CustomEvent","bubbles","cancelable","dispatchEvent","getOffsetTop","location","offsetParent","offsetTop","sortContents","contents","sort","item1","item2","content","isInView","bottom","bounds","getBoundingClientRect","parseFloat","getOffset","parseInt","innerHeight","document","documentElement","clientHeight","top","isAtBottom","Math","ceil","pageYOffset","max","body","scrollHeight","offsetHeight","getActive","last","length","item","useLastItem","i","deactivateNested","nav","parentNode","li","closest","classList","remove","deactivate","items","link","activateNested","add","selector","options","navItems","current","timeout","publicAPIs","querySelectorAll","Array","prototype","forEach","call","getElementById","decodeURIComponent","hash","substr","push","active","activate","scrollHandler","cancelAnimationFrame","requestAnimationFrame","detect","resizeHandler","destroy","removeEventListener","merged","arguments","obj","key","hasOwnProperty","extend","setup","addEventListener","factory","__webpack_module_cache__","__webpack_require__","moduleId","cachedModule","undefined","exports","module","__webpack_modules__","n","getter","__esModule","d","a","definition","o","Object","defineProperty","enumerable","get","globalThis","Function","e","prop","tocScroll","header","lastScrollTop","scrollTop","GO_TO_TOP_OFFSET","cycleThemeOnce","currentTheme","localStorage","getItem","mode","matchMedia","matches","console","error","dataset","theme","setItem","log","buttons","getElementsByClassName","from","btn","setupTheme","last_known_scroll_position","ticking","scrollY","positionY","floor","scrollHandlerForBackToTop","scrollTo","querySelector","scrollHandlerForTOC","scroll","setupScrollHandler","recursive","rem","getComputedStyle","fontSize","height"],"sourceRoot":""} \ No newline at end of file +{"version":3,"file":"scripts/furo.js","mappings":";iCAAA,MAQWA,SAWS,IAAX,EAAAC,EACH,EAAAA,EACkB,oBAAXC,OACLA,OACAC,KAbO,EAAF,WACP,OAaJ,SAAUD,GACR,aAMA,IAAIE,EAAW,CAEbC,SAAU,SACVC,aAAc,SAGdC,QAAQ,EACRC,YAAa,SAGbC,OAAQ,EACRC,QAAQ,EAGRC,QAAQ,GA6BNC,EAAY,SAAUC,EAAMC,EAAMC,GAEpC,GAAKA,EAAOC,SAASL,OAArB,CAGA,IAAIM,EAAQ,IAAIC,YAAYL,EAAM,CAChCM,SAAS,EACTC,YAAY,EACZL,OAAQA,IAIVD,EAAKO,cAAcJ,EAVgB,CAWrC,EAOIK,EAAe,SAAUR,GAC3B,IAAIS,EAAW,EACf,GAAIT,EAAKU,aACP,KAAOV,GACLS,GAAYT,EAAKW,UACjBX,EAAOA,EAAKU,aAGhB,OAAOD,GAAY,EAAIA,EAAW,CACpC,EAMIG,EAAe,SAAUC,GACvBA,GACFA,EAASC,MAAK,SAAUC,EAAOC,GAG7B,OAFcR,EAAaO,EAAME,SACnBT,EAAaQ,EAAMC,UACF,EACxB,CACT,GAEJ,EAwCIC,EAAW,SAAUlB,EAAME,EAAUiB,GACvC,IAAIC,EAASpB,EAAKqB,wBACd1B,EAnCU,SAAUO,GAExB,MAA+B,mBAApBA,EAASP,OACX2B,WAAWpB,EAASP,UAItB2B,WAAWpB,EAASP,OAC7B,CA2Be4B,CAAUrB,GACvB,OAAIiB,EAEAK,SAASJ,EAAOD,OAAQ,KACvB/B,EAAOqC,aAAeC,SAASC,gBAAgBC,cAG7CJ,SAASJ,EAAOS,IAAK,KAAOlC,CACrC,EAMImC,EAAa,WACf,OACEC,KAAKC,KAAK5C,EAAOqC,YAAcrC,EAAO6C,cAnCjCF,KAAKG,IACVR,SAASS,KAAKC,aACdV,SAASC,gBAAgBS,aACzBV,SAASS,KAAKE,aACdX,SAASC,gBAAgBU,aACzBX,SAASS,KAAKP,aACdF,SAASC,gBAAgBC,aAkC7B,EAmBIU,EAAY,SAAUzB,EAAUX,GAClC,IAAIqC,EAAO1B,EAASA,EAAS2B,OAAS,GACtC,GAbgB,SAAUC,EAAMvC,GAChC,SAAI4B,MAAgBZ,EAASuB,EAAKxB,QAASf,GAAU,GAEvD,CAUMwC,CAAYH,EAAMrC,GAAW,OAAOqC,EACxC,IAAK,IAAII,EAAI9B,EAAS2B,OAAS,EAAGG,GAAK,EAAGA,IACxC,GAAIzB,EAASL,EAAS8B,GAAG1B,QAASf,GAAW,OAAOW,EAAS8B,EAEjE,EAOIC,EAAmB,SAAUC,EAAK3C,GAEpC,GAAKA,EAAST,QAAWoD,EAAIC,WAA7B,CAGA,IAAIC,EAAKF,EAAIC,WAAWE,QAAQ,MAC3BD,IAGLA,EAAGE,UAAUC,OAAOhD,EAASR,aAG7BkD,EAAiBG,EAAI7C,GAV0B,CAWjD,EAOIiD,EAAa,SAAUC,EAAOlD,GAEhC,GAAKkD,EAAL,CAGA,IAAIL,EAAKK,EAAMP,IAAIG,QAAQ,MACtBD,IAGLA,EAAGE,UAAUC,OAAOhD,EAASX,UAC7B6D,EAAMnC,QAAQgC,UAAUC,OAAOhD,EAASV,cAGxCoD,EAAiBG,EAAI7C,GAGrBJ,EAAU,oBAAqBiD,EAAI,CACjCM,KAAMD,EAAMP,IACZ5B,QAASmC,EAAMnC,QACff,SAAUA,IAjBM,CAmBpB,EAOIoD,EAAiB,SAAUT,EAAK3C,GAElC,GAAKA,EAAST,OAAd,CAGA,IAAIsD,EAAKF,EAAIC,WAAWE,QAAQ,MAC3BD,IAGLA,EAAGE,UAAUM,IAAIrD,EAASR,aAG1B4D,EAAeP,EAAI7C,GAVS,CAW9B,EA6LA,OA1JkB,SAAUsD,EAAUC,GAKpC,IACIC,EAAU7C,EAAU8C,EAASC,EAAS1D,EADtC2D,EAAa,CAUjBA,MAAmB,WAEjBH,EAAWhC,SAASoC,iBAAiBN,GAGrC3C,EAAW,GAGXkD,MAAMC,UAAUC,QAAQC,KAAKR,GAAU,SAAUjB,GAE/C,IAAIxB,EAAUS,SAASyC,eACrBC,mBAAmB3B,EAAK4B,KAAKC,OAAO,KAEjCrD,GAGLJ,EAAS0D,KAAK,CACZ1B,IAAKJ,EACLxB,QAASA,GAEb,IAGAL,EAAaC,EACf,EAKAgD,OAAoB,WAElB,IAAIW,EAASlC,EAAUzB,EAAUX,GAG5BsE,EASDb,GAAWa,EAAOvD,UAAY0C,EAAQ1C,UAG1CkC,EAAWQ,EAASzD,GAzFT,SAAUkD,EAAOlD,GAE9B,GAAKkD,EAAL,CAGA,IAAIL,EAAKK,EAAMP,IAAIG,QAAQ,MACtBD,IAGLA,EAAGE,UAAUM,IAAIrD,EAASX,UAC1B6D,EAAMnC,QAAQgC,UAAUM,IAAIrD,EAASV,cAGrC8D,EAAeP,EAAI7C,GAGnBJ,EAAU,kBAAmBiD,EAAI,CAC/BM,KAAMD,EAAMP,IACZ5B,QAASmC,EAAMnC,QACff,SAAUA,IAjBM,CAmBpB,CAqEIuE,CAASD,EAAQtE,GAGjByD,EAAUa,GAfJb,IACFR,EAAWQ,EAASzD,GACpByD,EAAU,KAchB,GAMIe,EAAgB,SAAUvE,GAExByD,GACFxE,EAAOuF,qBAAqBf,GAI9BA,EAAUxE,EAAOwF,sBAAsBf,EAAWgB,OACpD,EAMIC,EAAgB,SAAU3E,GAExByD,GACFxE,EAAOuF,qBAAqBf,GAI9BA,EAAUxE,EAAOwF,uBAAsB,WACrChE,EAAaC,GACbgD,EAAWgB,QACb,GACF,EAkDA,OA7CAhB,EAAWkB,QAAU,WAEfpB,GACFR,EAAWQ,EAASzD,GAItBd,EAAO4F,oBAAoB,SAAUN,GAAe,GAChDxE,EAASN,QACXR,EAAO4F,oBAAoB,SAAUF,GAAe,GAItDjE,EAAW,KACX6C,EAAW,KACXC,EAAU,KACVC,EAAU,KACV1D,EAAW,IACb,EAOEA,EA3XS,WACX,IAAI+E,EAAS,CAAC,EAOd,OANAlB,MAAMC,UAAUC,QAAQC,KAAKgB,WAAW,SAAUC,GAChD,IAAK,IAAIC,KAAOD,EAAK,CACnB,IAAKA,EAAIE,eAAeD,GAAM,OAC9BH,EAAOG,GAAOD,EAAIC,EACpB,CACF,IACOH,CACT,CAkXeK,CAAOhG,EAAUmE,GAAW,CAAC,GAGxCI,EAAW0B,QAGX1B,EAAWgB,SAGXzF,EAAOoG,iBAAiB,SAAUd,GAAe,GAC7CxE,EAASN,QACXR,EAAOoG,iBAAiB,SAAUV,GAAe,GAS9CjB,CACT,CAOF,CArcW4B,CAAQvG,EAChB,UAFM,SAEN,uBCXDwG,EAA2B,CAAC,EAGhC,SAASC,EAAoBC,GAE5B,IAAIC,EAAeH,EAAyBE,GAC5C,QAAqBE,IAAjBD,EACH,OAAOA,EAAaE,QAGrB,IAAIC,EAASN,EAAyBE,GAAY,CAGjDG,QAAS,CAAC,GAOX,OAHAE,EAAoBL,GAAU1B,KAAK8B,EAAOD,QAASC,EAAQA,EAAOD,QAASJ,GAGpEK,EAAOD,OACf,CCrBAJ,EAAoBO,EAAKF,IACxB,IAAIG,EAASH,GAAUA,EAAOI,WAC7B,IAAOJ,EAAiB,QACxB,IAAM,EAEP,OADAL,EAAoBU,EAAEF,EAAQ,CAAEG,EAAGH,IAC5BA,CAAM,ECLdR,EAAoBU,EAAI,CAACN,EAASQ,KACjC,IAAI,IAAInB,KAAOmB,EACXZ,EAAoBa,EAAED,EAAYnB,KAASO,EAAoBa,EAAET,EAASX,IAC5EqB,OAAOC,eAAeX,EAASX,EAAK,CAAEuB,YAAY,EAAMC,IAAKL,EAAWnB,IAE1E,ECNDO,EAAoBxG,EAAI,WACvB,GAA0B,iBAAf0H,WAAyB,OAAOA,WAC3C,IACC,OAAOxH,MAAQ,IAAIyH,SAAS,cAAb,EAChB,CAAE,MAAOC,GACR,GAAsB,iBAAX3H,OAAqB,OAAOA,MACxC,CACA,CAPuB,GCAxBuG,EAAoBa,EAAI,CAACrB,EAAK6B,IAAUP,OAAOzC,UAAUqB,eAAenB,KAAKiB,EAAK6B,4CCK9EC,EAAY,KACZC,EAAS,KACTC,EAAgBzF,SAASC,gBAAgByF,UAC7C,MAAMC,EAAmB,GA8EzB,SAASC,IACP,MAAMC,EAAeC,aAAaC,QAAQ,UAAY,OAZxD,IAAkBC,EACH,WADGA,EAaItI,OAAOuI,WAAW,gCAAgCC,QAI/C,SAAjBL,EACO,QACgB,SAAhBA,EACA,OAEA,OAIU,SAAjBA,EACO,OACgB,QAAhBA,EACA,QAEA,SA9BoB,SAATG,GAA4B,SAATA,IACzCG,QAAQC,MAAM,2BAA2BJ,yBACzCA,EAAO,QAGThG,SAASS,KAAK4F,QAAQC,MAAQN,EAC9BF,aAAaS,QAAQ,QAASP,GAC9BG,QAAQK,IAAI,cAAcR,UA0B5B,CAkDA,SAASnC,KART,WAEE,MAAM4C,EAAUzG,SAAS0G,uBAAuB,gBAChDrE,MAAMsE,KAAKF,GAASlE,SAASqE,IAC3BA,EAAI9C,iBAAiB,QAAS8B,EAAe,GAEjD,CAGEiB,GA9CF,WAEE,IAAIC,EAA6B,EAC7BC,GAAU,EAEdrJ,OAAOoG,iBAAiB,UAAU,SAAUuB,GAC1CyB,EAA6BpJ,OAAOsJ,QAE/BD,IACHrJ,OAAOwF,uBAAsB,WAzDnC,IAAuB+D,GAxDvB,SAAgCA,GAC9B,MAAMC,EAAY7G,KAAK8G,MAAM3B,EAAO7F,wBAAwBQ,KAE5DgG,QAAQK,IAAI,cAAcU,KACT,GAAbA,GAAkBD,GAAaC,EACjC1B,EAAOjE,UAAUM,IAAI,YAErB2D,EAAOjE,UAAUC,OAAO,WAE5B,EAgDE4F,CADqBH,EA0DDH,GAvGtB,SAAmCG,GAC7BA,EAAYtB,EACd3F,SAASC,gBAAgBsB,UAAUC,OAAO,oBAEtCyF,EAAYxB,EACdzF,SAASC,gBAAgBsB,UAAUM,IAAI,oBAC9BoF,EAAYxB,GACrBzF,SAASC,gBAAgBsB,UAAUC,OAAO,oBAG9CiE,EAAgBwB,CAClB,CAoCEI,CAA0BJ,GAlC5B,SAA6BA,GACT,OAAd1B,IAKa,GAAb0B,EACF1B,EAAU+B,SAAS,EAAG,GAGtBjH,KAAKC,KAAK2G,IACV5G,KAAK8G,MAAMnH,SAASC,gBAAgBS,aAAehD,OAAOqC,aAE1DwF,EAAU+B,SAAS,EAAG/B,EAAU7E,cAGhBV,SAASuH,cAAc,mBAc3C,CAKEC,CAAoBP,GAwDdF,GAAU,CACZ,IAEAA,GAAU,EAEd,IACArJ,OAAO+J,QACT,CA6BEC,GA1BkB,OAAdnC,GAKJ,IAAI,IAAJ,CAAY,cAAe,CACzBrH,QAAQ,EACRyJ,WAAW,EACX9J,SAAU,iBACVI,OAAQ,KACN,IAAI2J,EAAMhI,WAAWiI,iBAAiB7H,SAASC,iBAAiB6H,UAChE,OAAOtC,EAAO7F,wBAAwBoI,OAAS,IAAMH,EAAM,CAAC,GAiBlE,CAcA5H,SAAS8D,iBAAiB,oBAT1B,WACE9D,SAASS,KAAKW,WAAWG,UAAUC,OAAO,SAE1CgE,EAASxF,SAASuH,cAAc,UAChChC,EAAYvF,SAASuH,cAAc,eAEnC1D,GACF","sources":["webpack:///./src/furo/assets/scripts/gumshoe-patched.js","webpack:///webpack/bootstrap","webpack:///webpack/runtime/compat get default export","webpack:///webpack/runtime/define property getters","webpack:///webpack/runtime/global","webpack:///webpack/runtime/hasOwnProperty shorthand","webpack:///./src/furo/assets/scripts/furo.js"],"sourcesContent":["/*!\n * gumshoejs v5.1.2 (patched by @pradyunsg)\n * A simple, framework-agnostic scrollspy script.\n * (c) 2019 Chris Ferdinandi\n * MIT License\n * http://github.com/cferdinandi/gumshoe\n */\n\n(function (root, factory) {\n if (typeof define === \"function\" && define.amd) {\n define([], function () {\n return factory(root);\n });\n } else if (typeof exports === \"object\") {\n module.exports = factory(root);\n } else {\n root.Gumshoe = factory(root);\n }\n})(\n typeof global !== \"undefined\"\n ? global\n : typeof window !== \"undefined\"\n ? window\n : this,\n function (window) {\n \"use strict\";\n\n //\n // Defaults\n //\n\n var defaults = {\n // Active classes\n navClass: \"active\",\n contentClass: \"active\",\n\n // Nested navigation\n nested: false,\n nestedClass: \"active\",\n\n // Offset & reflow\n offset: 0,\n reflow: false,\n\n // Event support\n events: true,\n };\n\n //\n // Methods\n //\n\n /**\n * Merge two or more objects together.\n * @param {Object} objects The objects to merge together\n * @returns {Object} Merged values of defaults and options\n */\n var extend = function () {\n var merged = {};\n Array.prototype.forEach.call(arguments, function (obj) {\n for (var key in obj) {\n if (!obj.hasOwnProperty(key)) return;\n merged[key] = obj[key];\n }\n });\n return merged;\n };\n\n /**\n * Emit a custom event\n * @param {String} type The event type\n * @param {Node} elem The element to attach the event to\n * @param {Object} detail Any details to pass along with the event\n */\n var emitEvent = function (type, elem, detail) {\n // Make sure events are enabled\n if (!detail.settings.events) return;\n\n // Create a new event\n var event = new CustomEvent(type, {\n bubbles: true,\n cancelable: true,\n detail: detail,\n });\n\n // Dispatch the event\n elem.dispatchEvent(event);\n };\n\n /**\n * Get an element's distance from the top of the Document.\n * @param {Node} elem The element\n * @return {Number} Distance from the top in pixels\n */\n var getOffsetTop = function (elem) {\n var location = 0;\n if (elem.offsetParent) {\n while (elem) {\n location += elem.offsetTop;\n elem = elem.offsetParent;\n }\n }\n return location >= 0 ? location : 0;\n };\n\n /**\n * Sort content from first to last in the DOM\n * @param {Array} contents The content areas\n */\n var sortContents = function (contents) {\n if (contents) {\n contents.sort(function (item1, item2) {\n var offset1 = getOffsetTop(item1.content);\n var offset2 = getOffsetTop(item2.content);\n if (offset1 < offset2) return -1;\n return 1;\n });\n }\n };\n\n /**\n * Get the offset to use for calculating position\n * @param {Object} settings The settings for this instantiation\n * @return {Float} The number of pixels to offset the calculations\n */\n var getOffset = function (settings) {\n // if the offset is a function run it\n if (typeof settings.offset === \"function\") {\n return parseFloat(settings.offset());\n }\n\n // Otherwise, return it as-is\n return parseFloat(settings.offset);\n };\n\n /**\n * Get the document element's height\n * @private\n * @returns {Number}\n */\n var getDocumentHeight = function () {\n return Math.max(\n document.body.scrollHeight,\n document.documentElement.scrollHeight,\n document.body.offsetHeight,\n document.documentElement.offsetHeight,\n document.body.clientHeight,\n document.documentElement.clientHeight,\n );\n };\n\n /**\n * Determine if an element is in view\n * @param {Node} elem The element\n * @param {Object} settings The settings for this instantiation\n * @param {Boolean} bottom If true, check if element is above bottom of viewport instead\n * @return {Boolean} Returns true if element is in the viewport\n */\n var isInView = function (elem, settings, bottom) {\n var bounds = elem.getBoundingClientRect();\n var offset = getOffset(settings);\n if (bottom) {\n return (\n parseInt(bounds.bottom, 10) <\n (window.innerHeight || document.documentElement.clientHeight)\n );\n }\n return parseInt(bounds.top, 10) <= offset;\n };\n\n /**\n * Check if at the bottom of the viewport\n * @return {Boolean} If true, page is at the bottom of the viewport\n */\n var isAtBottom = function () {\n if (\n Math.ceil(window.innerHeight + window.pageYOffset) >=\n getDocumentHeight()\n )\n return true;\n return false;\n };\n\n /**\n * Check if the last item should be used (even if not at the top of the page)\n * @param {Object} item The last item\n * @param {Object} settings The settings for this instantiation\n * @return {Boolean} If true, use the last item\n */\n var useLastItem = function (item, settings) {\n if (isAtBottom() && isInView(item.content, settings, true)) return true;\n return false;\n };\n\n /**\n * Get the active content\n * @param {Array} contents The content areas\n * @param {Object} settings The settings for this instantiation\n * @return {Object} The content area and matching navigation link\n */\n var getActive = function (contents, settings) {\n var last = contents[contents.length - 1];\n if (useLastItem(last, settings)) return last;\n for (var i = contents.length - 1; i >= 0; i--) {\n if (isInView(contents[i].content, settings)) return contents[i];\n }\n };\n\n /**\n * Deactivate parent navs in a nested navigation\n * @param {Node} nav The starting navigation element\n * @param {Object} settings The settings for this instantiation\n */\n var deactivateNested = function (nav, settings) {\n // If nesting isn't activated, bail\n if (!settings.nested || !nav.parentNode) return;\n\n // Get the parent navigation\n var li = nav.parentNode.closest(\"li\");\n if (!li) return;\n\n // Remove the active class\n li.classList.remove(settings.nestedClass);\n\n // Apply recursively to any parent navigation elements\n deactivateNested(li, settings);\n };\n\n /**\n * Deactivate a nav and content area\n * @param {Object} items The nav item and content to deactivate\n * @param {Object} settings The settings for this instantiation\n */\n var deactivate = function (items, settings) {\n // Make sure there are items to deactivate\n if (!items) return;\n\n // Get the parent list item\n var li = items.nav.closest(\"li\");\n if (!li) return;\n\n // Remove the active class from the nav and content\n li.classList.remove(settings.navClass);\n items.content.classList.remove(settings.contentClass);\n\n // Deactivate any parent navs in a nested navigation\n deactivateNested(li, settings);\n\n // Emit a custom event\n emitEvent(\"gumshoeDeactivate\", li, {\n link: items.nav,\n content: items.content,\n settings: settings,\n });\n };\n\n /**\n * Activate parent navs in a nested navigation\n * @param {Node} nav The starting navigation element\n * @param {Object} settings The settings for this instantiation\n */\n var activateNested = function (nav, settings) {\n // If nesting isn't activated, bail\n if (!settings.nested) return;\n\n // Get the parent navigation\n var li = nav.parentNode.closest(\"li\");\n if (!li) return;\n\n // Add the active class\n li.classList.add(settings.nestedClass);\n\n // Apply recursively to any parent navigation elements\n activateNested(li, settings);\n };\n\n /**\n * Activate a nav and content area\n * @param {Object} items The nav item and content to activate\n * @param {Object} settings The settings for this instantiation\n */\n var activate = function (items, settings) {\n // Make sure there are items to activate\n if (!items) return;\n\n // Get the parent list item\n var li = items.nav.closest(\"li\");\n if (!li) return;\n\n // Add the active class to the nav and content\n li.classList.add(settings.navClass);\n items.content.classList.add(settings.contentClass);\n\n // Activate any parent navs in a nested navigation\n activateNested(li, settings);\n\n // Emit a custom event\n emitEvent(\"gumshoeActivate\", li, {\n link: items.nav,\n content: items.content,\n settings: settings,\n });\n };\n\n /**\n * Create the Constructor object\n * @param {String} selector The selector to use for navigation items\n * @param {Object} options User options and settings\n */\n var Constructor = function (selector, options) {\n //\n // Variables\n //\n\n var publicAPIs = {};\n var navItems, contents, current, timeout, settings;\n\n //\n // Methods\n //\n\n /**\n * Set variables from DOM elements\n */\n publicAPIs.setup = function () {\n // Get all nav items\n navItems = document.querySelectorAll(selector);\n\n // Create contents array\n contents = [];\n\n // Loop through each item, get it's matching content, and push to the array\n Array.prototype.forEach.call(navItems, function (item) {\n // Get the content for the nav item\n var content = document.getElementById(\n decodeURIComponent(item.hash.substr(1)),\n );\n if (!content) return;\n\n // Push to the contents array\n contents.push({\n nav: item,\n content: content,\n });\n });\n\n // Sort contents by the order they appear in the DOM\n sortContents(contents);\n };\n\n /**\n * Detect which content is currently active\n */\n publicAPIs.detect = function () {\n // Get the active content\n var active = getActive(contents, settings);\n\n // if there's no active content, deactivate and bail\n if (!active) {\n if (current) {\n deactivate(current, settings);\n current = null;\n }\n return;\n }\n\n // If the active content is the one currently active, do nothing\n if (current && active.content === current.content) return;\n\n // Deactivate the current content and activate the new content\n deactivate(current, settings);\n activate(active, settings);\n\n // Update the currently active content\n current = active;\n };\n\n /**\n * Detect the active content on scroll\n * Debounced for performance\n */\n var scrollHandler = function (event) {\n // If there's a timer, cancel it\n if (timeout) {\n window.cancelAnimationFrame(timeout);\n }\n\n // Setup debounce callback\n timeout = window.requestAnimationFrame(publicAPIs.detect);\n };\n\n /**\n * Update content sorting on resize\n * Debounced for performance\n */\n var resizeHandler = function (event) {\n // If there's a timer, cancel it\n if (timeout) {\n window.cancelAnimationFrame(timeout);\n }\n\n // Setup debounce callback\n timeout = window.requestAnimationFrame(function () {\n sortContents(contents);\n publicAPIs.detect();\n });\n };\n\n /**\n * Destroy the current instantiation\n */\n publicAPIs.destroy = function () {\n // Undo DOM changes\n if (current) {\n deactivate(current, settings);\n }\n\n // Remove event listeners\n window.removeEventListener(\"scroll\", scrollHandler, false);\n if (settings.reflow) {\n window.removeEventListener(\"resize\", resizeHandler, false);\n }\n\n // Reset variables\n contents = null;\n navItems = null;\n current = null;\n timeout = null;\n settings = null;\n };\n\n /**\n * Initialize the current instantiation\n */\n var init = function () {\n // Merge user options into defaults\n settings = extend(defaults, options || {});\n\n // Setup variables based on the current DOM\n publicAPIs.setup();\n\n // Find the currently active content\n publicAPIs.detect();\n\n // Setup event listeners\n window.addEventListener(\"scroll\", scrollHandler, false);\n if (settings.reflow) {\n window.addEventListener(\"resize\", resizeHandler, false);\n }\n };\n\n //\n // Initialize and return the public APIs\n //\n\n init();\n return publicAPIs;\n };\n\n //\n // Return the Constructor\n //\n\n return Constructor;\n },\n);\n","// The module cache\nvar __webpack_module_cache__ = {};\n\n// The require function\nfunction __webpack_require__(moduleId) {\n\t// Check if module is in cache\n\tvar cachedModule = __webpack_module_cache__[moduleId];\n\tif (cachedModule !== undefined) {\n\t\treturn cachedModule.exports;\n\t}\n\t// Create a new module (and put it into the cache)\n\tvar module = __webpack_module_cache__[moduleId] = {\n\t\t// no module.id needed\n\t\t// no module.loaded needed\n\t\texports: {}\n\t};\n\n\t// Execute the module function\n\t__webpack_modules__[moduleId].call(module.exports, module, module.exports, __webpack_require__);\n\n\t// Return the exports of the module\n\treturn module.exports;\n}\n\n","// getDefaultExport function for compatibility with non-harmony modules\n__webpack_require__.n = (module) => {\n\tvar getter = module && module.__esModule ?\n\t\t() => (module['default']) :\n\t\t() => (module);\n\t__webpack_require__.d(getter, { a: getter });\n\treturn getter;\n};","// define getter functions for harmony exports\n__webpack_require__.d = (exports, definition) => {\n\tfor(var key in definition) {\n\t\tif(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {\n\t\t\tObject.defineProperty(exports, key, { enumerable: true, get: definition[key] });\n\t\t}\n\t}\n};","__webpack_require__.g = (function() {\n\tif (typeof globalThis === 'object') return globalThis;\n\ttry {\n\t\treturn this || new Function('return this')();\n\t} catch (e) {\n\t\tif (typeof window === 'object') return window;\n\t}\n})();","__webpack_require__.o = (obj, prop) => (Object.prototype.hasOwnProperty.call(obj, prop))","import Gumshoe from \"./gumshoe-patched.js\";\n\n////////////////////////////////////////////////////////////////////////////////\n// Scroll Handling\n////////////////////////////////////////////////////////////////////////////////\nvar tocScroll = null;\nvar header = null;\nvar lastScrollTop = document.documentElement.scrollTop;\nconst GO_TO_TOP_OFFSET = 64;\n\nfunction scrollHandlerForHeader(positionY) {\n const headerTop = Math.floor(header.getBoundingClientRect().top);\n\n console.log(`headerTop: ${headerTop}`);\n if (headerTop == 0 && positionY != headerTop) {\n header.classList.add(\"scrolled\");\n } else {\n header.classList.remove(\"scrolled\");\n }\n}\n\nfunction scrollHandlerForBackToTop(positionY) {\n if (positionY < GO_TO_TOP_OFFSET) {\n document.documentElement.classList.remove(\"show-back-to-top\");\n } else {\n if (positionY < lastScrollTop) {\n document.documentElement.classList.add(\"show-back-to-top\");\n } else if (positionY > lastScrollTop) {\n document.documentElement.classList.remove(\"show-back-to-top\");\n }\n }\n lastScrollTop = positionY;\n}\n\nfunction scrollHandlerForTOC(positionY) {\n if (tocScroll === null) {\n return;\n }\n\n // top of page.\n if (positionY == 0) {\n tocScroll.scrollTo(0, 0);\n } else if (\n // bottom of page.\n Math.ceil(positionY) >=\n Math.floor(document.documentElement.scrollHeight - window.innerHeight)\n ) {\n tocScroll.scrollTo(0, tocScroll.scrollHeight);\n } else {\n // somewhere in the middle.\n const current = document.querySelector(\".scroll-current\");\n if (current == null) {\n return;\n }\n\n // https://github.com/pypa/pip/issues/9159 This breaks scroll behaviours.\n // // scroll the currently \"active\" heading in toc, into view.\n // const rect = current.getBoundingClientRect();\n // if (0 > rect.top) {\n // current.scrollIntoView(true); // the argument is \"alignTop\"\n // } else if (rect.bottom > window.innerHeight) {\n // current.scrollIntoView(false);\n // }\n }\n}\n\nfunction scrollHandler(positionY) {\n scrollHandlerForHeader(positionY);\n scrollHandlerForBackToTop(positionY);\n scrollHandlerForTOC(positionY);\n}\n\n////////////////////////////////////////////////////////////////////////////////\n// Theme Toggle\n////////////////////////////////////////////////////////////////////////////////\nfunction setTheme(mode) {\n if (mode !== \"light\" && mode !== \"dark\" && mode !== \"auto\") {\n console.error(`Got invalid theme mode: ${mode}. Resetting to auto.`);\n mode = \"auto\";\n }\n\n document.body.dataset.theme = mode;\n localStorage.setItem(\"theme\", mode);\n console.log(`Changed to ${mode} mode.`);\n}\n\nfunction cycleThemeOnce() {\n const currentTheme = localStorage.getItem(\"theme\") || \"auto\";\n const prefersDark = window.matchMedia(\"(prefers-color-scheme: dark)\").matches;\n\n if (prefersDark) {\n // Auto (dark) -> Light -> Dark\n if (currentTheme === \"auto\") {\n setTheme(\"light\");\n } else if (currentTheme == \"light\") {\n setTheme(\"dark\");\n } else {\n setTheme(\"auto\");\n }\n } else {\n // Auto (light) -> Dark -> Light\n if (currentTheme === \"auto\") {\n setTheme(\"dark\");\n } else if (currentTheme == \"dark\") {\n setTheme(\"light\");\n } else {\n setTheme(\"auto\");\n }\n }\n}\n\n////////////////////////////////////////////////////////////////////////////////\n// Setup\n////////////////////////////////////////////////////////////////////////////////\nfunction setupScrollHandler() {\n // Taken from https://developer.mozilla.org/en-US/docs/Web/API/Document/scroll_event\n let last_known_scroll_position = 0;\n let ticking = false;\n\n window.addEventListener(\"scroll\", function (e) {\n last_known_scroll_position = window.scrollY;\n\n if (!ticking) {\n window.requestAnimationFrame(function () {\n scrollHandler(last_known_scroll_position);\n ticking = false;\n });\n\n ticking = true;\n }\n });\n window.scroll();\n}\n\nfunction setupScrollSpy() {\n if (tocScroll === null) {\n return;\n }\n\n // Scrollspy -- highlight table on contents, based on scroll\n new Gumshoe(\".toc-tree a\", {\n reflow: true,\n recursive: true,\n navClass: \"scroll-current\",\n offset: () => {\n let rem = parseFloat(getComputedStyle(document.documentElement).fontSize);\n return header.getBoundingClientRect().height + 2.5 * rem + 1;\n },\n });\n}\n\nfunction setupTheme() {\n // Attach event handlers for toggling themes\n const buttons = document.getElementsByClassName(\"theme-toggle\");\n Array.from(buttons).forEach((btn) => {\n btn.addEventListener(\"click\", cycleThemeOnce);\n });\n}\n\nfunction setup() {\n setupTheme();\n setupScrollHandler();\n setupScrollSpy();\n}\n\n////////////////////////////////////////////////////////////////////////////////\n// Main entrypoint\n////////////////////////////////////////////////////////////////////////////////\nfunction main() {\n document.body.parentNode.classList.remove(\"no-js\");\n\n header = document.querySelector(\"header\");\n tocScroll = document.querySelector(\".toc-scroll\");\n\n setup();\n}\n\ndocument.addEventListener(\"DOMContentLoaded\", main);\n"],"names":["root","g","window","this","defaults","navClass","contentClass","nested","nestedClass","offset","reflow","events","emitEvent","type","elem","detail","settings","event","CustomEvent","bubbles","cancelable","dispatchEvent","getOffsetTop","location","offsetParent","offsetTop","sortContents","contents","sort","item1","item2","content","isInView","bottom","bounds","getBoundingClientRect","parseFloat","getOffset","parseInt","innerHeight","document","documentElement","clientHeight","top","isAtBottom","Math","ceil","pageYOffset","max","body","scrollHeight","offsetHeight","getActive","last","length","item","useLastItem","i","deactivateNested","nav","parentNode","li","closest","classList","remove","deactivate","items","link","activateNested","add","selector","options","navItems","current","timeout","publicAPIs","querySelectorAll","Array","prototype","forEach","call","getElementById","decodeURIComponent","hash","substr","push","active","activate","scrollHandler","cancelAnimationFrame","requestAnimationFrame","detect","resizeHandler","destroy","removeEventListener","merged","arguments","obj","key","hasOwnProperty","extend","setup","addEventListener","factory","__webpack_module_cache__","__webpack_require__","moduleId","cachedModule","undefined","exports","module","__webpack_modules__","n","getter","__esModule","d","a","definition","o","Object","defineProperty","enumerable","get","globalThis","Function","e","prop","tocScroll","header","lastScrollTop","scrollTop","GO_TO_TOP_OFFSET","cycleThemeOnce","currentTheme","localStorage","getItem","mode","matchMedia","matches","console","error","dataset","theme","setItem","log","buttons","getElementsByClassName","from","btn","setupTheme","last_known_scroll_position","ticking","scrollY","positionY","headerTop","floor","scrollHandlerForHeader","scrollHandlerForBackToTop","scrollTo","querySelector","scrollHandlerForTOC","scroll","setupScrollHandler","recursive","rem","getComputedStyle","fontSize","height"],"sourceRoot":""} \ No newline at end of file diff --git a/docs/build/html/_static/styles/furo-extensions.css b/docs/build/html/_static/styles/furo-extensions.css index bc447f2..8229587 100644 --- a/docs/build/html/_static/styles/furo-extensions.css +++ b/docs/build/html/_static/styles/furo-extensions.css @@ -1,2 +1,2 @@ -#furo-sidebar-ad-placement{padding:var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal)}#furo-sidebar-ad-placement .ethical-sidebar{background:var(--color-background-secondary);border:none;box-shadow:none}#furo-sidebar-ad-placement .ethical-sidebar:hover{background:var(--color-background-hover)}#furo-sidebar-ad-placement .ethical-sidebar a{color:var(--color-foreground-primary)}#furo-sidebar-ad-placement .ethical-callout a{color:var(--color-foreground-secondary)!important}#furo-readthedocs-versions{background:transparent;display:block;position:static;width:100%}#furo-readthedocs-versions .rst-versions{background:#1a1c1e}#furo-readthedocs-versions .rst-current-version{background:var(--color-sidebar-item-background);cursor:unset}#furo-readthedocs-versions .rst-current-version:hover{background:var(--color-sidebar-item-background)}#furo-readthedocs-versions .rst-current-version .fa-book{color:var(--color-foreground-primary)}#furo-readthedocs-versions>.rst-other-versions{padding:0}#furo-readthedocs-versions>.rst-other-versions small{opacity:1}#furo-readthedocs-versions .injected .rst-versions{position:unset}#furo-readthedocs-versions:focus-within,#furo-readthedocs-versions:hover{box-shadow:0 0 0 1px var(--color-sidebar-background-border)}#furo-readthedocs-versions:focus-within .rst-current-version,#furo-readthedocs-versions:hover .rst-current-version{background:#1a1c1e;font-size:inherit;height:auto;line-height:inherit;padding:12px;text-align:right}#furo-readthedocs-versions:focus-within .rst-current-version .fa-book,#furo-readthedocs-versions:hover .rst-current-version .fa-book{color:#fff;float:left}#furo-readthedocs-versions:focus-within .fa-caret-down,#furo-readthedocs-versions:hover .fa-caret-down{display:none}#furo-readthedocs-versions:focus-within .injected,#furo-readthedocs-versions:focus-within .rst-current-version,#furo-readthedocs-versions:focus-within .rst-other-versions,#furo-readthedocs-versions:hover .injected,#furo-readthedocs-versions:hover .rst-current-version,#furo-readthedocs-versions:hover .rst-other-versions{display:block}#furo-readthedocs-versions:focus-within>.rst-current-version,#furo-readthedocs-versions:hover>.rst-current-version{display:none}.highlight:hover button.copybtn{color:var(--color-code-foreground)}.highlight button.copybtn{align-items:center;background-color:var(--color-code-background);border:none;color:var(--color-background-item);cursor:pointer;height:1.25em;opacity:1;right:.5rem;top:.625rem;transition:color .3s,opacity .3s;width:1.25em}.highlight button.copybtn:hover{background-color:var(--color-code-background);color:var(--color-brand-content)}.highlight button.copybtn:after{background-color:transparent;color:var(--color-code-foreground);display:none}.highlight button.copybtn.success{color:#22863a;transition:color 0ms}.highlight button.copybtn.success:after{display:block}.highlight button.copybtn svg{padding:0}body{--sd-color-primary:var(--color-brand-primary);--sd-color-primary-highlight:var(--color-brand-content);--sd-color-primary-text:var(--color-background-primary);--sd-color-shadow:rgba(0,0,0,.05);--sd-color-card-border:var(--color-card-border);--sd-color-card-border-hover:var(--color-brand-content);--sd-color-card-background:var(--color-card-background);--sd-color-card-text:var(--color-foreground-primary);--sd-color-card-header:var(--color-card-marginals-background);--sd-color-card-footer:var(--color-card-marginals-background);--sd-color-tabs-label-active:var(--color-brand-content);--sd-color-tabs-label-hover:var(--color-foreground-muted);--sd-color-tabs-label-inactive:var(--color-foreground-muted);--sd-color-tabs-underline-active:var(--color-brand-content);--sd-color-tabs-underline-hover:var(--color-foreground-border);--sd-color-tabs-underline-inactive:var(--color-background-border);--sd-color-tabs-overline:var(--color-background-border);--sd-color-tabs-underline:var(--color-background-border)}.sd-tab-content{box-shadow:0 -2px var(--sd-color-tabs-overline),0 1px var(--sd-color-tabs-underline)}.sd-card{box-shadow:0 .1rem .25rem var(--sd-color-shadow),0 0 .0625rem rgba(0,0,0,.1)}.sd-shadow-sm{box-shadow:0 .1rem .25rem var(--sd-color-shadow),0 0 .0625rem rgba(0,0,0,.1)!important}.sd-shadow-md{box-shadow:0 .3rem .75rem var(--sd-color-shadow),0 0 .0625rem rgba(0,0,0,.1)!important}.sd-shadow-lg{box-shadow:0 .6rem 1.5rem var(--sd-color-shadow),0 0 .0625rem rgba(0,0,0,.1)!important}.sd-card-hover:hover{transform:none}.sd-cards-carousel{gap:.25rem;padding:.25rem}body{--tabs--label-text:var(--color-foreground-muted);--tabs--label-text--hover:var(--color-foreground-muted);--tabs--label-text--active:var(--color-brand-content);--tabs--label-text--active--hover:var(--color-brand-content);--tabs--label-background:transparent;--tabs--label-background--hover:transparent;--tabs--label-background--active:transparent;--tabs--label-background--active--hover:transparent;--tabs--padding-x:0.25em;--tabs--margin-x:1em;--tabs--border:var(--color-background-border);--tabs--label-border:transparent;--tabs--label-border--hover:var(--color-foreground-muted);--tabs--label-border--active:var(--color-brand-content);--tabs--label-border--active--hover:var(--color-brand-content)}[role=main] .container{max-width:none;padding-left:0;padding-right:0}.shadow.docutils{border:none;box-shadow:0 .2rem .5rem rgba(0,0,0,.05),0 0 .0625rem rgba(0,0,0,.1)!important}.sphinx-bs .card{background-color:var(--color-background-secondary);color:var(--color-foreground)} +#furo-sidebar-ad-placement{padding:var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal)}#furo-sidebar-ad-placement .ethical-sidebar{background:var(--color-background-secondary);border:none;box-shadow:none}#furo-sidebar-ad-placement .ethical-sidebar:hover{background:var(--color-background-hover)}#furo-sidebar-ad-placement .ethical-sidebar a{color:var(--color-foreground-primary)}#furo-sidebar-ad-placement .ethical-callout a{color:var(--color-foreground-secondary)!important}#furo-readthedocs-versions{background:transparent;display:block;position:static;width:100%}#furo-readthedocs-versions .rst-versions{background:#1a1c1e}#furo-readthedocs-versions .rst-current-version{background:var(--color-sidebar-item-background);cursor:unset}#furo-readthedocs-versions .rst-current-version:hover{background:var(--color-sidebar-item-background)}#furo-readthedocs-versions .rst-current-version .fa-book{color:var(--color-foreground-primary)}#furo-readthedocs-versions>.rst-other-versions{padding:0}#furo-readthedocs-versions>.rst-other-versions small{opacity:1}#furo-readthedocs-versions .injected .rst-versions{position:unset}#furo-readthedocs-versions:focus-within,#furo-readthedocs-versions:hover{box-shadow:0 0 0 1px var(--color-sidebar-background-border)}#furo-readthedocs-versions:focus-within .rst-current-version,#furo-readthedocs-versions:hover .rst-current-version{background:#1a1c1e;font-size:inherit;height:auto;line-height:inherit;padding:12px;text-align:right}#furo-readthedocs-versions:focus-within .rst-current-version .fa-book,#furo-readthedocs-versions:hover .rst-current-version .fa-book{color:#fff;float:left}#furo-readthedocs-versions:focus-within .fa-caret-down,#furo-readthedocs-versions:hover .fa-caret-down{display:none}#furo-readthedocs-versions:focus-within .injected,#furo-readthedocs-versions:focus-within .rst-current-version,#furo-readthedocs-versions:focus-within .rst-other-versions,#furo-readthedocs-versions:hover .injected,#furo-readthedocs-versions:hover .rst-current-version,#furo-readthedocs-versions:hover .rst-other-versions{display:block}#furo-readthedocs-versions:focus-within>.rst-current-version,#furo-readthedocs-versions:hover>.rst-current-version{display:none}.highlight:hover button.copybtn{color:var(--color-code-foreground)}.highlight button.copybtn{align-items:center;background-color:var(--color-code-background);border:none;color:var(--color-background-item);cursor:pointer;height:1.25em;right:.5rem;top:.625rem;transition:color .3s,opacity .3s;width:1.25em}.highlight button.copybtn:hover{background-color:var(--color-code-background);color:var(--color-brand-content)}.highlight button.copybtn:after{background-color:transparent;color:var(--color-code-foreground);display:none}.highlight button.copybtn.success{color:#22863a;transition:color 0ms}.highlight button.copybtn.success:after{display:block}.highlight button.copybtn svg{padding:0}body{--sd-color-primary:var(--color-brand-primary);--sd-color-primary-highlight:var(--color-brand-content);--sd-color-primary-text:var(--color-background-primary);--sd-color-shadow:rgba(0,0,0,.05);--sd-color-card-border:var(--color-card-border);--sd-color-card-border-hover:var(--color-brand-content);--sd-color-card-background:var(--color-card-background);--sd-color-card-text:var(--color-foreground-primary);--sd-color-card-header:var(--color-card-marginals-background);--sd-color-card-footer:var(--color-card-marginals-background);--sd-color-tabs-label-active:var(--color-brand-content);--sd-color-tabs-label-hover:var(--color-foreground-muted);--sd-color-tabs-label-inactive:var(--color-foreground-muted);--sd-color-tabs-underline-active:var(--color-brand-content);--sd-color-tabs-underline-hover:var(--color-foreground-border);--sd-color-tabs-underline-inactive:var(--color-background-border);--sd-color-tabs-overline:var(--color-background-border);--sd-color-tabs-underline:var(--color-background-border)}.sd-tab-content{box-shadow:0 -2px var(--sd-color-tabs-overline),0 1px var(--sd-color-tabs-underline)}.sd-card{box-shadow:0 .1rem .25rem var(--sd-color-shadow),0 0 .0625rem rgba(0,0,0,.1)}.sd-shadow-sm{box-shadow:0 .1rem .25rem var(--sd-color-shadow),0 0 .0625rem rgba(0,0,0,.1)!important}.sd-shadow-md{box-shadow:0 .3rem .75rem var(--sd-color-shadow),0 0 .0625rem rgba(0,0,0,.1)!important}.sd-shadow-lg{box-shadow:0 .6rem 1.5rem var(--sd-color-shadow),0 0 .0625rem rgba(0,0,0,.1)!important}.sd-card-hover:hover{transform:none}.sd-cards-carousel{gap:.25rem;padding:.25rem}body{--tabs--label-text:var(--color-foreground-muted);--tabs--label-text--hover:var(--color-foreground-muted);--tabs--label-text--active:var(--color-brand-content);--tabs--label-text--active--hover:var(--color-brand-content);--tabs--label-background:transparent;--tabs--label-background--hover:transparent;--tabs--label-background--active:transparent;--tabs--label-background--active--hover:transparent;--tabs--padding-x:0.25em;--tabs--margin-x:1em;--tabs--border:var(--color-background-border);--tabs--label-border:transparent;--tabs--label-border--hover:var(--color-foreground-muted);--tabs--label-border--active:var(--color-brand-content);--tabs--label-border--active--hover:var(--color-brand-content)}[role=main] .container{max-width:none;padding-left:0;padding-right:0}.shadow.docutils{border:none;box-shadow:0 .2rem .5rem rgba(0,0,0,.05),0 0 .0625rem rgba(0,0,0,.1)!important}.sphinx-bs .card{background-color:var(--color-background-secondary);color:var(--color-foreground)} /*# sourceMappingURL=furo-extensions.css.map*/ \ No newline at end of file diff --git a/docs/build/html/_static/styles/furo-extensions.css.map b/docs/build/html/_static/styles/furo-extensions.css.map index 9ba5637..c26eac7 100644 --- a/docs/build/html/_static/styles/furo-extensions.css.map +++ b/docs/build/html/_static/styles/furo-extensions.css.map @@ -1 +1 @@ -{"version":3,"file":"styles/furo-extensions.css","mappings":"AAGA,2BACE,oFACA,4CAKE,6CAHA,YACA,eAEA,CACA,kDACE,yCAEF,8CACE,sCAEJ,8CACE,kDAEJ,2BAGE,uBACA,cAHA,gBACA,UAEA,CAGA,yCACE,mBAEF,gDAEE,gDADA,YACA,CACA,sDACE,gDACF,yDACE,sCAEJ,+CACE,UACA,qDACE,UAGF,mDACE,eAEJ,yEAEE,4DAEA,mHASE,mBAPA,kBAEA,YADA,oBAGA,aADA,gBAIA,CAEA,qIAEE,WADA,UACA,CAEJ,uGACE,aAEF,iUAGE,cAEF,mHACE,aC1EJ,gCACE,mCAEF,0BAKE,mBAUA,8CACA,YAFA,mCAKA,eAZA,cALA,UASA,YADA,YAYA,iCAdA,YAcA,CAEA,gCAEE,8CADA,gCACA,CAEF,gCAGE,6BADA,mCADA,YAEA,CAEF,kCAEE,cADA,oBACA,CACA,wCACE,cAEJ,8BACE,UC5CN,KAEE,6CAA8C,CAC9C,uDAAwD,CACxD,uDAAwD,CAGxD,iCAAsC,CAGtC,+CAAgD,CAChD,uDAAwD,CACxD,uDAAwD,CACxD,oDAAqD,CACrD,6DAA8D,CAC9D,6DAA8D,CAG9D,uDAAwD,CACxD,yDAA0D,CAC1D,4DAA6D,CAC7D,2DAA4D,CAC5D,8DAA+D,CAC/D,iEAAkE,CAClE,uDAAwD,CACxD,wDAAyD,CAG3D,gBACE,qFAGF,SACE,6EAEF,cACE,uFAEF,cACE,uFAEF,cACE,uFAGF,qBACE,eAEF,mBACE,WACA,eChDF,KACE,gDAAiD,CACjD,uDAAwD,CACxD,qDAAsD,CACtD,4DAA6D,CAC7D,oCAAqC,CACrC,2CAA4C,CAC5C,4CAA6C,CAC7C,mDAAoD,CACpD,wBAAyB,CACzB,oBAAqB,CACrB,6CAA8C,CAC9C,gCAAiC,CACjC,yDAA0D,CAC1D,uDAAwD,CACxD,8DAA+D,CCbjE,uBACE,eACA,eACA,gBAGF,iBACE,YACA,+EAGF,iBACE,mDACA","sources":["webpack:///./src/furo/assets/styles/extensions/_readthedocs.sass","webpack:///./src/furo/assets/styles/extensions/_copybutton.sass","webpack:///./src/furo/assets/styles/extensions/_sphinx-design.sass","webpack:///./src/furo/assets/styles/extensions/_sphinx-inline-tabs.sass","webpack:///./src/furo/assets/styles/extensions/_sphinx-panels.sass"],"sourcesContent":["// This file contains the styles used for tweaking how ReadTheDoc's embedded\n// contents would show up inside the theme.\n\n#furo-sidebar-ad-placement\n padding: var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal)\n .ethical-sidebar\n // Remove the border and box-shadow.\n border: none\n box-shadow: none\n // Manage the background colors.\n background: var(--color-background-secondary)\n &:hover\n background: var(--color-background-hover)\n // Ensure the text is legible.\n a\n color: var(--color-foreground-primary)\n\n .ethical-callout a\n color: var(--color-foreground-secondary) !important\n\n#furo-readthedocs-versions\n position: static\n width: 100%\n background: transparent\n display: block\n\n // Make the background color fit with the theme's aesthetic.\n .rst-versions\n background: rgb(26, 28, 30)\n\n .rst-current-version\n cursor: unset\n background: var(--color-sidebar-item-background)\n &:hover\n background: var(--color-sidebar-item-background)\n .fa-book\n color: var(--color-foreground-primary)\n\n > .rst-other-versions\n padding: 0\n small\n opacity: 1\n\n .injected\n .rst-versions\n position: unset\n\n &:hover,\n &:focus-within\n box-shadow: 0 0 0 1px var(--color-sidebar-background-border)\n\n .rst-current-version\n // Undo the tweaks done in RTD's CSS\n font-size: inherit\n line-height: inherit\n height: auto\n text-align: right\n padding: 12px\n\n // Match the rest of the body\n background: #1a1c1e\n\n .fa-book\n float: left\n color: white\n\n .fa-caret-down\n display: none\n\n .rst-current-version,\n .rst-other-versions,\n .injected\n display: block\n\n > .rst-current-version\n display: none\n",".highlight\n &:hover button.copybtn\n color: var(--color-code-foreground)\n\n button.copybtn\n // Make it visible\n opacity: 1\n\n // Align things correctly\n align-items: center\n\n height: 1.25em\n width: 1.25em\n\n top: 0.625rem // $code-spacing-vertical\n right: 0.5rem\n\n // Make it look better\n color: var(--color-background-item)\n background-color: var(--color-code-background)\n border: none\n\n // Change to cursor to make it obvious that you can click on it\n cursor: pointer\n\n // Transition smoothly, for aesthetics\n transition: color 300ms, opacity 300ms\n\n &:hover\n color: var(--color-brand-content)\n background-color: var(--color-code-background)\n\n &::after\n display: none\n color: var(--color-code-foreground)\n background-color: transparent\n\n &.success\n transition: color 0ms\n color: #22863a\n &::after\n display: block\n\n svg\n padding: 0\n","body\n // Colors\n --sd-color-primary: var(--color-brand-primary)\n --sd-color-primary-highlight: var(--color-brand-content)\n --sd-color-primary-text: var(--color-background-primary)\n\n // Shadows\n --sd-color-shadow: rgba(0, 0, 0, 0.05)\n\n // Cards\n --sd-color-card-border: var(--color-card-border)\n --sd-color-card-border-hover: var(--color-brand-content)\n --sd-color-card-background: var(--color-card-background)\n --sd-color-card-text: var(--color-foreground-primary)\n --sd-color-card-header: var(--color-card-marginals-background)\n --sd-color-card-footer: var(--color-card-marginals-background)\n\n // Tabs\n --sd-color-tabs-label-active: var(--color-brand-content)\n --sd-color-tabs-label-hover: var(--color-foreground-muted)\n --sd-color-tabs-label-inactive: var(--color-foreground-muted)\n --sd-color-tabs-underline-active: var(--color-brand-content)\n --sd-color-tabs-underline-hover: var(--color-foreground-border)\n --sd-color-tabs-underline-inactive: var(--color-background-border)\n --sd-color-tabs-overline: var(--color-background-border)\n --sd-color-tabs-underline: var(--color-background-border)\n\n// Tabs\n.sd-tab-content\n box-shadow: 0 -2px var(--sd-color-tabs-overline), 0 1px var(--sd-color-tabs-underline)\n\n// Shadows\n.sd-card // Have a shadow by default\n box-shadow: 0 0.1rem 0.25rem var(--sd-color-shadow), 0 0 0.0625rem rgba(0, 0, 0, 0.1)\n\n.sd-shadow-sm\n box-shadow: 0 0.1rem 0.25rem var(--sd-color-shadow), 0 0 0.0625rem rgba(0, 0, 0, 0.1) !important\n\n.sd-shadow-md\n box-shadow: 0 0.3rem 0.75rem var(--sd-color-shadow), 0 0 0.0625rem rgba(0, 0, 0, 0.1) !important\n\n.sd-shadow-lg\n box-shadow: 0 0.6rem 1.5rem var(--sd-color-shadow), 0 0 0.0625rem rgba(0, 0, 0, 0.1) !important\n\n// Cards\n.sd-card-hover:hover // Don't change scale on hover\n transform: none\n\n.sd-cards-carousel // Have a bit of gap in the carousel by default\n gap: 0.25rem\n padding: 0.25rem\n","// This file contains styles to tweak sphinx-inline-tabs to work well with Furo.\n\nbody\n --tabs--label-text: var(--color-foreground-muted)\n --tabs--label-text--hover: var(--color-foreground-muted)\n --tabs--label-text--active: var(--color-brand-content)\n --tabs--label-text--active--hover: var(--color-brand-content)\n --tabs--label-background: transparent\n --tabs--label-background--hover: transparent\n --tabs--label-background--active: transparent\n --tabs--label-background--active--hover: transparent\n --tabs--padding-x: 0.25em\n --tabs--margin-x: 1em\n --tabs--border: var(--color-background-border)\n --tabs--label-border: transparent\n --tabs--label-border--hover: var(--color-foreground-muted)\n --tabs--label-border--active: var(--color-brand-content)\n --tabs--label-border--active--hover: var(--color-brand-content)\n","// This file contains styles to tweak sphinx-panels to work well with Furo.\n\n// sphinx-panels includes Bootstrap 4, which uses .container which can conflict\n// with docutils' `.. container::` directive.\n[role=\"main\"] .container\n max-width: initial\n padding-left: initial\n padding-right: initial\n\n// Make the panels look nicer!\n.shadow.docutils\n border: none\n box-shadow: 0 0.2rem 0.5rem rgba(0, 0, 0, 0.05), 0 0 0.0625rem rgba(0, 0, 0, 0.1) !important\n\n// Make panel colors respond to dark mode\n.sphinx-bs .card\n background-color: var(--color-background-secondary)\n color: var(--color-foreground)\n"],"names":[],"sourceRoot":""} \ No newline at end of file +{"version":3,"file":"styles/furo-extensions.css","mappings":"AAGA,2BACE,oFACA,4CAKE,6CAHA,YACA,eAEA,CACA,kDACE,yCAEF,8CACE,sCAEJ,8CACE,kDAEJ,2BAGE,uBACA,cAHA,gBACA,UAEA,CAGA,yCACE,mBAEF,gDAEE,gDADA,YACA,CACA,sDACE,gDACF,yDACE,sCAEJ,+CACE,UACA,qDACE,UAGF,mDACE,eAEJ,yEAEE,4DAEA,mHASE,mBAPA,kBAEA,YADA,oBAGA,aADA,gBAIA,CAEA,qIAEE,WADA,UACA,CAEJ,uGACE,aAEF,iUAGE,cAEF,mHACE,aC1EJ,gCACE,mCAEF,0BAEE,mBAUA,8CACA,YAFA,mCAKA,eAZA,cAIA,YADA,YAYA,iCAdA,YAcA,CAEA,gCAEE,8CADA,gCACA,CAEF,gCAGE,6BADA,mCADA,YAEA,CAEF,kCAEE,cADA,oBACA,CACA,wCACE,cAEJ,8BACE,UCzCN,KAEE,6CAA8C,CAC9C,uDAAwD,CACxD,uDAAwD,CAGxD,iCAAsC,CAGtC,+CAAgD,CAChD,uDAAwD,CACxD,uDAAwD,CACxD,oDAAqD,CACrD,6DAA8D,CAC9D,6DAA8D,CAG9D,uDAAwD,CACxD,yDAA0D,CAC1D,4DAA6D,CAC7D,2DAA4D,CAC5D,8DAA+D,CAC/D,iEAAkE,CAClE,uDAAwD,CACxD,wDAAyD,CAG3D,gBACE,qFAGF,SACE,6EAEF,cACE,uFAEF,cACE,uFAEF,cACE,uFAGF,qBACE,eAEF,mBACE,WACA,eChDF,KACE,gDAAiD,CACjD,uDAAwD,CACxD,qDAAsD,CACtD,4DAA6D,CAC7D,oCAAqC,CACrC,2CAA4C,CAC5C,4CAA6C,CAC7C,mDAAoD,CACpD,wBAAyB,CACzB,oBAAqB,CACrB,6CAA8C,CAC9C,gCAAiC,CACjC,yDAA0D,CAC1D,uDAAwD,CACxD,8DAA+D,CCbjE,uBACE,eACA,eACA,gBAGF,iBACE,YACA,+EAGF,iBACE,mDACA","sources":["webpack:///./src/furo/assets/styles/extensions/_readthedocs.sass","webpack:///./src/furo/assets/styles/extensions/_copybutton.sass","webpack:///./src/furo/assets/styles/extensions/_sphinx-design.sass","webpack:///./src/furo/assets/styles/extensions/_sphinx-inline-tabs.sass","webpack:///./src/furo/assets/styles/extensions/_sphinx-panels.sass"],"sourcesContent":["// This file contains the styles used for tweaking how ReadTheDoc's embedded\n// contents would show up inside the theme.\n\n#furo-sidebar-ad-placement\n padding: var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal)\n .ethical-sidebar\n // Remove the border and box-shadow.\n border: none\n box-shadow: none\n // Manage the background colors.\n background: var(--color-background-secondary)\n &:hover\n background: var(--color-background-hover)\n // Ensure the text is legible.\n a\n color: var(--color-foreground-primary)\n\n .ethical-callout a\n color: var(--color-foreground-secondary) !important\n\n#furo-readthedocs-versions\n position: static\n width: 100%\n background: transparent\n display: block\n\n // Make the background color fit with the theme's aesthetic.\n .rst-versions\n background: rgb(26, 28, 30)\n\n .rst-current-version\n cursor: unset\n background: var(--color-sidebar-item-background)\n &:hover\n background: var(--color-sidebar-item-background)\n .fa-book\n color: var(--color-foreground-primary)\n\n > .rst-other-versions\n padding: 0\n small\n opacity: 1\n\n .injected\n .rst-versions\n position: unset\n\n &:hover,\n &:focus-within\n box-shadow: 0 0 0 1px var(--color-sidebar-background-border)\n\n .rst-current-version\n // Undo the tweaks done in RTD's CSS\n font-size: inherit\n line-height: inherit\n height: auto\n text-align: right\n padding: 12px\n\n // Match the rest of the body\n background: #1a1c1e\n\n .fa-book\n float: left\n color: white\n\n .fa-caret-down\n display: none\n\n .rst-current-version,\n .rst-other-versions,\n .injected\n display: block\n\n > .rst-current-version\n display: none\n",".highlight\n &:hover button.copybtn\n color: var(--color-code-foreground)\n\n button.copybtn\n // Align things correctly\n align-items: center\n\n height: 1.25em\n width: 1.25em\n\n top: 0.625rem // $code-spacing-vertical\n right: 0.5rem\n\n // Make it look better\n color: var(--color-background-item)\n background-color: var(--color-code-background)\n border: none\n\n // Change to cursor to make it obvious that you can click on it\n cursor: pointer\n\n // Transition smoothly, for aesthetics\n transition: color 300ms, opacity 300ms\n\n &:hover\n color: var(--color-brand-content)\n background-color: var(--color-code-background)\n\n &::after\n display: none\n color: var(--color-code-foreground)\n background-color: transparent\n\n &.success\n transition: color 0ms\n color: #22863a\n &::after\n display: block\n\n svg\n padding: 0\n","body\n // Colors\n --sd-color-primary: var(--color-brand-primary)\n --sd-color-primary-highlight: var(--color-brand-content)\n --sd-color-primary-text: var(--color-background-primary)\n\n // Shadows\n --sd-color-shadow: rgba(0, 0, 0, 0.05)\n\n // Cards\n --sd-color-card-border: var(--color-card-border)\n --sd-color-card-border-hover: var(--color-brand-content)\n --sd-color-card-background: var(--color-card-background)\n --sd-color-card-text: var(--color-foreground-primary)\n --sd-color-card-header: var(--color-card-marginals-background)\n --sd-color-card-footer: var(--color-card-marginals-background)\n\n // Tabs\n --sd-color-tabs-label-active: var(--color-brand-content)\n --sd-color-tabs-label-hover: var(--color-foreground-muted)\n --sd-color-tabs-label-inactive: var(--color-foreground-muted)\n --sd-color-tabs-underline-active: var(--color-brand-content)\n --sd-color-tabs-underline-hover: var(--color-foreground-border)\n --sd-color-tabs-underline-inactive: var(--color-background-border)\n --sd-color-tabs-overline: var(--color-background-border)\n --sd-color-tabs-underline: var(--color-background-border)\n\n// Tabs\n.sd-tab-content\n box-shadow: 0 -2px var(--sd-color-tabs-overline), 0 1px var(--sd-color-tabs-underline)\n\n// Shadows\n.sd-card // Have a shadow by default\n box-shadow: 0 0.1rem 0.25rem var(--sd-color-shadow), 0 0 0.0625rem rgba(0, 0, 0, 0.1)\n\n.sd-shadow-sm\n box-shadow: 0 0.1rem 0.25rem var(--sd-color-shadow), 0 0 0.0625rem rgba(0, 0, 0, 0.1) !important\n\n.sd-shadow-md\n box-shadow: 0 0.3rem 0.75rem var(--sd-color-shadow), 0 0 0.0625rem rgba(0, 0, 0, 0.1) !important\n\n.sd-shadow-lg\n box-shadow: 0 0.6rem 1.5rem var(--sd-color-shadow), 0 0 0.0625rem rgba(0, 0, 0, 0.1) !important\n\n// Cards\n.sd-card-hover:hover // Don't change scale on hover\n transform: none\n\n.sd-cards-carousel // Have a bit of gap in the carousel by default\n gap: 0.25rem\n padding: 0.25rem\n","// This file contains styles to tweak sphinx-inline-tabs to work well with Furo.\n\nbody\n --tabs--label-text: var(--color-foreground-muted)\n --tabs--label-text--hover: var(--color-foreground-muted)\n --tabs--label-text--active: var(--color-brand-content)\n --tabs--label-text--active--hover: var(--color-brand-content)\n --tabs--label-background: transparent\n --tabs--label-background--hover: transparent\n --tabs--label-background--active: transparent\n --tabs--label-background--active--hover: transparent\n --tabs--padding-x: 0.25em\n --tabs--margin-x: 1em\n --tabs--border: var(--color-background-border)\n --tabs--label-border: transparent\n --tabs--label-border--hover: var(--color-foreground-muted)\n --tabs--label-border--active: var(--color-brand-content)\n --tabs--label-border--active--hover: var(--color-brand-content)\n","// This file contains styles to tweak sphinx-panels to work well with Furo.\n\n// sphinx-panels includes Bootstrap 4, which uses .container which can conflict\n// with docutils' `.. container::` directive.\n[role=\"main\"] .container\n max-width: initial\n padding-left: initial\n padding-right: initial\n\n// Make the panels look nicer!\n.shadow.docutils\n border: none\n box-shadow: 0 0.2rem 0.5rem rgba(0, 0, 0, 0.05), 0 0 0.0625rem rgba(0, 0, 0, 0.1) !important\n\n// Make panel colors respond to dark mode\n.sphinx-bs .card\n background-color: var(--color-background-secondary)\n color: var(--color-foreground)\n"],"names":[],"sourceRoot":""} \ No newline at end of file diff --git a/docs/build/html/_static/styles/furo.css b/docs/build/html/_static/styles/furo.css index e3d4e57..05a56b1 100644 --- a/docs/build/html/_static/styles/furo.css +++ b/docs/build/html/_static/styles/furo.css @@ -1,2 +1,2 @@ -/*! normalize.css v8.0.1 | MIT License | github.com/necolas/normalize.css */html{line-height:1.15;-webkit-text-size-adjust:100%}body{margin:0}main{display:block}h1{font-size:2em;margin:.67em 0}hr{box-sizing:content-box;height:0;overflow:visible}pre{font-family:monospace,monospace;font-size:1em}a{background-color:transparent}abbr[title]{border-bottom:none;text-decoration:underline;text-decoration:underline dotted}b,strong{font-weight:bolder}code,kbd,samp{font-family:monospace,monospace;font-size:1em}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}img{border-style:none}button,input,optgroup,select,textarea{font-family:inherit;font-size:100%;line-height:1.15;margin:0}button,input{overflow:visible}button,select{text-transform:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]::-moz-focus-inner,[type=reset]::-moz-focus-inner,[type=submit]::-moz-focus-inner,button::-moz-focus-inner{border-style:none;padding:0}[type=button]:-moz-focusring,[type=reset]:-moz-focusring,[type=submit]:-moz-focusring,button:-moz-focusring{outline:1px dotted ButtonText}fieldset{padding:.35em .75em .625em}legend{box-sizing:border-box;color:inherit;display:table;max-width:100%;padding:0;white-space:normal}progress{vertical-align:baseline}textarea{overflow:auto}[type=checkbox],[type=radio]{box-sizing:border-box;padding:0}[type=number]::-webkit-inner-spin-button,[type=number]::-webkit-outer-spin-button{height:auto}[type=search]{-webkit-appearance:textfield;outline-offset:-2px}[type=search]::-webkit-search-decoration{-webkit-appearance:none}::-webkit-file-upload-button{-webkit-appearance:button;font:inherit}details{display:block}summary{display:list-item}[hidden],template{display:none}@media print{.content-icon-container,.headerlink,.mobile-header,.related-pages{display:none!important}.highlight{border:.1pt solid var(--color-foreground-border)}a,blockquote,dl,ol,pre,table,ul{page-break-inside:avoid}caption,figure,h1,h2,h3,h4,h5,h6,img{page-break-after:avoid;page-break-inside:avoid}dl,ol,ul{page-break-before:avoid}}.visually-hidden{height:1px!important;margin:-1px!important;overflow:hidden!important;padding:0!important;position:absolute!important;width:1px!important;clip:rect(0,0,0,0)!important;background:var(--color-background-primary);border:0!important;color:var(--color-foreground-primary);white-space:nowrap!important}:-moz-focusring{outline:auto}body{--font-stack:-apple-system,BlinkMacSystemFont,Segoe UI,Helvetica,Arial,sans-serif,Apple Color Emoji,Segoe UI Emoji;--font-stack--monospace:"SFMono-Regular",Menlo,Consolas,Monaco,Liberation Mono,Lucida Console,monospace;--font-stack--headings:var(--font-stack);--font-size--normal:100%;--font-size--small:87.5%;--font-size--small--2:81.25%;--font-size--small--3:75%;--font-size--small--4:62.5%;--sidebar-caption-font-size:var(--font-size--small--2);--sidebar-item-font-size:var(--font-size--small);--sidebar-search-input-font-size:var(--font-size--small);--toc-font-size:var(--font-size--small--3);--toc-font-size--mobile:var(--font-size--normal);--toc-title-font-size:var(--font-size--small--4);--admonition-font-size:0.8125rem;--admonition-title-font-size:0.8125rem;--code-font-size:var(--font-size--small--2);--api-font-size:var(--font-size--small);--header-height:calc(var(--sidebar-item-line-height) + var(--sidebar-item-spacing-vertical)*4);--header-padding:0.5rem;--sidebar-tree-space-above:1.5rem;--sidebar-caption-space-above:1rem;--sidebar-item-line-height:1rem;--sidebar-item-spacing-vertical:0.5rem;--sidebar-item-spacing-horizontal:1rem;--sidebar-item-height:calc(var(--sidebar-item-line-height) + var(--sidebar-item-spacing-vertical)*2);--sidebar-expander-width:var(--sidebar-item-height);--sidebar-search-space-above:0.5rem;--sidebar-search-input-spacing-vertical:0.5rem;--sidebar-search-input-spacing-horizontal:0.5rem;--sidebar-search-input-height:1rem;--sidebar-search-icon-size:var(--sidebar-search-input-height);--toc-title-padding:0.25rem 0;--toc-spacing-vertical:1.5rem;--toc-spacing-horizontal:1.5rem;--toc-item-spacing-vertical:0.4rem;--toc-item-spacing-horizontal:1rem;--icon-search:url('data:image/svg+xml;charset=utf-8,');--icon-pencil:url('data:image/svg+xml;charset=utf-8,');--icon-abstract:url('data:image/svg+xml;charset=utf-8,');--icon-info:url('data:image/svg+xml;charset=utf-8,');--icon-flame:url('data:image/svg+xml;charset=utf-8,');--icon-question:url('data:image/svg+xml;charset=utf-8,');--icon-warning:url('data:image/svg+xml;charset=utf-8,');--icon-failure:url('data:image/svg+xml;charset=utf-8,');--icon-spark:url('data:image/svg+xml;charset=utf-8,');--color-admonition-title--caution:#ff9100;--color-admonition-title-background--caution:rgba(255,145,0,.2);--color-admonition-title--warning:#ff9100;--color-admonition-title-background--warning:rgba(255,145,0,.2);--color-admonition-title--danger:#ff5252;--color-admonition-title-background--danger:rgba(255,82,82,.2);--color-admonition-title--attention:#ff5252;--color-admonition-title-background--attention:rgba(255,82,82,.2);--color-admonition-title--error:#ff5252;--color-admonition-title-background--error:rgba(255,82,82,.2);--color-admonition-title--hint:#00c852;--color-admonition-title-background--hint:rgba(0,200,82,.2);--color-admonition-title--tip:#00c852;--color-admonition-title-background--tip:rgba(0,200,82,.2);--color-admonition-title--important:#00bfa5;--color-admonition-title-background--important:rgba(0,191,165,.2);--color-admonition-title--note:#00b0ff;--color-admonition-title-background--note:rgba(0,176,255,.2);--color-admonition-title--seealso:#448aff;--color-admonition-title-background--seealso:rgba(68,138,255,.2);--color-admonition-title--admonition-todo:grey;--color-admonition-title-background--admonition-todo:hsla(0,0%,50%,.2);--color-admonition-title:#651fff;--color-admonition-title-background:rgba(101,31,255,.2);--icon-admonition-default:var(--icon-abstract);--color-topic-title:#14b8a6;--color-topic-title-background:rgba(20,184,166,.2);--icon-topic-default:var(--icon-pencil);--color-problematic:#b30000;--color-foreground-primary:#000;--color-foreground-secondary:#5a5c63;--color-foreground-muted:#6b6f76;--color-foreground-border:#878787;--color-background-primary:#fff;--color-background-secondary:#f8f9fb;--color-background-hover:#efeff4;--color-background-hover--transparent:#efeff400;--color-background-border:#eeebee;--color-background-item:#ccc;--color-announcement-background:#000000dd;--color-announcement-text:#eeebee;--color-brand-primary:#0a4bff;--color-brand-content:#2757dd;--color-brand-visited:#872ee0;--color-api-background:var(--color-background-hover--transparent);--color-api-background-hover:var(--color-background-hover);--color-api-overall:var(--color-foreground-secondary);--color-api-name:var(--color-problematic);--color-api-pre-name:var(--color-problematic);--color-api-paren:var(--color-foreground-secondary);--color-api-keyword:var(--color-foreground-primary);--color-api-added:#21632c;--color-api-added-border:#38a84d;--color-api-changed:#046172;--color-api-changed-border:#06a1bc;--color-api-deprecated:#605706;--color-api-deprecated-border:#f0d90f;--color-api-removed:#b30000;--color-api-removed-border:#ff5c5c;--color-highlight-on-target:#ffc;--color-inline-code-background:var(--color-background-secondary);--color-highlighted-background:#def;--color-highlighted-text:var(--color-foreground-primary);--color-guilabel-background:#ddeeff80;--color-guilabel-border:#bedaf580;--color-guilabel-text:var(--color-foreground-primary);--color-admonition-background:transparent;--color-table-header-background:var(--color-background-secondary);--color-table-border:var(--color-background-border);--color-card-border:var(--color-background-secondary);--color-card-background:transparent;--color-card-marginals-background:var(--color-background-secondary);--color-header-background:var(--color-background-primary);--color-header-border:var(--color-background-border);--color-header-text:var(--color-foreground-primary);--color-sidebar-background:var(--color-background-secondary);--color-sidebar-background-border:var(--color-background-border);--color-sidebar-brand-text:var(--color-foreground-primary);--color-sidebar-caption-text:var(--color-foreground-muted);--color-sidebar-link-text:var(--color-foreground-secondary);--color-sidebar-link-text--top-level:var(--color-brand-primary);--color-sidebar-item-background:var(--color-sidebar-background);--color-sidebar-item-background--current:var( --color-sidebar-item-background );--color-sidebar-item-background--hover:linear-gradient(90deg,var(--color-background-hover--transparent) 0%,var(--color-background-hover) var(--sidebar-item-spacing-horizontal),var(--color-background-hover) 100%);--color-sidebar-item-expander-background:transparent;--color-sidebar-item-expander-background--hover:var( --color-background-hover );--color-sidebar-search-text:var(--color-foreground-primary);--color-sidebar-search-background:var(--color-background-secondary);--color-sidebar-search-background--focus:var(--color-background-primary);--color-sidebar-search-border:var(--color-background-border);--color-sidebar-search-icon:var(--color-foreground-muted);--color-toc-background:var(--color-background-primary);--color-toc-title-text:var(--color-foreground-muted);--color-toc-item-text:var(--color-foreground-secondary);--color-toc-item-text--hover:var(--color-foreground-primary);--color-toc-item-text--active:var(--color-brand-primary);--color-content-foreground:var(--color-foreground-primary);--color-content-background:transparent;--color-link:var(--color-brand-content);--color-link-underline:var(--color-background-border);--color-link--hover:var(--color-brand-content);--color-link-underline--hover:var(--color-foreground-border);--color-link--visited:var(--color-brand-visited);--color-link-underline--visited:var(--color-background-border);--color-link--visited--hover:var(--color-brand-visited);--color-link-underline--visited--hover:var(--color-foreground-border)}.only-light{display:block!important}html body .only-dark{display:none!important}@media not print{body[data-theme=dark]{--color-problematic:#ee5151;--color-foreground-primary:#cfd0d0;--color-foreground-secondary:#9ca0a5;--color-foreground-muted:#81868d;--color-foreground-border:#666;--color-background-primary:#131416;--color-background-secondary:#1a1c1e;--color-background-hover:#1e2124;--color-background-hover--transparent:#1e212400;--color-background-border:#303335;--color-background-item:#444;--color-announcement-background:#000000dd;--color-announcement-text:#eeebee;--color-brand-primary:#3d94ff;--color-brand-content:#5ca5ff;--color-brand-visited:#b27aeb;--color-highlighted-background:#083563;--color-guilabel-background:#08356380;--color-guilabel-border:#13395f80;--color-api-keyword:var(--color-foreground-secondary);--color-highlight-on-target:#330;--color-api-added:#3db854;--color-api-added-border:#267334;--color-api-changed:#09b0ce;--color-api-changed-border:#056d80;--color-api-deprecated:#b1a10b;--color-api-deprecated-border:#6e6407;--color-api-removed:#ff7575;--color-api-removed-border:#b03b3b;--color-admonition-background:#18181a;--color-card-border:var(--color-background-secondary);--color-card-background:#18181a;--color-card-marginals-background:var(--color-background-hover)}html body[data-theme=dark] .only-light{display:none!important}body[data-theme=dark] .only-dark{display:block!important}@media(prefers-color-scheme:dark){body:not([data-theme=light]){--color-problematic:#ee5151;--color-foreground-primary:#cfd0d0;--color-foreground-secondary:#9ca0a5;--color-foreground-muted:#81868d;--color-foreground-border:#666;--color-background-primary:#131416;--color-background-secondary:#1a1c1e;--color-background-hover:#1e2124;--color-background-hover--transparent:#1e212400;--color-background-border:#303335;--color-background-item:#444;--color-announcement-background:#000000dd;--color-announcement-text:#eeebee;--color-brand-primary:#3d94ff;--color-brand-content:#5ca5ff;--color-brand-visited:#b27aeb;--color-highlighted-background:#083563;--color-guilabel-background:#08356380;--color-guilabel-border:#13395f80;--color-api-keyword:var(--color-foreground-secondary);--color-highlight-on-target:#330;--color-api-added:#3db854;--color-api-added-border:#267334;--color-api-changed:#09b0ce;--color-api-changed-border:#056d80;--color-api-deprecated:#b1a10b;--color-api-deprecated-border:#6e6407;--color-api-removed:#ff7575;--color-api-removed-border:#b03b3b;--color-admonition-background:#18181a;--color-card-border:var(--color-background-secondary);--color-card-background:#18181a;--color-card-marginals-background:var(--color-background-hover)}html body:not([data-theme=light]) .only-light{display:none!important}body:not([data-theme=light]) .only-dark{display:block!important}}}body[data-theme=auto] .theme-toggle svg.theme-icon-when-auto-light{display:block}@media(prefers-color-scheme:dark){body[data-theme=auto] .theme-toggle svg.theme-icon-when-auto-dark{display:block}body[data-theme=auto] .theme-toggle svg.theme-icon-when-auto-light{display:none}}body[data-theme=dark] .theme-toggle svg.theme-icon-when-dark,body[data-theme=light] .theme-toggle svg.theme-icon-when-light{display:block}body{font-family:var(--font-stack)}code,kbd,pre,samp{font-family:var(--font-stack--monospace)}body{-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}article{line-height:1.5}h1,h2,h3,h4,h5,h6{border-radius:.5rem;font-family:var(--font-stack--headings);font-weight:700;line-height:1.25;margin:.5rem -.5rem;padding-left:.5rem;padding-right:.5rem}h1+p,h2+p,h3+p,h4+p,h5+p,h6+p{margin-top:0}h1{font-size:2.5em;margin-bottom:1rem}h1,h2{margin-top:1.75rem}h2{font-size:2em}h3{font-size:1.5em}h4{font-size:1.25em}h5{font-size:1.125em}h6{font-size:1em}small{font-size:80%;opacity:75%}p{margin-bottom:.75rem;margin-top:.5rem}hr.docutils{background-color:var(--color-background-border);border:0;height:1px;margin:2rem 0;padding:0}.centered{text-align:center}a{color:var(--color-link);text-decoration:underline;text-decoration-color:var(--color-link-underline)}a:visited{color:var(--color-link--visited);text-decoration-color:var(--color-link-underline--visited)}a:visited:hover{color:var(--color-link--visited--hover);text-decoration-color:var(--color-link-underline--visited--hover)}a:hover{color:var(--color-link--hover);text-decoration-color:var(--color-link-underline--hover)}a.muted-link{color:inherit}a.muted-link:hover{color:var(--color-link--hover);text-decoration-color:var(--color-link-underline--hover)}a.muted-link:hover:visited{color:var(--color-link--visited--hover);text-decoration-color:var(--color-link-underline--visited--hover)}html{overflow-x:hidden;overflow-y:scroll;scroll-behavior:smooth}.sidebar-scroll,.toc-scroll,article[role=main] *{scrollbar-color:var(--color-foreground-border) transparent;scrollbar-width:thin}.sidebar-scroll::-webkit-scrollbar,.toc-scroll::-webkit-scrollbar,article[role=main] ::-webkit-scrollbar{height:.25rem;width:.25rem}.sidebar-scroll::-webkit-scrollbar-thumb,.toc-scroll::-webkit-scrollbar-thumb,article[role=main] ::-webkit-scrollbar-thumb{background-color:var(--color-foreground-border);border-radius:.125rem}body,html{height:100%}.skip-to-content,body,html{background:var(--color-background-primary);color:var(--color-foreground-primary)}.skip-to-content{border-radius:1rem;left:.25rem;padding:1rem;position:fixed;top:.25rem;transform:translateY(-200%);transition:transform .3s ease-in-out;z-index:40}.skip-to-content:focus-within{transform:translateY(0)}article{background:var(--color-content-background);color:var(--color-content-foreground);overflow-wrap:break-word}.page{display:flex;min-height:100%}.mobile-header{background-color:var(--color-header-background);border-bottom:1px solid var(--color-header-border);color:var(--color-header-text);display:none;height:var(--header-height);width:100%;z-index:10}.mobile-header.scrolled{border-bottom:none;box-shadow:0 0 .2rem rgba(0,0,0,.1),0 .2rem .4rem rgba(0,0,0,.2)}.mobile-header .header-center a{color:var(--color-header-text);text-decoration:none}.main{display:flex;flex:1}.sidebar-drawer{background:var(--color-sidebar-background);border-right:1px solid var(--color-sidebar-background-border);box-sizing:border-box;display:flex;justify-content:flex-end;min-width:15em;width:calc(50% - 26em)}.sidebar-container,.toc-drawer{box-sizing:border-box;width:15em}.toc-drawer{background:var(--color-toc-background);padding-right:1rem}.sidebar-sticky,.toc-sticky{display:flex;flex-direction:column;height:min(100%,100vh);height:100vh;position:sticky;top:0}.sidebar-scroll,.toc-scroll{flex-grow:1;flex-shrink:1;overflow:auto;scroll-behavior:smooth}.content{display:flex;flex-direction:column;justify-content:space-between;padding:0 3em;width:46em}.icon{display:inline-block;height:1rem;width:1rem}.icon svg{height:100%;width:100%}.announcement{align-items:center;background-color:var(--color-announcement-background);color:var(--color-announcement-text);display:flex;height:var(--header-height);overflow-x:auto}.announcement+.page{min-height:calc(100% - var(--header-height))}.announcement-content{box-sizing:border-box;min-width:100%;padding:.5rem;text-align:center;white-space:nowrap}.announcement-content a{color:var(--color-announcement-text);text-decoration-color:var(--color-announcement-text)}.announcement-content a:hover{color:var(--color-announcement-text);text-decoration-color:var(--color-link--hover)}.no-js .theme-toggle-container{display:none}.theme-toggle-container{vertical-align:middle}.theme-toggle{background:transparent;border:none;cursor:pointer;padding:0}.theme-toggle svg{color:var(--color-foreground-primary);display:none;height:1.25rem;vertical-align:middle;width:1.25rem}.theme-toggle-header{float:left;padding:1rem .5rem}.nav-overlay-icon,.toc-overlay-icon{cursor:pointer;display:none}.nav-overlay-icon .icon,.toc-overlay-icon .icon{color:var(--color-foreground-secondary);height:1.25rem;width:1.25rem}.nav-overlay-icon,.toc-header-icon{align-items:center;justify-content:center}.toc-content-icon{height:1.5rem;width:1.5rem}.content-icon-container{display:flex;float:right;gap:.5rem;margin-bottom:1rem;margin-left:1rem;margin-top:1.5rem}.content-icon-container .edit-this-page svg,.content-icon-container .view-this-page svg{color:inherit;height:1.25rem;width:1.25rem}.sidebar-toggle{display:none;position:absolute}.sidebar-toggle[name=__toc]{left:20px}.sidebar-toggle:checked{left:40px}.overlay{background-color:rgba(0,0,0,.54);height:0;opacity:0;position:fixed;top:0;transition:width 0ms,height 0ms,opacity .25s ease-out;width:0}.sidebar-overlay{z-index:20}.toc-overlay{z-index:40}.sidebar-drawer{transition:left .25s ease-in-out;z-index:30}.toc-drawer{transition:right .25s ease-in-out;z-index:50}#__navigation:checked~.sidebar-overlay{height:100%;opacity:1;width:100%}#__navigation:checked~.page .sidebar-drawer{left:0;top:0}#__toc:checked~.toc-overlay{height:100%;opacity:1;width:100%}#__toc:checked~.page .toc-drawer{right:0;top:0}.back-to-top{background:var(--color-background-primary);border-radius:1rem;box-shadow:0 .2rem .5rem rgba(0,0,0,.05),0 0 1px 0 hsla(220,9%,46%,.502);display:none;font-size:.8125rem;left:0;margin-left:50%;padding:.5rem .75rem .5rem .5rem;position:fixed;text-decoration:none;top:1rem;transform:translateX(-50%);z-index:10}.back-to-top svg{height:1rem;width:1rem;fill:currentColor;display:inline-block}.back-to-top span{margin-left:.25rem}.show-back-to-top .back-to-top{align-items:center;display:flex}@media(min-width:97em){html{font-size:110%}}@media(max-width:82em){.toc-content-icon{display:flex}.toc-drawer{border-left:1px solid var(--color-background-muted);height:100vh;position:fixed;right:-15em;top:0}.toc-tree{border-left:none;font-size:var(--toc-font-size--mobile)}.sidebar-drawer{width:calc(50% - 18.5em)}}@media(max-width:67em){.nav-overlay-icon{display:flex}.sidebar-drawer{height:100vh;left:-15em;position:fixed;top:0;width:15em}.toc-header-icon{display:flex}.theme-toggle-content,.toc-content-icon{display:none}.theme-toggle-header{display:block}.mobile-header{align-items:center;display:flex;justify-content:space-between;position:sticky;top:0}.mobile-header .header-left,.mobile-header .header-right{display:flex;height:var(--header-height);padding:0 var(--header-padding)}.mobile-header .header-left label,.mobile-header .header-right label{height:100%;-webkit-user-select:none;-moz-user-select:none;user-select:none;width:100%}.nav-overlay-icon .icon,.theme-toggle svg{height:1.25rem;width:1.25rem}:target{scroll-margin-top:calc(var(--header-height) + 2.5rem)}.back-to-top{top:calc(var(--header-height) + .5rem)}.page{flex-direction:column;justify-content:center}.content{margin-left:auto;margin-right:auto}}@media(max-width:52em){.content{overflow-x:auto;width:100%}}@media(max-width:46em){.content{padding:0 1em}article aside.sidebar{float:none;margin:1rem 0;width:100%}}.admonition,.topic{background:var(--color-admonition-background);border-radius:.2rem;box-shadow:0 .2rem .5rem rgba(0,0,0,.05),0 0 .0625rem rgba(0,0,0,.1);font-size:var(--admonition-font-size);margin:1rem auto;overflow:hidden;padding:0 .5rem .5rem;page-break-inside:avoid}.admonition>:nth-child(2),.topic>:nth-child(2){margin-top:0}.admonition>:last-child,.topic>:last-child{margin-bottom:0}.admonition p.admonition-title,p.topic-title{font-size:var(--admonition-title-font-size);font-weight:500;line-height:1.3;margin:0 -.5rem .5rem;padding:.4rem .5rem .4rem 2rem;position:relative}.admonition p.admonition-title:before,p.topic-title:before{content:"";height:1rem;left:.5rem;position:absolute;width:1rem}p.admonition-title{background-color:var(--color-admonition-title-background)}p.admonition-title:before{background-color:var(--color-admonition-title);-webkit-mask-image:var(--icon-admonition-default);mask-image:var(--icon-admonition-default);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat}p.topic-title{background-color:var(--color-topic-title-background)}p.topic-title:before{background-color:var(--color-topic-title);-webkit-mask-image:var(--icon-topic-default);mask-image:var(--icon-topic-default);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat}.admonition{border-left:.2rem solid var(--color-admonition-title)}.admonition.caution{border-left-color:var(--color-admonition-title--caution)}.admonition.caution>.admonition-title{background-color:var(--color-admonition-title-background--caution)}.admonition.caution>.admonition-title:before{background-color:var(--color-admonition-title--caution);-webkit-mask-image:var(--icon-spark);mask-image:var(--icon-spark)}.admonition.warning{border-left-color:var(--color-admonition-title--warning)}.admonition.warning>.admonition-title{background-color:var(--color-admonition-title-background--warning)}.admonition.warning>.admonition-title:before{background-color:var(--color-admonition-title--warning);-webkit-mask-image:var(--icon-warning);mask-image:var(--icon-warning)}.admonition.danger{border-left-color:var(--color-admonition-title--danger)}.admonition.danger>.admonition-title{background-color:var(--color-admonition-title-background--danger)}.admonition.danger>.admonition-title:before{background-color:var(--color-admonition-title--danger);-webkit-mask-image:var(--icon-spark);mask-image:var(--icon-spark)}.admonition.attention{border-left-color:var(--color-admonition-title--attention)}.admonition.attention>.admonition-title{background-color:var(--color-admonition-title-background--attention)}.admonition.attention>.admonition-title:before{background-color:var(--color-admonition-title--attention);-webkit-mask-image:var(--icon-warning);mask-image:var(--icon-warning)}.admonition.error{border-left-color:var(--color-admonition-title--error)}.admonition.error>.admonition-title{background-color:var(--color-admonition-title-background--error)}.admonition.error>.admonition-title:before{background-color:var(--color-admonition-title--error);-webkit-mask-image:var(--icon-failure);mask-image:var(--icon-failure)}.admonition.hint{border-left-color:var(--color-admonition-title--hint)}.admonition.hint>.admonition-title{background-color:var(--color-admonition-title-background--hint)}.admonition.hint>.admonition-title:before{background-color:var(--color-admonition-title--hint);-webkit-mask-image:var(--icon-question);mask-image:var(--icon-question)}.admonition.tip{border-left-color:var(--color-admonition-title--tip)}.admonition.tip>.admonition-title{background-color:var(--color-admonition-title-background--tip)}.admonition.tip>.admonition-title:before{background-color:var(--color-admonition-title--tip);-webkit-mask-image:var(--icon-info);mask-image:var(--icon-info)}.admonition.important{border-left-color:var(--color-admonition-title--important)}.admonition.important>.admonition-title{background-color:var(--color-admonition-title-background--important)}.admonition.important>.admonition-title:before{background-color:var(--color-admonition-title--important);-webkit-mask-image:var(--icon-flame);mask-image:var(--icon-flame)}.admonition.note{border-left-color:var(--color-admonition-title--note)}.admonition.note>.admonition-title{background-color:var(--color-admonition-title-background--note)}.admonition.note>.admonition-title:before{background-color:var(--color-admonition-title--note);-webkit-mask-image:var(--icon-pencil);mask-image:var(--icon-pencil)}.admonition.seealso{border-left-color:var(--color-admonition-title--seealso)}.admonition.seealso>.admonition-title{background-color:var(--color-admonition-title-background--seealso)}.admonition.seealso>.admonition-title:before{background-color:var(--color-admonition-title--seealso);-webkit-mask-image:var(--icon-info);mask-image:var(--icon-info)}.admonition.admonition-todo{border-left-color:var(--color-admonition-title--admonition-todo)}.admonition.admonition-todo>.admonition-title{background-color:var(--color-admonition-title-background--admonition-todo)}.admonition.admonition-todo>.admonition-title:before{background-color:var(--color-admonition-title--admonition-todo);-webkit-mask-image:var(--icon-pencil);mask-image:var(--icon-pencil)}.admonition-todo>.admonition-title{text-transform:uppercase}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dd{margin-left:2rem}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dd>:first-child{margin-top:.125rem}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list,dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dd>:last-child{margin-bottom:.75rem}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list>dt{font-size:var(--font-size--small);text-transform:uppercase}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list dd:empty{margin-bottom:.5rem}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list dd>ul{margin-left:-1.2rem}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list dd>ul>li>p:nth-child(2){margin-top:0}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list dd>ul>li>p+p:last-child:empty{margin-bottom:0;margin-top:0}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt{color:var(--color-api-overall)}.sig:not(.sig-inline){background:var(--color-api-background);border-radius:.25rem;font-family:var(--font-stack--monospace);font-size:var(--api-font-size);font-weight:700;margin-left:-.25rem;margin-right:-.25rem;padding:.25rem .5rem .25rem 3em;text-indent:-2.5em;transition:background .1s ease-out}.sig:not(.sig-inline):hover{background:var(--color-api-background-hover)}.sig:not(.sig-inline) a.reference .viewcode-link{font-weight:400;width:4.25rem}em.property{font-style:normal}em.property:first-child{color:var(--color-api-keyword)}.sig-name{color:var(--color-api-name)}.sig-prename{color:var(--color-api-pre-name);font-weight:400}.sig-paren{color:var(--color-api-paren)}.sig-param{font-style:normal}div.deprecated,div.versionadded,div.versionchanged,div.versionremoved{border-left:.1875rem solid;border-radius:.125rem;padding-left:.75rem}div.deprecated p,div.versionadded p,div.versionchanged p,div.versionremoved p{margin-bottom:.125rem;margin-top:.125rem}div.versionadded{border-color:var(--color-api-added-border)}div.versionadded .versionmodified{color:var(--color-api-added)}div.versionchanged{border-color:var(--color-api-changed-border)}div.versionchanged .versionmodified{color:var(--color-api-changed)}div.deprecated{border-color:var(--color-api-deprecated-border)}div.deprecated .versionmodified{color:var(--color-api-deprecated)}div.versionremoved{border-color:var(--color-api-removed-border)}div.versionremoved .versionmodified{color:var(--color-api-removed)}.viewcode-back,.viewcode-link{float:right;text-align:right}.line-block{margin-bottom:.75rem;margin-top:.5rem}.line-block .line-block{margin-bottom:0;margin-top:0;padding-left:1rem}.code-block-caption,article p.caption,table>caption{font-size:var(--font-size--small);text-align:center}.toctree-wrapper.compound .caption,.toctree-wrapper.compound :not(.caption)>.caption-text{font-size:var(--font-size--small);margin-bottom:0;text-align:initial;text-transform:uppercase}.toctree-wrapper.compound>ul{margin-bottom:0;margin-top:0}.sig-inline,code.literal{background:var(--color-inline-code-background);border-radius:.2em;font-size:var(--font-size--small--2);padding:.1em .2em}pre.literal-block .sig-inline,pre.literal-block code.literal{font-size:inherit;padding:0}p .sig-inline,p code.literal{border:1px solid var(--color-background-border)}.sig-inline{font-family:var(--font-stack--monospace)}div[class*=" highlight-"],div[class^=highlight-]{display:flex;margin:1em 0}div[class*=" highlight-"] .table-wrapper,div[class^=highlight-] .table-wrapper,pre{margin:0;padding:0}pre{overflow:auto}article[role=main] .highlight pre{line-height:1.5}.highlight pre,pre.literal-block{font-size:var(--code-font-size);padding:.625rem .875rem}pre.literal-block{background-color:var(--color-code-background);border-radius:.2rem;color:var(--color-code-foreground);margin-bottom:1rem;margin-top:1rem}.highlight{border-radius:.2rem;width:100%}.highlight .gp,.highlight span.linenos{pointer-events:none;-webkit-user-select:none;-moz-user-select:none;user-select:none}.highlight .hll{display:block;margin-left:-.875rem;margin-right:-.875rem;padding-left:.875rem;padding-right:.875rem}.code-block-caption{background-color:var(--color-code-background);border-bottom:1px solid;border-radius:.25rem;border-bottom-left-radius:0;border-bottom-right-radius:0;border-color:var(--color-background-border);color:var(--color-code-foreground);display:flex;font-weight:300;padding:.625rem .875rem}.code-block-caption+div[class]{margin-top:0}.code-block-caption+div[class] pre{border-top-left-radius:0;border-top-right-radius:0}.highlighttable{display:block;width:100%}.highlighttable tbody{display:block}.highlighttable tr{display:flex}.highlighttable td.linenos{background-color:var(--color-code-background);border-bottom-left-radius:.2rem;border-top-left-radius:.2rem;color:var(--color-code-foreground);padding:.625rem 0 .625rem .875rem}.highlighttable .linenodiv{box-shadow:-.0625rem 0 var(--color-foreground-border) inset;font-size:var(--code-font-size);padding-right:.875rem}.highlighttable td.code{display:block;flex:1;overflow:hidden;padding:0}.highlighttable td.code .highlight{border-bottom-left-radius:0;border-top-left-radius:0}.highlight span.linenos{box-shadow:-.0625rem 0 var(--color-foreground-border) inset;display:inline-block;margin-right:.875rem;padding-left:0;padding-right:.875rem}.footnote-reference{font-size:var(--font-size--small--4);vertical-align:super}dl.footnote.brackets{color:var(--color-foreground-secondary);display:grid;font-size:var(--font-size--small);grid-template-columns:max-content auto}dl.footnote.brackets dt{margin:0}dl.footnote.brackets dt>.fn-backref{margin-left:.25rem}dl.footnote.brackets dt:after{content:":"}dl.footnote.brackets dt .brackets:before{content:"["}dl.footnote.brackets dt .brackets:after{content:"]"}dl.footnote.brackets dd{margin:0;padding:0 1rem}aside.footnote{color:var(--color-foreground-secondary);font-size:var(--font-size--small)}aside.footnote>span,div.citation>span{float:left;font-weight:500;padding-right:.25rem}aside.footnote>:not(span),div.citation>p{margin-left:2rem}img{box-sizing:border-box;height:auto;max-width:100%}article .figure,article figure{border-radius:.2rem;margin:0}article .figure :last-child,article figure :last-child{margin-bottom:0}article .align-left{clear:left;float:left;margin:0 1rem 1rem}article .align-right{clear:right;float:right;margin:0 1rem 1rem}article .align-center,article .align-default{display:block;margin-left:auto;margin-right:auto;text-align:center}article table.align-default{display:table;text-align:initial}.domainindex-jumpbox,.genindex-jumpbox{border-bottom:1px solid var(--color-background-border);border-top:1px solid var(--color-background-border);padding:.25rem}.domainindex-section h2,.genindex-section h2{margin-bottom:.5rem;margin-top:.75rem}.domainindex-section ul,.genindex-section ul{margin-bottom:0;margin-top:0}ol,ul{margin-bottom:1rem;margin-top:1rem;padding-left:1.2rem}ol li>p:first-child,ul li>p:first-child{margin-bottom:.25rem;margin-top:.25rem}ol li>p:last-child,ul li>p:last-child{margin-top:.25rem}ol li>ol,ol li>ul,ul li>ol,ul li>ul{margin-bottom:.5rem;margin-top:.5rem}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}.simple li>ol,.simple li>ul,.toctree-wrapper li>ol,.toctree-wrapper li>ul{margin-bottom:0;margin-top:0}.field-list dt,.option-list dt,dl.footnote dt,dl.glossary dt,dl.simple dt,dl:not([class]) dt{font-weight:500;margin-top:.25rem}.field-list dt+dt,.option-list dt+dt,dl.footnote dt+dt,dl.glossary dt+dt,dl.simple dt+dt,dl:not([class]) dt+dt{margin-top:0}.field-list dt .classifier:before,.option-list dt .classifier:before,dl.footnote dt .classifier:before,dl.glossary dt .classifier:before,dl.simple dt .classifier:before,dl:not([class]) dt .classifier:before{content:":";margin-left:.2rem;margin-right:.2rem}.field-list dd ul,.field-list dd>p:first-child,.option-list dd ul,.option-list dd>p:first-child,dl.footnote dd ul,dl.footnote dd>p:first-child,dl.glossary dd ul,dl.glossary dd>p:first-child,dl.simple dd ul,dl.simple dd>p:first-child,dl:not([class]) dd ul,dl:not([class]) dd>p:first-child{margin-top:.125rem}.field-list dd ul,.option-list dd ul,dl.footnote dd ul,dl.glossary dd ul,dl.simple dd ul,dl:not([class]) dd ul{margin-bottom:.125rem}.math-wrapper{overflow-x:auto;width:100%}div.math{position:relative;text-align:center}div.math .headerlink,div.math:focus .headerlink{display:none}div.math:hover .headerlink{display:inline-block}div.math span.eqno{position:absolute;right:.5rem;top:50%;transform:translateY(-50%);z-index:1}abbr[title]{cursor:help}.problematic{color:var(--color-problematic)}kbd:not(.compound){background-color:var(--color-background-secondary);border:1px solid var(--color-foreground-border);border-radius:.2rem;box-shadow:0 .0625rem 0 rgba(0,0,0,.2),inset 0 0 0 .125rem var(--color-background-primary);color:var(--color-foreground-primary);display:inline-block;font-size:var(--font-size--small--3);margin:0 .2rem;padding:0 .2rem;vertical-align:text-bottom}blockquote{background:var(--color-background-secondary);border-left:4px solid var(--color-background-border);margin-left:0;margin-right:0;padding:.5rem 1rem}blockquote .attribution{font-weight:600;text-align:right}blockquote.highlights,blockquote.pull-quote{font-size:1.25em}blockquote.epigraph,blockquote.pull-quote{border-left-width:0;border-radius:.5rem}blockquote.highlights{background:transparent;border-left-width:0}p .reference img{vertical-align:middle}p.rubric{font-size:1.125em;font-weight:700;line-height:1.25}dd p.rubric{font-size:var(--font-size--small);font-weight:inherit;line-height:inherit;text-transform:uppercase}article .sidebar{background-color:var(--color-background-secondary);border:1px solid var(--color-background-border);border-radius:.2rem;clear:right;float:right;margin-left:1rem;margin-right:0;width:30%}article .sidebar>*{padding-left:1rem;padding-right:1rem}article .sidebar>ol,article .sidebar>ul{padding-left:2.2rem}article .sidebar .sidebar-title{border-bottom:1px solid var(--color-background-border);font-weight:500;margin:0;padding:.5rem 1rem}.table-wrapper{margin-bottom:.5rem;margin-top:1rem;overflow-x:auto;padding:.2rem .2rem .75rem;width:100%}table.docutils{border-collapse:collapse;border-radius:.2rem;border-spacing:0;box-shadow:0 .2rem .5rem rgba(0,0,0,.05),0 0 .0625rem rgba(0,0,0,.1)}table.docutils th{background:var(--color-table-header-background)}table.docutils td,table.docutils th{border-bottom:1px solid var(--color-table-border);border-left:1px solid var(--color-table-border);border-right:1px solid var(--color-table-border);padding:0 .25rem}table.docutils td p,table.docutils th p{margin:.25rem}table.docutils td:first-child,table.docutils th:first-child{border-left:none}table.docutils td:last-child,table.docutils th:last-child{border-right:none}table.docutils td.text-left,table.docutils th.text-left{text-align:left}table.docutils td.text-right,table.docutils th.text-right{text-align:right}table.docutils td.text-center,table.docutils th.text-center{text-align:center}:target{scroll-margin-top:2.5rem}@media(max-width:67em){:target{scroll-margin-top:calc(2.5rem + var(--header-height))}section>span:target{scroll-margin-top:calc(2.8rem + var(--header-height))}}.headerlink{font-weight:100;-webkit-user-select:none;-moz-user-select:none;user-select:none}.code-block-caption>.headerlink,dl dt>.headerlink,figcaption p>.headerlink,h1>.headerlink,h2>.headerlink,h3>.headerlink,h4>.headerlink,h5>.headerlink,h6>.headerlink,p.caption>.headerlink,table>caption>.headerlink{margin-left:.5rem;visibility:hidden}.code-block-caption:hover>.headerlink,dl dt:hover>.headerlink,figcaption p:hover>.headerlink,h1:hover>.headerlink,h2:hover>.headerlink,h3:hover>.headerlink,h4:hover>.headerlink,h5:hover>.headerlink,h6:hover>.headerlink,p.caption:hover>.headerlink,table>caption:hover>.headerlink{visibility:visible}.code-block-caption>.toc-backref,dl dt>.toc-backref,figcaption p>.toc-backref,h1>.toc-backref,h2>.toc-backref,h3>.toc-backref,h4>.toc-backref,h5>.toc-backref,h6>.toc-backref,p.caption>.toc-backref,table>caption>.toc-backref{color:inherit;text-decoration-line:none}figure:hover>figcaption>p>.headerlink,table:hover>caption>.headerlink{visibility:visible}:target>h1:first-of-type,:target>h2:first-of-type,:target>h3:first-of-type,:target>h4:first-of-type,:target>h5:first-of-type,:target>h6:first-of-type,span:target~h1:first-of-type,span:target~h2:first-of-type,span:target~h3:first-of-type,span:target~h4:first-of-type,span:target~h5:first-of-type,span:target~h6:first-of-type{background-color:var(--color-highlight-on-target)}:target>h1:first-of-type code.literal,:target>h2:first-of-type code.literal,:target>h3:first-of-type code.literal,:target>h4:first-of-type code.literal,:target>h5:first-of-type code.literal,:target>h6:first-of-type code.literal,span:target~h1:first-of-type code.literal,span:target~h2:first-of-type code.literal,span:target~h3:first-of-type code.literal,span:target~h4:first-of-type code.literal,span:target~h5:first-of-type code.literal,span:target~h6:first-of-type code.literal{background-color:transparent}.literal-block-wrapper:target .code-block-caption,.this-will-duplicate-information-and-it-is-still-useful-here li :target,figure:target,table:target>caption{background-color:var(--color-highlight-on-target)}dt:target{background-color:var(--color-highlight-on-target)!important}.footnote-reference:target,.footnote>dt:target+dd{background-color:var(--color-highlight-on-target)}.guilabel{background-color:var(--color-guilabel-background);border:1px solid var(--color-guilabel-border);border-radius:.5em;color:var(--color-guilabel-text);font-size:.9em;padding:0 .3em}footer{display:flex;flex-direction:column;font-size:var(--font-size--small);margin-top:2rem}.bottom-of-page{align-items:center;border-top:1px solid var(--color-background-border);color:var(--color-foreground-secondary);display:flex;justify-content:space-between;line-height:1.5;margin-top:1rem;padding-bottom:1rem;padding-top:1rem}@media(max-width:46em){.bottom-of-page{flex-direction:column-reverse;gap:.25rem;text-align:center}}.bottom-of-page .left-details{font-size:var(--font-size--small)}.bottom-of-page .right-details{display:flex;flex-direction:column;gap:.25rem;text-align:right}.bottom-of-page .icons{display:flex;font-size:1rem;gap:.25rem;justify-content:flex-end}.bottom-of-page .icons a{text-decoration:none}.bottom-of-page .icons img,.bottom-of-page .icons svg{font-size:1.125rem;height:1em;width:1em}.related-pages a{align-items:center;display:flex;text-decoration:none}.related-pages a:hover .page-info .title{color:var(--color-link);text-decoration:underline;text-decoration-color:var(--color-link-underline)}.related-pages a svg.furo-related-icon,.related-pages a svg.furo-related-icon>use{color:var(--color-foreground-border);flex-shrink:0;height:.75rem;margin:0 .5rem;width:.75rem}.related-pages a.next-page{clear:right;float:right;max-width:50%;text-align:right}.related-pages a.prev-page{clear:left;float:left;max-width:50%}.related-pages a.prev-page svg{transform:rotate(180deg)}.page-info{display:flex;flex-direction:column;overflow-wrap:anywhere}.next-page .page-info{align-items:flex-end}.page-info .context{align-items:center;color:var(--color-foreground-muted);display:flex;font-size:var(--font-size--small);padding-bottom:.1rem;text-decoration:none}ul.search{list-style:none;padding-left:0}ul.search li{border-bottom:1px solid var(--color-background-border);padding:1rem 0}[role=main] .highlighted{background-color:var(--color-highlighted-background);color:var(--color-highlighted-text)}.sidebar-brand{display:flex;flex-direction:column;flex-shrink:0;padding:var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal);text-decoration:none}.sidebar-brand-text{color:var(--color-sidebar-brand-text);font-size:1.5rem;overflow-wrap:break-word}.sidebar-brand-text,.sidebar-logo-container{margin:var(--sidebar-item-spacing-vertical) 0}.sidebar-logo{display:block;margin:0 auto;max-width:100%}.sidebar-search-container{align-items:center;background:var(--color-sidebar-search-background);display:flex;margin-top:var(--sidebar-search-space-above);position:relative}.sidebar-search-container:focus-within,.sidebar-search-container:hover{background:var(--color-sidebar-search-background--focus)}.sidebar-search-container:before{background-color:var(--color-sidebar-search-icon);content:"";height:var(--sidebar-search-icon-size);left:var(--sidebar-item-spacing-horizontal);-webkit-mask-image:var(--icon-search);mask-image:var(--icon-search);position:absolute;width:var(--sidebar-search-icon-size)}.sidebar-search{background:transparent;border:none;border-bottom:1px solid var(--color-sidebar-search-border);border-top:1px solid var(--color-sidebar-search-border);box-sizing:border-box;color:var(--color-sidebar-search-foreground);padding:var(--sidebar-search-input-spacing-vertical) var(--sidebar-search-input-spacing-horizontal) var(--sidebar-search-input-spacing-vertical) calc(var(--sidebar-item-spacing-horizontal) + var(--sidebar-search-input-spacing-horizontal) + var(--sidebar-search-icon-size));width:100%;z-index:10}.sidebar-search:focus{outline:none}.sidebar-search::-moz-placeholder{font-size:var(--sidebar-search-input-font-size)}.sidebar-search::placeholder{font-size:var(--sidebar-search-input-font-size)}#searchbox .highlight-link{margin:0;padding:var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal) 0;text-align:center}#searchbox .highlight-link a{color:var(--color-sidebar-search-icon);font-size:var(--font-size--small--2)}.sidebar-tree{font-size:var(--sidebar-item-font-size);margin-bottom:var(--sidebar-item-spacing-vertical);margin-top:var(--sidebar-tree-space-above)}.sidebar-tree ul{display:flex;flex-direction:column;list-style:none;margin-bottom:0;margin-top:0;padding:0}.sidebar-tree li{margin:0;position:relative}.sidebar-tree li>ul{margin-left:var(--sidebar-item-spacing-horizontal)}.sidebar-tree .icon,.sidebar-tree .reference{color:var(--color-sidebar-link-text)}.sidebar-tree .reference{box-sizing:border-box;display:inline-block;height:100%;line-height:var(--sidebar-item-line-height);overflow-wrap:anywhere;padding:var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal);text-decoration:none;width:100%}.sidebar-tree .reference:hover{background:var(--color-sidebar-item-background--hover);color:var(--color-sidebar-link-text)}.sidebar-tree .reference.external:after{color:var(--color-sidebar-link-text);content:url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' width='12' height='12' fill='none' stroke='%23607D8B' stroke-linecap='round' stroke-linejoin='round' stroke-width='1.5' viewBox='0 0 24 24'%3E%3Cpath stroke='none' d='M0 0h24v24H0z'/%3E%3Cpath d='M11 7H6a2 2 0 0 0-2 2v9a2 2 0 0 0 2 2h9a2 2 0 0 0 2-2v-5M10 14 20 4M15 4h5v5'/%3E%3C/svg%3E");margin:0 .25rem;vertical-align:middle}.sidebar-tree .current-page>.reference{font-weight:700}.sidebar-tree label{align-items:center;cursor:pointer;display:flex;height:var(--sidebar-item-height);justify-content:center;position:absolute;right:0;top:0;-webkit-user-select:none;-moz-user-select:none;user-select:none;width:var(--sidebar-expander-width)}.sidebar-tree .caption,.sidebar-tree :not(.caption)>.caption-text{color:var(--color-sidebar-caption-text);font-size:var(--sidebar-caption-font-size);font-weight:700;margin:var(--sidebar-caption-space-above) 0 0 0;padding:var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal);text-transform:uppercase}.sidebar-tree li.has-children>.reference{padding-right:var(--sidebar-expander-width)}.sidebar-tree .toctree-l1>.reference,.sidebar-tree .toctree-l1>label .icon{color:var(--color-sidebar-link-text--top-level)}.sidebar-tree label{background:var(--color-sidebar-item-expander-background)}.sidebar-tree label:hover{background:var(--color-sidebar-item-expander-background--hover)}.sidebar-tree .current>.reference{background:var(--color-sidebar-item-background--current)}.sidebar-tree .current>.reference:hover{background:var(--color-sidebar-item-background--hover)}.toctree-checkbox{display:none;position:absolute}.toctree-checkbox~ul{display:none}.toctree-checkbox~label .icon svg{transform:rotate(90deg)}.toctree-checkbox:checked~ul{display:block}.toctree-checkbox:checked~label .icon svg{transform:rotate(-90deg)}.toc-title-container{padding:var(--toc-title-padding);padding-top:var(--toc-spacing-vertical)}.toc-title{color:var(--color-toc-title-text);font-size:var(--toc-title-font-size);padding-left:var(--toc-spacing-horizontal);text-transform:uppercase}.no-toc{display:none}.toc-tree-container{padding-bottom:var(--toc-spacing-vertical)}.toc-tree{border-left:1px solid var(--color-background-border);font-size:var(--toc-font-size);line-height:1.3;padding-left:calc(var(--toc-spacing-horizontal) - var(--toc-item-spacing-horizontal))}.toc-tree>ul>li:first-child{padding-top:0}.toc-tree>ul>li:first-child>ul{padding-left:0}.toc-tree>ul>li:first-child>a{display:none}.toc-tree ul{list-style-type:none;margin-bottom:0;margin-top:0;padding-left:var(--toc-item-spacing-horizontal)}.toc-tree li{padding-top:var(--toc-item-spacing-vertical)}.toc-tree li.scroll-current>.reference{color:var(--color-toc-item-text--active);font-weight:700}.toc-tree a.reference{color:var(--color-toc-item-text);overflow-wrap:anywhere;text-decoration:none}.toc-scroll{max-height:100vh;overflow-y:scroll}.contents:not(.this-will-duplicate-information-and-it-is-still-useful-here){background:rgba(255,0,0,.25);color:var(--color-problematic)}.contents:not(.this-will-duplicate-information-and-it-is-still-useful-here):before{content:"ERROR: Adding a table of contents in Furo-based documentation is unnecessary, and does not work well with existing styling. Add a 'this-will-duplicate-information-and-it-is-still-useful-here' class, if you want an escape hatch."}.text-align\:left>p{text-align:left}.text-align\:center>p{text-align:center}.text-align\:right>p{text-align:right} +/*! normalize.css v8.0.1 | MIT License | github.com/necolas/normalize.css */html{line-height:1.15;-webkit-text-size-adjust:100%}body{margin:0}main{display:block}h1{font-size:2em;margin:.67em 0}hr{box-sizing:content-box;height:0;overflow:visible}pre{font-family:monospace,monospace;font-size:1em}a{background-color:transparent}abbr[title]{border-bottom:none;text-decoration:underline;text-decoration:underline dotted}b,strong{font-weight:bolder}code,kbd,samp{font-family:monospace,monospace;font-size:1em}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}img{border-style:none}button,input,optgroup,select,textarea{font-family:inherit;font-size:100%;line-height:1.15;margin:0}button,input{overflow:visible}button,select{text-transform:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]::-moz-focus-inner,[type=reset]::-moz-focus-inner,[type=submit]::-moz-focus-inner,button::-moz-focus-inner{border-style:none;padding:0}[type=button]:-moz-focusring,[type=reset]:-moz-focusring,[type=submit]:-moz-focusring,button:-moz-focusring{outline:1px dotted ButtonText}fieldset{padding:.35em .75em .625em}legend{box-sizing:border-box;color:inherit;display:table;max-width:100%;padding:0;white-space:normal}progress{vertical-align:baseline}textarea{overflow:auto}[type=checkbox],[type=radio]{box-sizing:border-box;padding:0}[type=number]::-webkit-inner-spin-button,[type=number]::-webkit-outer-spin-button{height:auto}[type=search]{-webkit-appearance:textfield;outline-offset:-2px}[type=search]::-webkit-search-decoration{-webkit-appearance:none}::-webkit-file-upload-button{-webkit-appearance:button;font:inherit}details{display:block}summary{display:list-item}[hidden],template{display:none}@media print{.content-icon-container,.headerlink,.mobile-header,.related-pages{display:none!important}.highlight{border:.1pt solid var(--color-foreground-border)}a,blockquote,dl,ol,p,pre,table,ul{page-break-inside:avoid}caption,figure,h1,h2,h3,h4,h5,h6,img{page-break-after:avoid;page-break-inside:avoid}dl,ol,ul{page-break-before:avoid}}.visually-hidden{height:1px!important;margin:-1px!important;overflow:hidden!important;padding:0!important;position:absolute!important;width:1px!important;clip:rect(0,0,0,0)!important;background:var(--color-background-primary);border:0!important;color:var(--color-foreground-primary);white-space:nowrap!important}:-moz-focusring{outline:auto}body{--font-stack:-apple-system,BlinkMacSystemFont,Segoe UI,Helvetica,Arial,sans-serif,Apple Color Emoji,Segoe UI Emoji;--font-stack--monospace:"SFMono-Regular",Menlo,Consolas,Monaco,Liberation Mono,Lucida Console,monospace;--font-stack--headings:var(--font-stack);--font-size--normal:100%;--font-size--small:87.5%;--font-size--small--2:81.25%;--font-size--small--3:75%;--font-size--small--4:62.5%;--sidebar-caption-font-size:var(--font-size--small--2);--sidebar-item-font-size:var(--font-size--small);--sidebar-search-input-font-size:var(--font-size--small);--toc-font-size:var(--font-size--small--3);--toc-font-size--mobile:var(--font-size--normal);--toc-title-font-size:var(--font-size--small--4);--admonition-font-size:0.8125rem;--admonition-title-font-size:0.8125rem;--code-font-size:var(--font-size--small--2);--api-font-size:var(--font-size--small);--header-height:calc(var(--sidebar-item-line-height) + var(--sidebar-item-spacing-vertical)*4);--header-padding:0.5rem;--sidebar-tree-space-above:1.5rem;--sidebar-caption-space-above:1rem;--sidebar-item-line-height:1rem;--sidebar-item-spacing-vertical:0.5rem;--sidebar-item-spacing-horizontal:1rem;--sidebar-item-height:calc(var(--sidebar-item-line-height) + var(--sidebar-item-spacing-vertical)*2);--sidebar-expander-width:var(--sidebar-item-height);--sidebar-search-space-above:0.5rem;--sidebar-search-input-spacing-vertical:0.5rem;--sidebar-search-input-spacing-horizontal:0.5rem;--sidebar-search-input-height:1rem;--sidebar-search-icon-size:var(--sidebar-search-input-height);--toc-title-padding:0.25rem 0;--toc-spacing-vertical:1.5rem;--toc-spacing-horizontal:1.5rem;--toc-item-spacing-vertical:0.4rem;--toc-item-spacing-horizontal:1rem;--icon-search:url('data:image/svg+xml;charset=utf-8,');--icon-pencil:url('data:image/svg+xml;charset=utf-8,');--icon-abstract:url('data:image/svg+xml;charset=utf-8,');--icon-info:url('data:image/svg+xml;charset=utf-8,');--icon-flame:url('data:image/svg+xml;charset=utf-8,');--icon-question:url('data:image/svg+xml;charset=utf-8,');--icon-warning:url('data:image/svg+xml;charset=utf-8,');--icon-failure:url('data:image/svg+xml;charset=utf-8,');--icon-spark:url('data:image/svg+xml;charset=utf-8,');--color-admonition-title--caution:#ff9100;--color-admonition-title-background--caution:rgba(255,145,0,.2);--color-admonition-title--warning:#ff9100;--color-admonition-title-background--warning:rgba(255,145,0,.2);--color-admonition-title--danger:#ff5252;--color-admonition-title-background--danger:rgba(255,82,82,.2);--color-admonition-title--attention:#ff5252;--color-admonition-title-background--attention:rgba(255,82,82,.2);--color-admonition-title--error:#ff5252;--color-admonition-title-background--error:rgba(255,82,82,.2);--color-admonition-title--hint:#00c852;--color-admonition-title-background--hint:rgba(0,200,82,.2);--color-admonition-title--tip:#00c852;--color-admonition-title-background--tip:rgba(0,200,82,.2);--color-admonition-title--important:#00bfa5;--color-admonition-title-background--important:rgba(0,191,165,.2);--color-admonition-title--note:#00b0ff;--color-admonition-title-background--note:rgba(0,176,255,.2);--color-admonition-title--seealso:#448aff;--color-admonition-title-background--seealso:rgba(68,138,255,.2);--color-admonition-title--admonition-todo:grey;--color-admonition-title-background--admonition-todo:hsla(0,0%,50%,.2);--color-admonition-title:#651fff;--color-admonition-title-background:rgba(101,31,255,.2);--icon-admonition-default:var(--icon-abstract);--color-topic-title:#14b8a6;--color-topic-title-background:rgba(20,184,166,.2);--icon-topic-default:var(--icon-pencil);--color-problematic:#b30000;--color-foreground-primary:#000;--color-foreground-secondary:#5a5c63;--color-foreground-muted:#6b6f76;--color-foreground-border:#878787;--color-background-primary:#fff;--color-background-secondary:#f8f9fb;--color-background-hover:#efeff4;--color-background-hover--transparent:#efeff400;--color-background-border:#eeebee;--color-background-item:#ccc;--color-announcement-background:#000000dd;--color-announcement-text:#eeebee;--color-brand-primary:#0a4bff;--color-brand-content:#2757dd;--color-brand-visited:#872ee0;--color-api-background:var(--color-background-hover--transparent);--color-api-background-hover:var(--color-background-hover);--color-api-overall:var(--color-foreground-secondary);--color-api-name:var(--color-problematic);--color-api-pre-name:var(--color-problematic);--color-api-paren:var(--color-foreground-secondary);--color-api-keyword:var(--color-foreground-primary);--color-api-added:#21632c;--color-api-added-border:#38a84d;--color-api-changed:#046172;--color-api-changed-border:#06a1bc;--color-api-deprecated:#605706;--color-api-deprecated-border:#f0d90f;--color-api-removed:#b30000;--color-api-removed-border:#ff5c5c;--color-highlight-on-target:#ffc;--color-inline-code-background:var(--color-background-secondary);--color-highlighted-background:#def;--color-highlighted-text:var(--color-foreground-primary);--color-guilabel-background:#ddeeff80;--color-guilabel-border:#bedaf580;--color-guilabel-text:var(--color-foreground-primary);--color-admonition-background:transparent;--color-table-header-background:var(--color-background-secondary);--color-table-border:var(--color-background-border);--color-card-border:var(--color-background-secondary);--color-card-background:transparent;--color-card-marginals-background:var(--color-background-secondary);--color-header-background:var(--color-background-primary);--color-header-border:var(--color-background-border);--color-header-text:var(--color-foreground-primary);--color-sidebar-background:var(--color-background-secondary);--color-sidebar-background-border:var(--color-background-border);--color-sidebar-brand-text:var(--color-foreground-primary);--color-sidebar-caption-text:var(--color-foreground-muted);--color-sidebar-link-text:var(--color-foreground-secondary);--color-sidebar-link-text--top-level:var(--color-brand-primary);--color-sidebar-item-background:var(--color-sidebar-background);--color-sidebar-item-background--current:var( --color-sidebar-item-background );--color-sidebar-item-background--hover:linear-gradient(90deg,var(--color-background-hover--transparent) 0%,var(--color-background-hover) var(--sidebar-item-spacing-horizontal),var(--color-background-hover) 100%);--color-sidebar-item-expander-background:transparent;--color-sidebar-item-expander-background--hover:var( --color-background-hover );--color-sidebar-search-text:var(--color-foreground-primary);--color-sidebar-search-background:var(--color-background-secondary);--color-sidebar-search-background--focus:var(--color-background-primary);--color-sidebar-search-border:var(--color-background-border);--color-sidebar-search-icon:var(--color-foreground-muted);--color-toc-background:var(--color-background-primary);--color-toc-title-text:var(--color-foreground-muted);--color-toc-item-text:var(--color-foreground-secondary);--color-toc-item-text--hover:var(--color-foreground-primary);--color-toc-item-text--active:var(--color-brand-primary);--color-content-foreground:var(--color-foreground-primary);--color-content-background:transparent;--color-link:var(--color-brand-content);--color-link-underline:var(--color-background-border);--color-link--hover:var(--color-brand-content);--color-link-underline--hover:var(--color-foreground-border);--color-link--visited:var(--color-brand-visited);--color-link-underline--visited:var(--color-background-border);--color-link--visited--hover:var(--color-brand-visited);--color-link-underline--visited--hover:var(--color-foreground-border)}.only-light{display:block!important}html body .only-dark{display:none!important}@media not print{body[data-theme=dark]{--color-problematic:#ee5151;--color-foreground-primary:#cfd0d0;--color-foreground-secondary:#9ca0a5;--color-foreground-muted:#81868d;--color-foreground-border:#666;--color-background-primary:#131416;--color-background-secondary:#1a1c1e;--color-background-hover:#1e2124;--color-background-hover--transparent:#1e212400;--color-background-border:#303335;--color-background-item:#444;--color-announcement-background:#000000dd;--color-announcement-text:#eeebee;--color-brand-primary:#3d94ff;--color-brand-content:#5ca5ff;--color-brand-visited:#b27aeb;--color-highlighted-background:#083563;--color-guilabel-background:#08356380;--color-guilabel-border:#13395f80;--color-api-keyword:var(--color-foreground-secondary);--color-highlight-on-target:#330;--color-api-added:#3db854;--color-api-added-border:#267334;--color-api-changed:#09b0ce;--color-api-changed-border:#056d80;--color-api-deprecated:#b1a10b;--color-api-deprecated-border:#6e6407;--color-api-removed:#ff7575;--color-api-removed-border:#b03b3b;--color-admonition-background:#18181a;--color-card-border:var(--color-background-secondary);--color-card-background:#18181a;--color-card-marginals-background:var(--color-background-hover)}html body[data-theme=dark] .only-light{display:none!important}body[data-theme=dark] .only-dark{display:block!important}@media(prefers-color-scheme:dark){body:not([data-theme=light]){--color-problematic:#ee5151;--color-foreground-primary:#cfd0d0;--color-foreground-secondary:#9ca0a5;--color-foreground-muted:#81868d;--color-foreground-border:#666;--color-background-primary:#131416;--color-background-secondary:#1a1c1e;--color-background-hover:#1e2124;--color-background-hover--transparent:#1e212400;--color-background-border:#303335;--color-background-item:#444;--color-announcement-background:#000000dd;--color-announcement-text:#eeebee;--color-brand-primary:#3d94ff;--color-brand-content:#5ca5ff;--color-brand-visited:#b27aeb;--color-highlighted-background:#083563;--color-guilabel-background:#08356380;--color-guilabel-border:#13395f80;--color-api-keyword:var(--color-foreground-secondary);--color-highlight-on-target:#330;--color-api-added:#3db854;--color-api-added-border:#267334;--color-api-changed:#09b0ce;--color-api-changed-border:#056d80;--color-api-deprecated:#b1a10b;--color-api-deprecated-border:#6e6407;--color-api-removed:#ff7575;--color-api-removed-border:#b03b3b;--color-admonition-background:#18181a;--color-card-border:var(--color-background-secondary);--color-card-background:#18181a;--color-card-marginals-background:var(--color-background-hover)}html body:not([data-theme=light]) .only-light{display:none!important}body:not([data-theme=light]) .only-dark{display:block!important}}}body[data-theme=auto] .theme-toggle svg.theme-icon-when-auto-light{display:block}@media(prefers-color-scheme:dark){body[data-theme=auto] .theme-toggle svg.theme-icon-when-auto-dark{display:block}body[data-theme=auto] .theme-toggle svg.theme-icon-when-auto-light{display:none}}body[data-theme=dark] .theme-toggle svg.theme-icon-when-dark,body[data-theme=light] .theme-toggle svg.theme-icon-when-light{display:block}body{font-family:var(--font-stack)}code,kbd,pre,samp{font-family:var(--font-stack--monospace)}body{-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}article{line-height:1.5}h1,h2,h3,h4,h5,h6{border-radius:.5rem;font-family:var(--font-stack--headings);font-weight:700;line-height:1.25;margin:.5rem -.5rem;padding-left:.5rem;padding-right:.5rem}h1+p,h2+p,h3+p,h4+p,h5+p,h6+p{margin-top:0}h1{font-size:2.5em;margin-bottom:1rem}h1,h2{margin-top:1.75rem}h2{font-size:2em}h3{font-size:1.5em}h4{font-size:1.25em}h5{font-size:1.125em}h6{font-size:1em}small{font-size:80%;opacity:75%}p{margin-bottom:.75rem;margin-top:.5rem}hr.docutils{background-color:var(--color-background-border);border:0;height:1px;margin:2rem 0;padding:0}.centered{text-align:center}a{color:var(--color-link);text-decoration:underline;text-decoration-color:var(--color-link-underline)}a:visited{color:var(--color-link--visited);text-decoration-color:var(--color-link-underline--visited)}a:visited:hover{color:var(--color-link--visited--hover);text-decoration-color:var(--color-link-underline--visited--hover)}a:hover{color:var(--color-link--hover);text-decoration-color:var(--color-link-underline--hover)}a.muted-link{color:inherit}a.muted-link:hover{color:var(--color-link--hover);text-decoration-color:var(--color-link-underline--hover)}a.muted-link:hover:visited{color:var(--color-link--visited--hover);text-decoration-color:var(--color-link-underline--visited--hover)}html{overflow-x:hidden;overflow-y:scroll;scroll-behavior:smooth}.sidebar-scroll,.toc-scroll,article[role=main] *{scrollbar-color:var(--color-foreground-border) transparent;scrollbar-width:thin}.sidebar-scroll::-webkit-scrollbar,.toc-scroll::-webkit-scrollbar,article[role=main] ::-webkit-scrollbar{height:.25rem;width:.25rem}.sidebar-scroll::-webkit-scrollbar-thumb,.toc-scroll::-webkit-scrollbar-thumb,article[role=main] ::-webkit-scrollbar-thumb{background-color:var(--color-foreground-border);border-radius:.125rem}body,html{height:100%}.skip-to-content,body,html{background:var(--color-background-primary);color:var(--color-foreground-primary)}.skip-to-content{border-radius:1rem;left:.25rem;padding:1rem;position:fixed;top:.25rem;transform:translateY(-200%);transition:transform .3s ease-in-out;z-index:40}.skip-to-content:focus-within{transform:translateY(0)}article{background:var(--color-content-background);color:var(--color-content-foreground);overflow-wrap:break-word}.page{display:flex;min-height:100%}.mobile-header{background-color:var(--color-header-background);border-bottom:1px solid var(--color-header-border);color:var(--color-header-text);display:none;height:var(--header-height);width:100%;z-index:10}.mobile-header.scrolled{border-bottom:none;box-shadow:0 0 .2rem rgba(0,0,0,.1),0 .2rem .4rem rgba(0,0,0,.2)}.mobile-header .header-center a{color:var(--color-header-text);text-decoration:none}.main{display:flex;flex:1}.sidebar-drawer{background:var(--color-sidebar-background);border-right:1px solid var(--color-sidebar-background-border);box-sizing:border-box;display:flex;justify-content:flex-end;min-width:15em;width:calc(50% - 26em)}.sidebar-container,.toc-drawer{box-sizing:border-box;width:15em}.toc-drawer{background:var(--color-toc-background);padding-right:1rem}.sidebar-sticky,.toc-sticky{display:flex;flex-direction:column;height:min(100%,100vh);height:100vh;position:sticky;top:0}.sidebar-scroll,.toc-scroll{flex-grow:1;flex-shrink:1;overflow:auto;scroll-behavior:smooth}.content{display:flex;flex-direction:column;justify-content:space-between;padding:0 3em;width:46em}.icon{display:inline-block;height:1rem;width:1rem}.icon svg{height:100%;width:100%}.announcement{align-items:center;background-color:var(--color-announcement-background);color:var(--color-announcement-text);display:flex;height:var(--header-height);overflow-x:auto}.announcement+.page{min-height:calc(100% - var(--header-height))}.announcement-content{box-sizing:border-box;min-width:100%;padding:.5rem;text-align:center;white-space:nowrap}.announcement-content a{color:var(--color-announcement-text);text-decoration-color:var(--color-announcement-text)}.announcement-content a:hover{color:var(--color-announcement-text);text-decoration-color:var(--color-link--hover)}.no-js .theme-toggle-container{display:none}.theme-toggle-container{display:flex}.theme-toggle{background:transparent;border:none;cursor:pointer;display:flex;padding:0}.theme-toggle svg{color:var(--color-foreground-primary);display:none;height:1.25rem;width:1.25rem}.theme-toggle-header{align-items:center;display:flex;justify-content:center}.nav-overlay-icon,.toc-overlay-icon{cursor:pointer;display:none}.nav-overlay-icon .icon,.toc-overlay-icon .icon{color:var(--color-foreground-secondary);height:1.5rem;width:1.5rem}.nav-overlay-icon,.toc-header-icon{align-items:center;justify-content:center}.toc-content-icon{height:1.5rem;width:1.5rem}.content-icon-container{display:flex;float:right;gap:.5rem;margin-bottom:1rem;margin-left:1rem;margin-top:1.5rem}.content-icon-container .edit-this-page svg,.content-icon-container .view-this-page svg{color:inherit;height:1.25rem;width:1.25rem}.sidebar-toggle{display:none;position:absolute}.sidebar-toggle[name=__toc]{left:20px}.sidebar-toggle:checked{left:40px}.overlay{background-color:rgba(0,0,0,.54);height:0;opacity:0;position:fixed;top:0;transition:width 0ms,height 0ms,opacity .25s ease-out;width:0}.sidebar-overlay{z-index:20}.toc-overlay{z-index:40}.sidebar-drawer{transition:left .25s ease-in-out;z-index:30}.toc-drawer{transition:right .25s ease-in-out;z-index:50}#__navigation:checked~.sidebar-overlay{height:100%;opacity:1;width:100%}#__navigation:checked~.page .sidebar-drawer{left:0;top:0}#__toc:checked~.toc-overlay{height:100%;opacity:1;width:100%}#__toc:checked~.page .toc-drawer{right:0;top:0}.back-to-top{background:var(--color-background-primary);border-radius:1rem;box-shadow:0 .2rem .5rem rgba(0,0,0,.05),0 0 1px 0 hsla(220,9%,46%,.502);display:none;font-size:.8125rem;left:0;margin-left:50%;padding:.5rem .75rem .5rem .5rem;position:fixed;text-decoration:none;top:1rem;transform:translateX(-50%);z-index:10}.back-to-top svg{height:1rem;width:1rem;fill:currentColor;display:inline-block}.back-to-top span{margin-left:.25rem}.show-back-to-top .back-to-top{align-items:center;display:flex}@media(min-width:97em){html{font-size:110%}}@media(max-width:82em){.toc-content-icon{display:flex}.toc-drawer{border-left:1px solid var(--color-background-muted);height:100vh;position:fixed;right:-15em;top:0}.toc-tree{border-left:none;font-size:var(--toc-font-size--mobile)}.sidebar-drawer{width:calc(50% - 18.5em)}}@media(max-width:67em){.content{margin-left:auto;margin-right:auto;padding:0 1em}}@media(max-width:63em){.nav-overlay-icon{display:flex}.sidebar-drawer{height:100vh;left:-15em;position:fixed;top:0;width:15em}.theme-toggle-header,.toc-header-icon{display:flex}.theme-toggle-content,.toc-content-icon{display:none}.mobile-header{align-items:center;display:flex;justify-content:space-between;position:sticky;top:0}.mobile-header .header-left,.mobile-header .header-right{display:flex;height:var(--header-height);padding:0 var(--header-padding)}.mobile-header .header-left label,.mobile-header .header-right label{height:100%;-webkit-user-select:none;-moz-user-select:none;user-select:none;width:100%}.nav-overlay-icon .icon,.theme-toggle svg{height:1.5rem;width:1.5rem}:target{scroll-margin-top:calc(var(--header-height) + 2.5rem)}.back-to-top{top:calc(var(--header-height) + .5rem)}.page{flex-direction:column;justify-content:center}}@media(max-width:48em){.content{overflow-x:auto;width:100%}}@media(max-width:46em){article[role=main] aside.sidebar{float:none;margin:1rem 0;width:100%}}.admonition,.topic{background:var(--color-admonition-background);border-radius:.2rem;box-shadow:0 .2rem .5rem rgba(0,0,0,.05),0 0 .0625rem rgba(0,0,0,.1);font-size:var(--admonition-font-size);margin:1rem auto;overflow:hidden;padding:0 .5rem .5rem;page-break-inside:avoid}.admonition>:nth-child(2),.topic>:nth-child(2){margin-top:0}.admonition>:last-child,.topic>:last-child{margin-bottom:0}.admonition p.admonition-title,p.topic-title{font-size:var(--admonition-title-font-size);font-weight:500;line-height:1.3;margin:0 -.5rem .5rem;padding:.4rem .5rem .4rem 2rem;position:relative}.admonition p.admonition-title:before,p.topic-title:before{content:"";height:1rem;left:.5rem;position:absolute;width:1rem}p.admonition-title{background-color:var(--color-admonition-title-background)}p.admonition-title:before{background-color:var(--color-admonition-title);-webkit-mask-image:var(--icon-admonition-default);mask-image:var(--icon-admonition-default);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat}p.topic-title{background-color:var(--color-topic-title-background)}p.topic-title:before{background-color:var(--color-topic-title);-webkit-mask-image:var(--icon-topic-default);mask-image:var(--icon-topic-default);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat}.admonition{border-left:.2rem solid var(--color-admonition-title)}.admonition.caution{border-left-color:var(--color-admonition-title--caution)}.admonition.caution>.admonition-title{background-color:var(--color-admonition-title-background--caution)}.admonition.caution>.admonition-title:before{background-color:var(--color-admonition-title--caution);-webkit-mask-image:var(--icon-spark);mask-image:var(--icon-spark)}.admonition.warning{border-left-color:var(--color-admonition-title--warning)}.admonition.warning>.admonition-title{background-color:var(--color-admonition-title-background--warning)}.admonition.warning>.admonition-title:before{background-color:var(--color-admonition-title--warning);-webkit-mask-image:var(--icon-warning);mask-image:var(--icon-warning)}.admonition.danger{border-left-color:var(--color-admonition-title--danger)}.admonition.danger>.admonition-title{background-color:var(--color-admonition-title-background--danger)}.admonition.danger>.admonition-title:before{background-color:var(--color-admonition-title--danger);-webkit-mask-image:var(--icon-spark);mask-image:var(--icon-spark)}.admonition.attention{border-left-color:var(--color-admonition-title--attention)}.admonition.attention>.admonition-title{background-color:var(--color-admonition-title-background--attention)}.admonition.attention>.admonition-title:before{background-color:var(--color-admonition-title--attention);-webkit-mask-image:var(--icon-warning);mask-image:var(--icon-warning)}.admonition.error{border-left-color:var(--color-admonition-title--error)}.admonition.error>.admonition-title{background-color:var(--color-admonition-title-background--error)}.admonition.error>.admonition-title:before{background-color:var(--color-admonition-title--error);-webkit-mask-image:var(--icon-failure);mask-image:var(--icon-failure)}.admonition.hint{border-left-color:var(--color-admonition-title--hint)}.admonition.hint>.admonition-title{background-color:var(--color-admonition-title-background--hint)}.admonition.hint>.admonition-title:before{background-color:var(--color-admonition-title--hint);-webkit-mask-image:var(--icon-question);mask-image:var(--icon-question)}.admonition.tip{border-left-color:var(--color-admonition-title--tip)}.admonition.tip>.admonition-title{background-color:var(--color-admonition-title-background--tip)}.admonition.tip>.admonition-title:before{background-color:var(--color-admonition-title--tip);-webkit-mask-image:var(--icon-info);mask-image:var(--icon-info)}.admonition.important{border-left-color:var(--color-admonition-title--important)}.admonition.important>.admonition-title{background-color:var(--color-admonition-title-background--important)}.admonition.important>.admonition-title:before{background-color:var(--color-admonition-title--important);-webkit-mask-image:var(--icon-flame);mask-image:var(--icon-flame)}.admonition.note{border-left-color:var(--color-admonition-title--note)}.admonition.note>.admonition-title{background-color:var(--color-admonition-title-background--note)}.admonition.note>.admonition-title:before{background-color:var(--color-admonition-title--note);-webkit-mask-image:var(--icon-pencil);mask-image:var(--icon-pencil)}.admonition.seealso{border-left-color:var(--color-admonition-title--seealso)}.admonition.seealso>.admonition-title{background-color:var(--color-admonition-title-background--seealso)}.admonition.seealso>.admonition-title:before{background-color:var(--color-admonition-title--seealso);-webkit-mask-image:var(--icon-info);mask-image:var(--icon-info)}.admonition.admonition-todo{border-left-color:var(--color-admonition-title--admonition-todo)}.admonition.admonition-todo>.admonition-title{background-color:var(--color-admonition-title-background--admonition-todo)}.admonition.admonition-todo>.admonition-title:before{background-color:var(--color-admonition-title--admonition-todo);-webkit-mask-image:var(--icon-pencil);mask-image:var(--icon-pencil)}.admonition-todo>.admonition-title{text-transform:uppercase}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dd{margin-left:2rem}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dd>:first-child{margin-top:.125rem}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list,dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dd>:last-child{margin-bottom:.75rem}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list>dt{font-size:var(--font-size--small);text-transform:uppercase}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list dd:empty{margin-bottom:.5rem}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list dd>ul{margin-left:-1.2rem}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list dd>ul>li>p:nth-child(2){margin-top:0}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list dd>ul>li>p+p:last-child:empty{margin-bottom:0;margin-top:0}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt{color:var(--color-api-overall)}.sig:not(.sig-inline){background:var(--color-api-background);border-radius:.25rem;font-family:var(--font-stack--monospace);font-size:var(--api-font-size);font-weight:700;margin-left:-.25rem;margin-right:-.25rem;padding:.25rem .5rem .25rem 3em;text-indent:-2.5em;transition:background .1s ease-out}.sig:not(.sig-inline):hover{background:var(--color-api-background-hover)}.sig:not(.sig-inline) a.reference .viewcode-link{font-weight:400;width:4.25rem}em.property{font-style:normal}em.property:first-child{color:var(--color-api-keyword)}.sig-name{color:var(--color-api-name)}.sig-prename{color:var(--color-api-pre-name);font-weight:400}.sig-paren{color:var(--color-api-paren)}.sig-param{font-style:normal}div.deprecated,div.versionadded,div.versionchanged,div.versionremoved{border-left:.1875rem solid;border-radius:.125rem;padding-left:.75rem}div.deprecated p,div.versionadded p,div.versionchanged p,div.versionremoved p{margin-bottom:.125rem;margin-top:.125rem}div.versionadded{border-color:var(--color-api-added-border)}div.versionadded .versionmodified{color:var(--color-api-added)}div.versionchanged{border-color:var(--color-api-changed-border)}div.versionchanged .versionmodified{color:var(--color-api-changed)}div.deprecated{border-color:var(--color-api-deprecated-border)}div.deprecated .versionmodified{color:var(--color-api-deprecated)}div.versionremoved{border-color:var(--color-api-removed-border)}div.versionremoved .versionmodified{color:var(--color-api-removed)}.viewcode-back,.viewcode-link{float:right;text-align:right}.line-block{margin-bottom:.75rem;margin-top:.5rem}.line-block .line-block{margin-bottom:0;margin-top:0;padding-left:1rem}.code-block-caption,article p.caption,table>caption{font-size:var(--font-size--small);text-align:center}.toctree-wrapper.compound .caption,.toctree-wrapper.compound :not(.caption)>.caption-text{font-size:var(--font-size--small);margin-bottom:0;text-align:initial;text-transform:uppercase}.toctree-wrapper.compound>ul{margin-bottom:0;margin-top:0}.sig-inline,code.literal{background:var(--color-inline-code-background);border-radius:.2em;font-size:var(--font-size--small--2);padding:.1em .2em}pre.literal-block .sig-inline,pre.literal-block code.literal{font-size:inherit;padding:0}p .sig-inline,p code.literal{border:1px solid var(--color-background-border)}.sig-inline{font-family:var(--font-stack--monospace)}div[class*=" highlight-"],div[class^=highlight-]{display:flex;margin:1em 0}div[class*=" highlight-"] .table-wrapper,div[class^=highlight-] .table-wrapper,pre{margin:0;padding:0}pre{overflow:auto}article[role=main] .highlight pre{line-height:1.5}.highlight pre,pre.literal-block{font-size:var(--code-font-size);padding:.625rem .875rem}pre.literal-block{background-color:var(--color-code-background);border-radius:.2rem;color:var(--color-code-foreground);margin-bottom:1rem;margin-top:1rem}.highlight{border-radius:.2rem;width:100%}.highlight .gp,.highlight span.linenos{pointer-events:none;-webkit-user-select:none;-moz-user-select:none;user-select:none}.highlight .hll{display:block;margin-left:-.875rem;margin-right:-.875rem;padding-left:.875rem;padding-right:.875rem}.code-block-caption{background-color:var(--color-code-background);border-bottom:1px solid;border-radius:.25rem;border-bottom-left-radius:0;border-bottom-right-radius:0;border-color:var(--color-background-border);color:var(--color-code-foreground);display:flex;font-weight:300;padding:.625rem .875rem}.code-block-caption+div[class]{margin-top:0}.code-block-caption+div[class] pre{border-top-left-radius:0;border-top-right-radius:0}.highlighttable{display:block;width:100%}.highlighttable tbody{display:block}.highlighttable tr{display:flex}.highlighttable td.linenos{background-color:var(--color-code-background);border-bottom-left-radius:.2rem;border-top-left-radius:.2rem;color:var(--color-code-foreground);padding:.625rem 0 .625rem .875rem}.highlighttable .linenodiv{box-shadow:-.0625rem 0 var(--color-foreground-border) inset;font-size:var(--code-font-size);padding-right:.875rem}.highlighttable td.code{display:block;flex:1;overflow:hidden;padding:0}.highlighttable td.code .highlight{border-bottom-left-radius:0;border-top-left-radius:0}.highlight span.linenos{box-shadow:-.0625rem 0 var(--color-foreground-border) inset;display:inline-block;margin-right:.875rem;padding-left:0;padding-right:.875rem}.footnote-reference{font-size:var(--font-size--small--4);vertical-align:super}dl.footnote.brackets{color:var(--color-foreground-secondary);display:grid;font-size:var(--font-size--small);grid-template-columns:max-content auto}dl.footnote.brackets dt{margin:0}dl.footnote.brackets dt>.fn-backref{margin-left:.25rem}dl.footnote.brackets dt:after{content:":"}dl.footnote.brackets dt .brackets:before{content:"["}dl.footnote.brackets dt .brackets:after{content:"]"}dl.footnote.brackets dd{margin:0;padding:0 1rem}aside.footnote{color:var(--color-foreground-secondary);font-size:var(--font-size--small)}aside.footnote>span,div.citation>span{float:left;font-weight:500;padding-right:.25rem}aside.footnote>:not(span),div.citation>p{margin-left:2rem}img{box-sizing:border-box;height:auto;max-width:100%}article .figure,article figure{border-radius:.2rem;margin:0}article .figure :last-child,article figure :last-child{margin-bottom:0}article .align-left{clear:left;float:left;margin:0 1rem 1rem}article .align-right{clear:right;float:right;margin:0 1rem 1rem}article .align-center,article .align-default{display:block;margin-left:auto;margin-right:auto;text-align:center}article table.align-default{display:table;text-align:initial}.domainindex-jumpbox,.genindex-jumpbox{border-bottom:1px solid var(--color-background-border);border-top:1px solid var(--color-background-border);padding:.25rem}.domainindex-section h2,.genindex-section h2{margin-bottom:.5rem;margin-top:.75rem}.domainindex-section ul,.genindex-section ul{margin-bottom:0;margin-top:0}ol,ul{margin-bottom:1rem;margin-top:1rem;padding-left:1.2rem}ol li>p:first-child,ul li>p:first-child{margin-bottom:.25rem;margin-top:.25rem}ol li>p:last-child,ul li>p:last-child{margin-top:.25rem}ol li>ol,ol li>ul,ul li>ol,ul li>ul{margin-bottom:.5rem;margin-top:.5rem}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}.simple li>ol,.simple li>ul,.toctree-wrapper li>ol,.toctree-wrapper li>ul{margin-bottom:0;margin-top:0}.field-list dt,.option-list dt,dl.footnote dt,dl.glossary dt,dl.simple dt,dl:not([class]) dt{font-weight:500;margin-top:.25rem}.field-list dt+dt,.option-list dt+dt,dl.footnote dt+dt,dl.glossary dt+dt,dl.simple dt+dt,dl:not([class]) dt+dt{margin-top:0}.field-list dt .classifier:before,.option-list dt .classifier:before,dl.footnote dt .classifier:before,dl.glossary dt .classifier:before,dl.simple dt .classifier:before,dl:not([class]) dt .classifier:before{content:":";margin-left:.2rem;margin-right:.2rem}.field-list dd ul,.field-list dd>p:first-child,.option-list dd ul,.option-list dd>p:first-child,dl.footnote dd ul,dl.footnote dd>p:first-child,dl.glossary dd ul,dl.glossary dd>p:first-child,dl.simple dd ul,dl.simple dd>p:first-child,dl:not([class]) dd ul,dl:not([class]) dd>p:first-child{margin-top:.125rem}.field-list dd ul,.option-list dd ul,dl.footnote dd ul,dl.glossary dd ul,dl.simple dd ul,dl:not([class]) dd ul{margin-bottom:.125rem}.math-wrapper{overflow-x:auto;width:100%}div.math{position:relative;text-align:center}div.math .headerlink,div.math:focus .headerlink{display:none}div.math:hover .headerlink{display:inline-block}div.math span.eqno{position:absolute;right:.5rem;top:50%;transform:translateY(-50%);z-index:1}abbr[title]{cursor:help}.problematic{color:var(--color-problematic)}kbd:not(.compound){background-color:var(--color-background-secondary);border:1px solid var(--color-foreground-border);border-radius:.2rem;box-shadow:0 .0625rem 0 rgba(0,0,0,.2),inset 0 0 0 .125rem var(--color-background-primary);color:var(--color-foreground-primary);display:inline-block;font-size:var(--font-size--small--3);margin:0 .2rem;padding:0 .2rem;vertical-align:text-bottom}blockquote{background:var(--color-background-secondary);border-left:4px solid var(--color-background-border);margin-left:0;margin-right:0;padding:.5rem 1rem}blockquote .attribution{font-weight:600;text-align:right}blockquote.highlights,blockquote.pull-quote{font-size:1.25em}blockquote.epigraph,blockquote.pull-quote{border-left-width:0;border-radius:.5rem}blockquote.highlights{background:transparent;border-left-width:0}p .reference img{vertical-align:middle}p.rubric{font-size:1.125em;font-weight:700;line-height:1.25}dd p.rubric{font-size:var(--font-size--small);font-weight:inherit;line-height:inherit;text-transform:uppercase}article .sidebar{background-color:var(--color-background-secondary);border:1px solid var(--color-background-border);border-radius:.2rem;clear:right;float:right;margin-left:1rem;margin-right:0;width:30%}article .sidebar>*{padding-left:1rem;padding-right:1rem}article .sidebar>ol,article .sidebar>ul{padding-left:2.2rem}article .sidebar .sidebar-title{border-bottom:1px solid var(--color-background-border);font-weight:500;margin:0;padding:.5rem 1rem}[role=main] .table-wrapper.container{margin-bottom:.5rem;margin-top:1rem;overflow-x:auto;padding:.2rem .2rem .75rem;width:100%}table.docutils{border-collapse:collapse;border-radius:.2rem;border-spacing:0;box-shadow:0 .2rem .5rem rgba(0,0,0,.05),0 0 .0625rem rgba(0,0,0,.1)}table.docutils th{background:var(--color-table-header-background)}table.docutils td,table.docutils th{border-bottom:1px solid var(--color-table-border);border-left:1px solid var(--color-table-border);border-right:1px solid var(--color-table-border);padding:0 .25rem}table.docutils td p,table.docutils th p{margin:.25rem}table.docutils td:first-child,table.docutils th:first-child{border-left:none}table.docutils td:last-child,table.docutils th:last-child{border-right:none}table.docutils td.text-left,table.docutils th.text-left{text-align:left}table.docutils td.text-right,table.docutils th.text-right{text-align:right}table.docutils td.text-center,table.docutils th.text-center{text-align:center}:target{scroll-margin-top:2.5rem}@media(max-width:67em){:target{scroll-margin-top:calc(2.5rem + var(--header-height))}section>span:target{scroll-margin-top:calc(2.8rem + var(--header-height))}}.headerlink{font-weight:100;-webkit-user-select:none;-moz-user-select:none;user-select:none}.code-block-caption>.headerlink,dl dt>.headerlink,figcaption p>.headerlink,h1>.headerlink,h2>.headerlink,h3>.headerlink,h4>.headerlink,h5>.headerlink,h6>.headerlink,p.caption>.headerlink,table>caption>.headerlink{margin-left:.5rem;visibility:hidden}.code-block-caption:hover>.headerlink,dl dt:hover>.headerlink,figcaption p:hover>.headerlink,h1:hover>.headerlink,h2:hover>.headerlink,h3:hover>.headerlink,h4:hover>.headerlink,h5:hover>.headerlink,h6:hover>.headerlink,p.caption:hover>.headerlink,table>caption:hover>.headerlink{visibility:visible}.code-block-caption>.toc-backref,dl dt>.toc-backref,figcaption p>.toc-backref,h1>.toc-backref,h2>.toc-backref,h3>.toc-backref,h4>.toc-backref,h5>.toc-backref,h6>.toc-backref,p.caption>.toc-backref,table>caption>.toc-backref{color:inherit;text-decoration-line:none}figure:hover>figcaption>p>.headerlink,table:hover>caption>.headerlink{visibility:visible}:target>h1:first-of-type,:target>h2:first-of-type,:target>h3:first-of-type,:target>h4:first-of-type,:target>h5:first-of-type,:target>h6:first-of-type,span:target~h1:first-of-type,span:target~h2:first-of-type,span:target~h3:first-of-type,span:target~h4:first-of-type,span:target~h5:first-of-type,span:target~h6:first-of-type{background-color:var(--color-highlight-on-target)}:target>h1:first-of-type code.literal,:target>h2:first-of-type code.literal,:target>h3:first-of-type code.literal,:target>h4:first-of-type code.literal,:target>h5:first-of-type code.literal,:target>h6:first-of-type code.literal,span:target~h1:first-of-type code.literal,span:target~h2:first-of-type code.literal,span:target~h3:first-of-type code.literal,span:target~h4:first-of-type code.literal,span:target~h5:first-of-type code.literal,span:target~h6:first-of-type code.literal{background-color:transparent}.literal-block-wrapper:target .code-block-caption,.this-will-duplicate-information-and-it-is-still-useful-here li :target,figure:target,table:target>caption{background-color:var(--color-highlight-on-target)}dt:target{background-color:var(--color-highlight-on-target)!important}.footnote-reference:target,.footnote>dt:target+dd{background-color:var(--color-highlight-on-target)}.guilabel{background-color:var(--color-guilabel-background);border:1px solid var(--color-guilabel-border);border-radius:.5em;color:var(--color-guilabel-text);font-size:.9em;padding:0 .3em}footer{display:flex;flex-direction:column;font-size:var(--font-size--small);margin-top:2rem}.bottom-of-page{align-items:center;border-top:1px solid var(--color-background-border);color:var(--color-foreground-secondary);display:flex;justify-content:space-between;line-height:1.5;margin-top:1rem;padding-bottom:1rem;padding-top:1rem}@media(max-width:46em){.bottom-of-page{flex-direction:column-reverse;gap:.25rem;text-align:center}}.bottom-of-page .left-details{font-size:var(--font-size--small)}.bottom-of-page .right-details{display:flex;flex-direction:column;gap:.25rem;text-align:right}.bottom-of-page .icons{display:flex;font-size:1rem;gap:.25rem;justify-content:flex-end}.bottom-of-page .icons a{text-decoration:none}.bottom-of-page .icons img,.bottom-of-page .icons svg{font-size:1.125rem;height:1em;width:1em}.related-pages a{align-items:center;display:flex;text-decoration:none}.related-pages a:hover .page-info .title{color:var(--color-link);text-decoration:underline;text-decoration-color:var(--color-link-underline)}.related-pages a svg.furo-related-icon,.related-pages a svg.furo-related-icon>use{color:var(--color-foreground-border);flex-shrink:0;height:.75rem;margin:0 .5rem;width:.75rem}.related-pages a.next-page{clear:right;float:right;max-width:50%;text-align:right}.related-pages a.prev-page{clear:left;float:left;max-width:50%}.related-pages a.prev-page svg{transform:rotate(180deg)}.page-info{display:flex;flex-direction:column;overflow-wrap:anywhere}.next-page .page-info{align-items:flex-end}.page-info .context{align-items:center;color:var(--color-foreground-muted);display:flex;font-size:var(--font-size--small);padding-bottom:.1rem;text-decoration:none}ul.search{list-style:none;padding-left:0}ul.search li{border-bottom:1px solid var(--color-background-border);padding:1rem 0}[role=main] .highlighted{background-color:var(--color-highlighted-background);color:var(--color-highlighted-text)}.sidebar-brand{display:flex;flex-direction:column;flex-shrink:0;padding:var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal);text-decoration:none}.sidebar-brand-text{color:var(--color-sidebar-brand-text);font-size:1.5rem;overflow-wrap:break-word}.sidebar-brand-text,.sidebar-logo-container{margin:var(--sidebar-item-spacing-vertical) 0}.sidebar-logo{display:block;margin:0 auto;max-width:100%}.sidebar-search-container{align-items:center;background:var(--color-sidebar-search-background);display:flex;margin-top:var(--sidebar-search-space-above);position:relative}.sidebar-search-container:focus-within,.sidebar-search-container:hover{background:var(--color-sidebar-search-background--focus)}.sidebar-search-container:before{background-color:var(--color-sidebar-search-icon);content:"";height:var(--sidebar-search-icon-size);left:var(--sidebar-item-spacing-horizontal);-webkit-mask-image:var(--icon-search);mask-image:var(--icon-search);position:absolute;width:var(--sidebar-search-icon-size)}.sidebar-search{background:transparent;border:none;border-bottom:1px solid var(--color-sidebar-search-border);border-top:1px solid var(--color-sidebar-search-border);box-sizing:border-box;color:var(--color-sidebar-search-foreground);padding:var(--sidebar-search-input-spacing-vertical) var(--sidebar-search-input-spacing-horizontal) var(--sidebar-search-input-spacing-vertical) calc(var(--sidebar-item-spacing-horizontal) + var(--sidebar-search-input-spacing-horizontal) + var(--sidebar-search-icon-size));width:100%;z-index:10}.sidebar-search:focus{outline:none}.sidebar-search::-moz-placeholder{font-size:var(--sidebar-search-input-font-size)}.sidebar-search::placeholder{font-size:var(--sidebar-search-input-font-size)}#searchbox .highlight-link{margin:0;padding:var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal) 0;text-align:center}#searchbox .highlight-link a{color:var(--color-sidebar-search-icon);font-size:var(--font-size--small--2)}.sidebar-tree{font-size:var(--sidebar-item-font-size);margin-bottom:var(--sidebar-item-spacing-vertical);margin-top:var(--sidebar-tree-space-above)}.sidebar-tree ul{display:flex;flex-direction:column;list-style:none;margin-bottom:0;margin-top:0;padding:0}.sidebar-tree li{margin:0;position:relative}.sidebar-tree li>ul{margin-left:var(--sidebar-item-spacing-horizontal)}.sidebar-tree .icon,.sidebar-tree .reference{color:var(--color-sidebar-link-text)}.sidebar-tree .reference{box-sizing:border-box;display:inline-block;height:100%;line-height:var(--sidebar-item-line-height);overflow-wrap:anywhere;padding:var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal);text-decoration:none;width:100%}.sidebar-tree .reference:hover{background:var(--color-sidebar-item-background--hover);color:var(--color-sidebar-link-text)}.sidebar-tree .reference.external:after{color:var(--color-sidebar-link-text);content:url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' width='12' height='12' fill='none' stroke='%23607D8B' stroke-linecap='round' stroke-linejoin='round' stroke-width='1.5' viewBox='0 0 24 24'%3E%3Cpath stroke='none' d='M0 0h24v24H0z'/%3E%3Cpath d='M11 7H6a2 2 0 0 0-2 2v9a2 2 0 0 0 2 2h9a2 2 0 0 0 2-2v-5M10 14 20 4M15 4h5v5'/%3E%3C/svg%3E");margin:0 .25rem;vertical-align:middle}.sidebar-tree .current-page>.reference{font-weight:700}.sidebar-tree label{align-items:center;cursor:pointer;display:flex;height:var(--sidebar-item-height);justify-content:center;position:absolute;right:0;top:0;-webkit-user-select:none;-moz-user-select:none;user-select:none;width:var(--sidebar-expander-width)}.sidebar-tree .caption,.sidebar-tree :not(.caption)>.caption-text{color:var(--color-sidebar-caption-text);font-size:var(--sidebar-caption-font-size);font-weight:700;margin:var(--sidebar-caption-space-above) 0 0 0;padding:var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal);text-transform:uppercase}.sidebar-tree li.has-children>.reference{padding-right:var(--sidebar-expander-width)}.sidebar-tree .toctree-l1>.reference,.sidebar-tree .toctree-l1>label .icon{color:var(--color-sidebar-link-text--top-level)}.sidebar-tree label{background:var(--color-sidebar-item-expander-background)}.sidebar-tree label:hover{background:var(--color-sidebar-item-expander-background--hover)}.sidebar-tree .current>.reference{background:var(--color-sidebar-item-background--current)}.sidebar-tree .current>.reference:hover{background:var(--color-sidebar-item-background--hover)}.toctree-checkbox{display:none;position:absolute}.toctree-checkbox~ul{display:none}.toctree-checkbox~label .icon svg{transform:rotate(90deg)}.toctree-checkbox:checked~ul{display:block}.toctree-checkbox:checked~label .icon svg{transform:rotate(-90deg)}.toc-title-container{padding:var(--toc-title-padding);padding-top:var(--toc-spacing-vertical)}.toc-title{color:var(--color-toc-title-text);font-size:var(--toc-title-font-size);padding-left:var(--toc-spacing-horizontal);text-transform:uppercase}.no-toc{display:none}.toc-tree-container{padding-bottom:var(--toc-spacing-vertical)}.toc-tree{border-left:1px solid var(--color-background-border);font-size:var(--toc-font-size);line-height:1.3;padding-left:calc(var(--toc-spacing-horizontal) - var(--toc-item-spacing-horizontal))}.toc-tree>ul>li:first-child{padding-top:0}.toc-tree>ul>li:first-child>ul{padding-left:0}.toc-tree>ul>li:first-child>a{display:none}.toc-tree ul{list-style-type:none;margin-bottom:0;margin-top:0;padding-left:var(--toc-item-spacing-horizontal)}.toc-tree li{padding-top:var(--toc-item-spacing-vertical)}.toc-tree li.scroll-current>.reference{color:var(--color-toc-item-text--active);font-weight:700}.toc-tree a.reference{color:var(--color-toc-item-text);overflow-wrap:anywhere;text-decoration:none}.toc-scroll{max-height:100vh;overflow-y:scroll}.contents:not(.this-will-duplicate-information-and-it-is-still-useful-here){background:rgba(255,0,0,.25);color:var(--color-problematic)}.contents:not(.this-will-duplicate-information-and-it-is-still-useful-here):before{content:"ERROR: Adding a table of contents in Furo-based documentation is unnecessary, and does not work well with existing styling. Add a 'this-will-duplicate-information-and-it-is-still-useful-here' class, if you want an escape hatch."}.text-align\:left>p{text-align:left}.text-align\:center>p{text-align:center}.text-align\:right>p{text-align:right} /*# sourceMappingURL=furo.css.map*/ \ No newline at end of file diff --git a/docs/build/html/_static/styles/furo.css.map b/docs/build/html/_static/styles/furo.css.map index 6e02d0b..3ecc371 100644 --- a/docs/build/html/_static/styles/furo.css.map +++ b/docs/build/html/_static/styles/furo.css.map @@ -1 +1 @@ -{"version":3,"file":"styles/furo.css","mappings":"AAAA,2EAA2E,CAU3E,KACE,gBAAiB,CACjB,6BACF,CASA,KACE,QACF,CAMA,KACE,aACF,CAOA,GACE,aAAc,CACd,cACF,CAUA,GACE,sBAAuB,CACvB,QAAS,CACT,gBACF,CAOA,IACE,+BAAiC,CACjC,aACF,CASA,EACE,4BACF,CAOA,YACE,kBAAmB,CACnB,yBAA0B,CAC1B,gCACF,CAMA,SAEE,kBACF,CAOA,cAGE,+BAAiC,CACjC,aACF,CAeA,QAEE,aAAc,CACd,aAAc,CACd,iBAAkB,CAClB,uBACF,CAEA,IACE,aACF,CAEA,IACE,SACF,CASA,IACE,iBACF,CAUA,sCAKE,mBAAoB,CACpB,cAAe,CACf,gBAAiB,CACjB,QACF,CAOA,aAEE,gBACF,CAOA,cAEE,mBACF,CAMA,gDAIE,yBACF,CAMA,wHAIE,iBAAkB,CAClB,SACF,CAMA,4GAIE,6BACF,CAMA,SACE,0BACF,CASA,OACE,qBAAsB,CACtB,aAAc,CACd,aAAc,CACd,cAAe,CACf,SAAU,CACV,kBACF,CAMA,SACE,uBACF,CAMA,SACE,aACF,CAOA,6BAEE,qBAAsB,CACtB,SACF,CAMA,kFAEE,WACF,CAOA,cACE,4BAA6B,CAC7B,mBACF,CAMA,yCACE,uBACF,CAOA,6BACE,yBAA0B,CAC1B,YACF,CASA,QACE,aACF,CAMA,QACE,iBACF,CAiBA,kBACE,YACF,CCvVA,aAcE,kEACE,uBAOF,WACE,iDAMF,gCACE,wBAEF,qCAEE,uBADA,uBACA,CAEF,SACE,wBAtBA,CCpBJ,iBAGE,qBAEA,sBACA,0BAFA,oBAHA,4BACA,oBAKA,6BAIA,2CAFA,mBACA,sCAFA,4BAGA,CAEF,gBACE,aCTF,KCGE,mHAEA,wGAEA,wCAAyC,CAEzC,wBAAyB,CACzB,wBAAyB,CACzB,4BAA6B,CAC7B,yBAA0B,CAC1B,2BAA4B,CAG5B,sDAAuD,CACvD,gDAAiD,CACjD,wDAAyD,CAGzD,0CAA2C,CAC3C,gDAAiD,CACjD,gDAAiD,CAKjD,gCAAiC,CACjC,sCAAuC,CAGvC,2CAA4C,CAG5C,uCAAwC,CCjCxC,+FAGA,uBAAwB,CAGxB,iCAAkC,CAClC,kCAAmC,CAEnC,+BAAgC,CAChC,sCAAuC,CACvC,sCAAuC,CACvC,qGAIA,mDAAoD,CAEpD,mCAAoC,CACpC,8CAA+C,CAC/C,gDAAiD,CACjD,kCAAmC,CACnC,6DAA8D,CAG9D,6BAA8B,CAC9B,6BAA8B,CAC9B,+BAAgC,CAChC,kCAAmC,CACnC,kCAAmC,CCPjC,+jBCYA,iqCAZF,iaCVA,8KAOA,4SAWA,4SAUA,0CACA,gEAGA,0CAGA,gEAGA,yCACA,+DAIA,4CACA,kEAGA,wCAUA,8DACA,uCAGA,4DACA,sCACA,2DAGA,4CACA,kEACA,uCAGA,6DACA,2GAGA,sHAEA,yFAEA,+CACA,+EAGA,4MAOA,gCACA,sHAIA,kCACA,uEACA,gEACA,4DACA,kEAGA,2DACA,sDACA,0CACA,8CACA,wGAGA,0BACA,iCAGA,+DACA,+BACA,sCACA,+DAEA,kGACA,oCACA,yDACA,sCL7HF,kCAEA,sDAIA,0CK2HE,kEAIA,oDACA,sDAGA,oCACA,oEAEA,0DACA,qDAIA,oDACA,6DAIA,iEAIA,2DAIA,2DAGA,4DACA,gEAIA,gEAEA,gFAEA,oNASA,qDLxKE,gFAGE,4DAIF,oEKkHF,yEAEA,6DAGA,0DAEA,uDACA,qDACA,wDAIA,6DAIA,yDACA,2DAIA,uCAGA,wCACA,sDAGA,+CAGA,6DAEA,iDACA,+DAEA,wDAEA,sEAMA,0DACA,sBACA,mEL9JI,wEAEA,iCACE,+BAMN,wEAGA,iCACE,kFAEA,uEAIF,gEACE,8BAGF,qEMvDA,sCAKA,wFAKA,iCAIA,0BAWA,iCACA,4BACA,mCAGA,+BAEA,sCACA,4BAEA,mCAEA,sCAKA,sDAIA,gCAEA,gEAQF,wCAME,sBACA,kCAKA,uBAEA,gEAIA,2BAIA,mCAEA,qCACA,iCAGE,+BACA,wEAEE,iCACA,kFAGF,6BACA,0CACF,kCAEE,8BACE,8BACA,qEAEE,sCACA,wFCjFN,iCAGF,2DAEE,4BACA,oCAGA,mIAGA,4HACE,gEAMJ,+CAGE,sBACA,yCAEF,uBAEE,sEAKA,gDACA,kEAGA,iFAGE,YAGF,EACA,4HAQF,mBACE,6BACA,mBACA,wCACA,wCACA,2CAIA,eAGA,mBAKE,mBAGA,CAJA,uCACA,iBAFF,gBACE,CAKE,mBACA,mBAGJ,oBAIF,+BAGE,kDACA,OADA,kBAGA,CAFA,gBAEA,mBACA,oBAEA,sCACA,OAGF,cAHE,WAGF,GAEE,oBACA,CAHF,gBAGE,CChHc,YDmHd,+CAIF,SAEE,CAPF,UACE,wBAMA,4BAEA,GAGA,uBACA,CAJA,yBAGA,CACA,iDAKA,2CAGA,2DAQA,iBACA,uCAGA,kEAKE,SAKJ,8BACE,yDACA,2BAEA,oBACA,8BAEA,yDAEE,4BAEJ,uCACE,CACA,iEAGA,CAEA,wCACE,uBACA,kDAEA,0DAEE,CAJF,oBAIE,0GASJ,aAEF,CAFE,YAEF,4HASE,+CACA,sBAGF,sBASE,4BAFF,0CAEE,CARA,qCAwBF,CAhBE,iBAEA,kBACE,aADF,4BACE,WAOF,2BAEF,qCAIA,CAbI,UAaJ,+BACE,uBAEA,SAGA,0CAGE,CANF,qCAGA,CAGE,2DACE,gBAKJ,+CAGF,CAEA,kDAME,CARF,8BAEA,CAQE,YAEA,CAlBI,2BAGJ,CAJI,UACA,CAcJ,UAIA,4GAIF,iCAGE,8BAIA,qBACA,mBACF,QACE,gBAOE,0CAGA,CATF,6DAME,CANF,sBASE,qCAKF,CAEE,cACA,CAHF,sBAGE,gCAEA,qBAOJ,wBACE,sCAIA,mBAEA,6BAKA,kCACA,CAHA,sBAEA,cAJA,eACA,MAIA,2FAIA,UACA,YACA,sBACE,8BAEA,CALF,aACA,WAIE,CACA,0BAEF,aACE,qBAEF,qCAgBA,kBACE,CAhBA,qDASA,qCAEJ,CAGI,YACF,CAJF,2BAGI,CAGA,eACE,CAAF,oBAEA,mEAEA,qBACA,eAGF,CAHE,cAIA,kBADF,kBACE,yBAEJ,oCAGI,qDAIA,+BAMF,oCAEA,+CAEA,gCAIA,YACE,yBAEA,qBACA,eAGA,uBAFA,WAEA,CAHA,cACA,CAEA,4BAIE,qCACA,cAFA,eADA,qBACA,cAEA,mDACE,CACA,oCACA,4EAEN,uCAMA,eACE,kDAIA,mBADF,sBACE,mBAIA,aACA,sCAGA,aADA,WACA,CAMA,UAFF,kBAEE,CAJJ,gBAEE,CAJE,iBAMA,yFAQA,aACA,eEpbJ,cACE,iBACA,YAEA,CAFA,iBAEA,+DAGA,mBAKA,gCAGA,CARA,SAIA,SACA,CALA,0EAIA,CAJA,OAQA,0CACE,UAGF,iDAGF,CAHE,UAGF,8CAEE,CAFF,UAEE,CACA,uCAEA,WACA,WAFA,UAEA,6CAIA,yCACA,WAGA,WAJA,UAIA,gDACE,aASF,0CACE,CAFF,mBAEE,wEACA,CATA,YACA,CAKF,kBACA,CALE,MAGJ,CAII,eACA,CAJF,iCALE,cACA,CAHA,oBACA,CAKJ,SAKI,2BADA,UACA,6BAEJ,WACE,0DACA,kBACE,gCACA,mBADA,YACA,oEACA,2CAMF,mDAII,CAJJ,aADF,cACE,kBAII,kEACA,iBACE,mEACA,6BACE,wBADF,cACE,mCACA,qDANN,kCACE,6BAEE,mBADF,0CACE,CAFF,eACA,MACE,0DACA,wCACE,sGACA,WANN,yBACE,uCACA,CAFF,UAEE,2CACE,0FACA,cACE,kEACA,mEANN,yBACE,4DACA,sBACE,+EAEE,iEACA,qEANN,sCACE,CAGE,iBAHF,gBAGE,qBACE,CAJJ,uBACA,gDACE,wDACA,6DAHF,2CACA,CADA,gBACA,eACE,CAGE,sBANN,8BACE,CAII,iBAFF,4DACA,WACE,YADF,uCACE,6EACA,2BANN,8CACE,kDACA,0CACE,8BACA,yFACE,sBACA,sFALJ,mEACA,sBACE,kEACA,6EACE,uCACA,kEALJ,qGAEE,kEACA,6EACE,uCACA,kEALJ,8CACA,uDACE,sEACA,2EACE,sCACA,iEALJ,mGACA,qCACE,oDACA,0DACE,6GACA,gDAGR,yDCrEA,sEACE,CACA,6GACE,gEACF,iGAIF,wFACE,qDAGA,mGAEE,2CAEF,4FACE,gCACF,wGACE,8DAEE,6FAIA,iJAKN,6GACE,gDAKF,yDACA,qCAGA,6BACA,kBACA,qDAKA,oCAEA,+DAGA,2CAGE,oDAIA,oEAEE,qBAGJ,wDAEE,uCAEF,kEAGA,8CAEA,uDAIF,gEAIE,6BACA,gEAIA,+CACE,0EAIF,sDAEE,+DAGF,sCACA,8BACE,oCAEJ,wBACE,4FAEE,gBAEJ,yGAGI,kBAGJ,CCnHE,2MCFF,oBAGE,wGAKA,iCACE,CADF,wBACE,8GAQA,mBCjBJ,2GAIE,mBACA,6HAMA,YACE,mIAYF,eACA,CAHF,YAGE,4FAGE,8BAKF,uBAkBE,sCACA,CADA,qBAbA,wCAIA,CALF,8BACE,CADF,gBAKE,wCACA,CAOA,kDACA,CACA,kCAKF,6BAGA,4CACE,kDACA,eAGF,cACE,aACA,iBACA,yBACA,8BACA,WAGJ,2BACE,cAGA,+BACA,CAHA,eAGA,wCACA,YACA,iBACA,uEAGA,0BACA,2CAEA,8EAGI,qBACA,CAFF,kBAEE,kBAGN,0CAGE,mCAGA,4BAIA,gEACE,qCACA,8BAEA,gBACA,+CACA,iCAEF,iCAEE,gEACA,qCAGF,8BAEE,+BAIA,yCAEE,qBADA,gBACA,yBAKF,eACA,CAFF,YACE,CACA,iBACA,qDAEA,mDCvIJ,2FAOE,iCACA,CAEA,eACA,CAHA,kBAEA,CAFA,wBAGA,8BACA,eACE,CAFF,YAEE,0BACA,8CAGA,oBACE,oCAGA,kBACE,8DAEA,iBAEN,UACE,8BAIJ,+CAEE,qDAEF,kDAIE,YAEF,CAFE,YAEF,CCpCE,mFADA,kBAKE,CAJF,IAGA,aACE,mCAGA,iDACE,+BAEJ,wBAEE,mBAMA,6CAEF,CAJE,mBAEA,CAEF,kCAGE,CARF,kBACE,CAHA,eAUA,YACA,mBACA,CADA,UACA,wCC9BF,oBDkCE,wBCnCJ,uCACE,+BACA,+DACA,sBAGA,qBCDA,6CAIE,CAPF,uBAGA,CDGE,oBACF,yDAEE,CCDE,2CAGF,CAJA,kCACE,CDJJ,YACE,CAIA,eCTF,CDKE,uBCMA,gCACE,YAEF,oCAEE,wBACA,0BAIF,iBAEA,cADF,UACE,uBAEA,iCAEA,wCAEA,6CAMA,CAYF,gCATI,4BASJ,CAZE,mCAEE,iCAUJ,4BAGE,4DADA,+BACA,CAHF,qBAGE,sCACE,OAEF,iBAHA,SAGA,iHACE,2DAKF,CANA,8EAMA,uSAEE,kBAEF,+FACE,yCCjEJ,WACA,yBAGA,uBACA,gBAEA,uCAIA,CAJA,iCAIA,uCAGA,UACE,gBACA,qBAEA,0CClBJ,gBACE,KAGF,qBACE,YAGF,CAHE,cAGF,gCAEE,mBACA,iEAEA,oCACA,wCAEA,sBACA,WAEA,CAFA,YAEA,8EAEA,mCAFA,iBAEA,6BAIA,wEAKA,sDAIE,CARF,mDAIA,CAIE,cAEF,8CAIA,oBAFE,iBAEF,8CAGE,eAEF,CAFE,YAEF,OAEE,kBAGJ,CAJI,eACA,CAFF,mBAKF,yCCjDE,oBACA,CAFA,iBAEA,uCAKE,iBACA,qCAGA,mBCZJ,CDWI,gBCXJ,6BAEE,eACA,sBAGA,eAEA,sBACA,oDACA,iGAMA,gBAFE,YAEF,8FAME,iJClBF,YACA,gNAUE,6BAEF,oTAcI,kBACF,gHAIA,qBACE,eACF,qDACE,kBACF,6DACE,4BCxCJ,oBAEF,qCAEI,+CAGF,uBACE,uDAGJ,oBAiBI,kDACF,CAhBA,+CAaA,CAbA,oBAaA,0FAEE,CAFF,gGAdA,cACA,iBAaA,0BAGA,mQAIA,oNAEE,iBAGJ,CAHI,gBAFF,gBAKF,8CAYI,CAZJ,wCAYI,sVACE,iCAGA,uEAHA,QAGA,qXAKJ,iDAGF,CARM,+CACE,iDAIN,CALI,gBAQN,mHACE,gBAGF,2DACE,0EAOA,0EAGF,gBAEE,6DC/EA,kDACA,gCACA,qDAGA,qBACA,qDCFA,cACA,eAEA,yBAGF,sBAEE,iBACA,sNAWA,iBACE,kBACA,wRAgBA,kBAEA,iOAgBA,uCACE,uEAEA,kBAEF,qUAuBE,iDAIJ,CACA,geCxFF,4BAEE,CAQA,6JACA,iDAIA,sEAGA,mDAOF,iDAGE,4DAIA,8CACA,qDAEE,eAFF,cAEE,oBAEF,uBAFE,kCAGA,eACA,iBACA,mBAIA,mDACA,CAHA,uCAEA,CAJA,0CACA,CAIA,gBAJA,gBACA,oBADA,gBAIA,wBAEJ,gBAGE,6BACA,YAHA,iBAGA,gCACA,iEAEA,6CACA,sDACA,0BADA,wBACA,0BACA,oIAIA,mBAFA,YAEA,qBACA,0CAIE,uBAEF,CAHA,yBACE,CAEF,iDACE,mFAKJ,oCACE,CANE,aAKJ,CACE,qEAIA,YAFA,WAEA,CAHA,aACA,CAEA,gBACE,4BACA,sBADA,aACA,gCAMF,oCACA,yDACA,2CAEA,qBAGE,kBAEA,CACA,mCAIF,CARE,YACA,CAOF,iCAEE,CAPA,oBACA,CAQA,oBACE,uDAEJ,sDAGA,CAHA,cAGA,0BACE,oDAIA,oCACA,4BACA,sBAGA,cAEA,oFAGA,sBAEA,yDACE,CAIF,iBAJE,wBAIF,6CAHE,6CAKA,eACA,aACA,CADA,cACA,yCAGJ,kBACE,CAKA,iDAEA,CARF,aACE,4CAGA,kBAIA,wEAGA,wDAGA,kCAOA,iDAGA,CAPF,WAEE,sCAEA,CAJF,2CACE,CAMA,qCACA,+BARF,kBACE,qCAOA,iBAsBA,sBACE,CAvBF,WAKA,CACE,0DAIF,CALA,uDACE,CANF,sBAqBA,4CACA,CALA,gRAIA,YAEE,6CAEN,mCAEE,+CASA,6EAIA,4BChNA,SDmNA,qFCnNA,gDACA,sCAGA,qCACA,sDACA,CAKA,kDAGA,CARA,0CAQA,kBAGA,YACA,sBACA,iBAFA,gBADF,YACE,CAHA,SAKA,kBAEA,SAFA,iBAEA,uEAGA,CAEE,6CAFF,oCAgBI,CAdF,yBACE,qBACF,CAGF,oBACE,CAIF,WACE,CALA,2CAGA,uBACF,CACE,mFAGE,CALF,qBAEA,UAGE,gCAIF,sDAEA,CALE,oCAKF,yCC7CJ,oCACE,CD+CA,yXAQE,sCCrDJ,wCAGA,oCACE","sources":["webpack:///./node_modules/normalize.css/normalize.css","webpack:///./src/furo/assets/styles/base/_print.sass","webpack:///./src/furo/assets/styles/base/_screen-readers.sass","webpack:///./src/furo/assets/styles/base/_theme.sass","webpack:///./src/furo/assets/styles/variables/_fonts.scss","webpack:///./src/furo/assets/styles/variables/_spacing.scss","webpack:///./src/furo/assets/styles/variables/_icons.scss","webpack:///./src/furo/assets/styles/variables/_admonitions.scss","webpack:///./src/furo/assets/styles/variables/_colors.scss","webpack:///./src/furo/assets/styles/base/_typography.sass","webpack:///./src/furo/assets/styles/_scaffold.sass","webpack:///./src/furo/assets/styles/variables/_layout.scss","webpack:///./src/furo/assets/styles/content/_admonitions.sass","webpack:///./src/furo/assets/styles/content/_api.sass","webpack:///./src/furo/assets/styles/content/_blocks.sass","webpack:///./src/furo/assets/styles/content/_captions.sass","webpack:///./src/furo/assets/styles/content/_code.sass","webpack:///./src/furo/assets/styles/content/_footnotes.sass","webpack:///./src/furo/assets/styles/content/_images.sass","webpack:///./src/furo/assets/styles/content/_indexes.sass","webpack:///./src/furo/assets/styles/content/_lists.sass","webpack:///./src/furo/assets/styles/content/_math.sass","webpack:///./src/furo/assets/styles/content/_misc.sass","webpack:///./src/furo/assets/styles/content/_rubrics.sass","webpack:///./src/furo/assets/styles/content/_sidebar.sass","webpack:///./src/furo/assets/styles/content/_tables.sass","webpack:///./src/furo/assets/styles/content/_target.sass","webpack:///./src/furo/assets/styles/content/_gui-labels.sass","webpack:///./src/furo/assets/styles/components/_footer.sass","webpack:///./src/furo/assets/styles/components/_sidebar.sass","webpack:///./src/furo/assets/styles/components/_table_of_contents.sass","webpack:///./src/furo/assets/styles/_shame.sass"],"sourcesContent":["/*! normalize.css v8.0.1 | MIT License | github.com/necolas/normalize.css */\n\n/* Document\n ========================================================================== */\n\n/**\n * 1. Correct the line height in all browsers.\n * 2. Prevent adjustments of font size after orientation changes in iOS.\n */\n\nhtml {\n line-height: 1.15; /* 1 */\n -webkit-text-size-adjust: 100%; /* 2 */\n}\n\n/* Sections\n ========================================================================== */\n\n/**\n * Remove the margin in all browsers.\n */\n\nbody {\n margin: 0;\n}\n\n/**\n * Render the `main` element consistently in IE.\n */\n\nmain {\n display: block;\n}\n\n/**\n * Correct the font size and margin on `h1` elements within `section` and\n * `article` contexts in Chrome, Firefox, and Safari.\n */\n\nh1 {\n font-size: 2em;\n margin: 0.67em 0;\n}\n\n/* Grouping content\n ========================================================================== */\n\n/**\n * 1. Add the correct box sizing in Firefox.\n * 2. Show the overflow in Edge and IE.\n */\n\nhr {\n box-sizing: content-box; /* 1 */\n height: 0; /* 1 */\n overflow: visible; /* 2 */\n}\n\n/**\n * 1. Correct the inheritance and scaling of font size in all browsers.\n * 2. Correct the odd `em` font sizing in all browsers.\n */\n\npre {\n font-family: monospace, monospace; /* 1 */\n font-size: 1em; /* 2 */\n}\n\n/* Text-level semantics\n ========================================================================== */\n\n/**\n * Remove the gray background on active links in IE 10.\n */\n\na {\n background-color: transparent;\n}\n\n/**\n * 1. Remove the bottom border in Chrome 57-\n * 2. Add the correct text decoration in Chrome, Edge, IE, Opera, and Safari.\n */\n\nabbr[title] {\n border-bottom: none; /* 1 */\n text-decoration: underline; /* 2 */\n text-decoration: underline dotted; /* 2 */\n}\n\n/**\n * Add the correct font weight in Chrome, Edge, and Safari.\n */\n\nb,\nstrong {\n font-weight: bolder;\n}\n\n/**\n * 1. Correct the inheritance and scaling of font size in all browsers.\n * 2. Correct the odd `em` font sizing in all browsers.\n */\n\ncode,\nkbd,\nsamp {\n font-family: monospace, monospace; /* 1 */\n font-size: 1em; /* 2 */\n}\n\n/**\n * Add the correct font size in all browsers.\n */\n\nsmall {\n font-size: 80%;\n}\n\n/**\n * Prevent `sub` and `sup` elements from affecting the line height in\n * all browsers.\n */\n\nsub,\nsup {\n font-size: 75%;\n line-height: 0;\n position: relative;\n vertical-align: baseline;\n}\n\nsub {\n bottom: -0.25em;\n}\n\nsup {\n top: -0.5em;\n}\n\n/* Embedded content\n ========================================================================== */\n\n/**\n * Remove the border on images inside links in IE 10.\n */\n\nimg {\n border-style: none;\n}\n\n/* Forms\n ========================================================================== */\n\n/**\n * 1. Change the font styles in all browsers.\n * 2. Remove the margin in Firefox and Safari.\n */\n\nbutton,\ninput,\noptgroup,\nselect,\ntextarea {\n font-family: inherit; /* 1 */\n font-size: 100%; /* 1 */\n line-height: 1.15; /* 1 */\n margin: 0; /* 2 */\n}\n\n/**\n * Show the overflow in IE.\n * 1. Show the overflow in Edge.\n */\n\nbutton,\ninput { /* 1 */\n overflow: visible;\n}\n\n/**\n * Remove the inheritance of text transform in Edge, Firefox, and IE.\n * 1. Remove the inheritance of text transform in Firefox.\n */\n\nbutton,\nselect { /* 1 */\n text-transform: none;\n}\n\n/**\n * Correct the inability to style clickable types in iOS and Safari.\n */\n\nbutton,\n[type=\"button\"],\n[type=\"reset\"],\n[type=\"submit\"] {\n -webkit-appearance: button;\n}\n\n/**\n * Remove the inner border and padding in Firefox.\n */\n\nbutton::-moz-focus-inner,\n[type=\"button\"]::-moz-focus-inner,\n[type=\"reset\"]::-moz-focus-inner,\n[type=\"submit\"]::-moz-focus-inner {\n border-style: none;\n padding: 0;\n}\n\n/**\n * Restore the focus styles unset by the previous rule.\n */\n\nbutton:-moz-focusring,\n[type=\"button\"]:-moz-focusring,\n[type=\"reset\"]:-moz-focusring,\n[type=\"submit\"]:-moz-focusring {\n outline: 1px dotted ButtonText;\n}\n\n/**\n * Correct the padding in Firefox.\n */\n\nfieldset {\n padding: 0.35em 0.75em 0.625em;\n}\n\n/**\n * 1. Correct the text wrapping in Edge and IE.\n * 2. Correct the color inheritance from `fieldset` elements in IE.\n * 3. Remove the padding so developers are not caught out when they zero out\n * `fieldset` elements in all browsers.\n */\n\nlegend {\n box-sizing: border-box; /* 1 */\n color: inherit; /* 2 */\n display: table; /* 1 */\n max-width: 100%; /* 1 */\n padding: 0; /* 3 */\n white-space: normal; /* 1 */\n}\n\n/**\n * Add the correct vertical alignment in Chrome, Firefox, and Opera.\n */\n\nprogress {\n vertical-align: baseline;\n}\n\n/**\n * Remove the default vertical scrollbar in IE 10+.\n */\n\ntextarea {\n overflow: auto;\n}\n\n/**\n * 1. Add the correct box sizing in IE 10.\n * 2. Remove the padding in IE 10.\n */\n\n[type=\"checkbox\"],\n[type=\"radio\"] {\n box-sizing: border-box; /* 1 */\n padding: 0; /* 2 */\n}\n\n/**\n * Correct the cursor style of increment and decrement buttons in Chrome.\n */\n\n[type=\"number\"]::-webkit-inner-spin-button,\n[type=\"number\"]::-webkit-outer-spin-button {\n height: auto;\n}\n\n/**\n * 1. Correct the odd appearance in Chrome and Safari.\n * 2. Correct the outline style in Safari.\n */\n\n[type=\"search\"] {\n -webkit-appearance: textfield; /* 1 */\n outline-offset: -2px; /* 2 */\n}\n\n/**\n * Remove the inner padding in Chrome and Safari on macOS.\n */\n\n[type=\"search\"]::-webkit-search-decoration {\n -webkit-appearance: none;\n}\n\n/**\n * 1. Correct the inability to style clickable types in iOS and Safari.\n * 2. Change font properties to `inherit` in Safari.\n */\n\n::-webkit-file-upload-button {\n -webkit-appearance: button; /* 1 */\n font: inherit; /* 2 */\n}\n\n/* Interactive\n ========================================================================== */\n\n/*\n * Add the correct display in Edge, IE 10+, and Firefox.\n */\n\ndetails {\n display: block;\n}\n\n/*\n * Add the correct display in all browsers.\n */\n\nsummary {\n display: list-item;\n}\n\n/* Misc\n ========================================================================== */\n\n/**\n * Add the correct display in IE 10+.\n */\n\ntemplate {\n display: none;\n}\n\n/**\n * Add the correct display in IE 10.\n */\n\n[hidden] {\n display: none;\n}\n","// This file contains styles for managing print media.\n\n////////////////////////////////////////////////////////////////////////////////\n// Hide elements not relevant to print media.\n////////////////////////////////////////////////////////////////////////////////\n@media print\n // Hide icon container.\n .content-icon-container\n display: none !important\n\n // Hide showing header links if hovering over when printing.\n .headerlink\n display: none !important\n\n // Hide mobile header.\n .mobile-header\n display: none !important\n\n // Hide navigation links.\n .related-pages\n display: none !important\n\n////////////////////////////////////////////////////////////////////////////////\n// Tweaks related to decolorization.\n////////////////////////////////////////////////////////////////////////////////\n@media print\n // Apply a border around code which no longer have a color background.\n .highlight\n border: 0.1pt solid var(--color-foreground-border)\n\n////////////////////////////////////////////////////////////////////////////////\n// Avoid page break in some relevant cases.\n////////////////////////////////////////////////////////////////////////////////\n@media print\n ul, ol, dl, a, table, pre, blockquote\n page-break-inside: avoid\n\n h1, h2, h3, h4, h5, h6, img, figure, caption\n page-break-inside: avoid\n page-break-after: avoid\n\n ul, ol, dl\n page-break-before: avoid\n",".visually-hidden\n position: absolute !important\n width: 1px !important\n height: 1px !important\n padding: 0 !important\n margin: -1px !important\n overflow: hidden !important\n clip: rect(0,0,0,0) !important\n white-space: nowrap !important\n border: 0 !important\n color: var(--color-foreground-primary)\n background: var(--color-background-primary)\n\n:-moz-focusring\n outline: auto\n","// This file serves as the \"skeleton\" of the theming logic.\n//\n// This contains the bulk of the logic for handling dark mode, color scheme\n// toggling and the handling of color-scheme-specific hiding of elements.\n\nbody\n @include fonts\n @include spacing\n @include icons\n @include admonitions\n @include default-admonition(#651fff, \"abstract\")\n @include default-topic(#14B8A6, \"pencil\")\n\n @include colors\n\n.only-light\n display: block !important\nhtml body .only-dark\n display: none !important\n\n// Ignore dark-mode hints if print media.\n@media not print\n // Enable dark-mode, if requested.\n body[data-theme=\"dark\"]\n @include colors-dark\n\n html & .only-light\n display: none !important\n .only-dark\n display: block !important\n\n // Enable dark mode, unless explicitly told to avoid.\n @media (prefers-color-scheme: dark)\n body:not([data-theme=\"light\"])\n @include colors-dark\n\n html & .only-light\n display: none !important\n .only-dark\n display: block !important\n\n//\n// Theme toggle presentation\n//\nbody[data-theme=\"auto\"]\n .theme-toggle svg.theme-icon-when-auto-light\n display: block\n\n @media (prefers-color-scheme: dark)\n .theme-toggle svg.theme-icon-when-auto-dark\n display: block\n .theme-toggle svg.theme-icon-when-auto-light\n display: none\n\nbody[data-theme=\"dark\"]\n .theme-toggle svg.theme-icon-when-dark\n display: block\n\nbody[data-theme=\"light\"]\n .theme-toggle svg.theme-icon-when-light\n display: block\n","// Fonts used by this theme.\n//\n// There are basically two things here -- using the system font stack and\n// defining sizes for various elements in %ages. We could have also used `em`\n// but %age is easier to reason about for me.\n\n@mixin fonts {\n // These are adapted from https://systemfontstack.com/\n --font-stack: -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial,\n sans-serif, Apple Color Emoji, Segoe UI Emoji;\n --font-stack--monospace: \"SFMono-Regular\", Menlo, Consolas, Monaco,\n Liberation Mono, Lucida Console, monospace;\n --font-stack--headings: var(--font-stack);\n\n --font-size--normal: 100%;\n --font-size--small: 87.5%;\n --font-size--small--2: 81.25%;\n --font-size--small--3: 75%;\n --font-size--small--4: 62.5%;\n\n // Sidebar\n --sidebar-caption-font-size: var(--font-size--small--2);\n --sidebar-item-font-size: var(--font-size--small);\n --sidebar-search-input-font-size: var(--font-size--small);\n\n // Table of Contents\n --toc-font-size: var(--font-size--small--3);\n --toc-font-size--mobile: var(--font-size--normal);\n --toc-title-font-size: var(--font-size--small--4);\n\n // Admonitions\n //\n // These aren't defined in terms of %ages, since nesting these is permitted.\n --admonition-font-size: 0.8125rem;\n --admonition-title-font-size: 0.8125rem;\n\n // Code\n --code-font-size: var(--font-size--small--2);\n\n // API\n --api-font-size: var(--font-size--small);\n}\n","// Spacing for various elements on the page\n//\n// If the user wants to tweak things in a certain way, they are permitted to.\n// They also have to deal with the consequences though!\n\n@mixin spacing {\n // Header!\n --header-height: calc(\n var(--sidebar-item-line-height) + 4 * #{var(--sidebar-item-spacing-vertical)}\n );\n --header-padding: 0.5rem;\n\n // Sidebar\n --sidebar-tree-space-above: 1.5rem;\n --sidebar-caption-space-above: 1rem;\n\n --sidebar-item-line-height: 1rem;\n --sidebar-item-spacing-vertical: 0.5rem;\n --sidebar-item-spacing-horizontal: 1rem;\n --sidebar-item-height: calc(\n var(--sidebar-item-line-height) + 2 *#{var(--sidebar-item-spacing-vertical)}\n );\n\n --sidebar-expander-width: var(--sidebar-item-height); // be square\n\n --sidebar-search-space-above: 0.5rem;\n --sidebar-search-input-spacing-vertical: 0.5rem;\n --sidebar-search-input-spacing-horizontal: 0.5rem;\n --sidebar-search-input-height: 1rem;\n --sidebar-search-icon-size: var(--sidebar-search-input-height);\n\n // Table of Contents\n --toc-title-padding: 0.25rem 0;\n --toc-spacing-vertical: 1.5rem;\n --toc-spacing-horizontal: 1.5rem;\n --toc-item-spacing-vertical: 0.4rem;\n --toc-item-spacing-horizontal: 1rem;\n}\n","// Expose theme icons as CSS variables.\n\n$icons: (\n // Adapted from tabler-icons\n // url: https://tablericons.com/\n \"search\":\n url('data:image/svg+xml;charset=utf-8,'),\n // Factored out from mkdocs-material on 24-Aug-2020.\n // url: https://squidfunk.github.io/mkdocs-material/reference/admonitions/\n \"pencil\":\n url('data:image/svg+xml;charset=utf-8,'),\n \"abstract\":\n url('data:image/svg+xml;charset=utf-8,'),\n \"info\":\n url('data:image/svg+xml;charset=utf-8,'),\n \"flame\":\n url('data:image/svg+xml;charset=utf-8,'),\n \"question\":\n url('data:image/svg+xml;charset=utf-8,'),\n \"warning\":\n url('data:image/svg+xml;charset=utf-8,'),\n \"failure\":\n url('data:image/svg+xml;charset=utf-8,'),\n \"spark\":\n url('data:image/svg+xml;charset=utf-8,')\n);\n\n@mixin icons {\n @each $name, $glyph in $icons {\n --icon-#{$name}: #{$glyph};\n }\n}\n","// Admonitions\n\n// Structure of these is:\n// admonition-class: color \"icon-name\";\n//\n// The colors are translated into CSS variables below. The icons are\n// used directly in the main declarations to set the `mask-image` in\n// the title.\n\n// prettier-ignore\n$admonitions: (\n // Each of these has an reST directives for it.\n \"caution\": #ff9100 \"spark\",\n \"warning\": #ff9100 \"warning\",\n \"danger\": #ff5252 \"spark\",\n \"attention\": #ff5252 \"warning\",\n \"error\": #ff5252 \"failure\",\n \"hint\": #00c852 \"question\",\n \"tip\": #00c852 \"info\",\n \"important\": #00bfa5 \"flame\",\n \"note\": #00b0ff \"pencil\",\n \"seealso\": #448aff \"info\",\n \"admonition-todo\": #808080 \"pencil\"\n);\n\n@mixin default-admonition($color, $icon-name) {\n --color-admonition-title: #{$color};\n --color-admonition-title-background: #{rgba($color, 0.2)};\n\n --icon-admonition-default: var(--icon-#{$icon-name});\n}\n\n@mixin default-topic($color, $icon-name) {\n --color-topic-title: #{$color};\n --color-topic-title-background: #{rgba($color, 0.2)};\n\n --icon-topic-default: var(--icon-#{$icon-name});\n}\n\n@mixin admonitions {\n @each $name, $values in $admonitions {\n --color-admonition-title--#{$name}: #{nth($values, 1)};\n --color-admonition-title-background--#{$name}: #{rgba(\n nth($values, 1),\n 0.2\n )};\n }\n}\n","// Colors used throughout this theme.\n//\n// The aim is to give the user more control. Thus, instead of hard-coding colors\n// in various parts of the stylesheet, the approach taken is to define all\n// colors as CSS variables and reusing them in all the places.\n//\n// `colors-dark` depends on `colors` being included at a lower specificity.\n\n@mixin colors {\n --color-problematic: #b30000;\n\n // Base Colors\n --color-foreground-primary: black; // for main text and headings\n --color-foreground-secondary: #5a5c63; // for secondary text\n --color-foreground-muted: #6b6f76; // for muted text\n --color-foreground-border: #878787; // for content borders\n\n --color-background-primary: white; // for content\n --color-background-secondary: #f8f9fb; // for navigation + ToC\n --color-background-hover: #efeff4ff; // for navigation-item hover\n --color-background-hover--transparent: #efeff400;\n --color-background-border: #eeebee; // for UI borders\n --color-background-item: #ccc; // for \"background\" items (eg: copybutton)\n\n // Announcements\n --color-announcement-background: #000000dd;\n --color-announcement-text: #eeebee;\n\n // Brand colors\n --color-brand-primary: #0a4bff;\n --color-brand-content: #2757dd;\n --color-brand-visited: #872ee0;\n\n // API documentation\n --color-api-background: var(--color-background-hover--transparent);\n --color-api-background-hover: var(--color-background-hover);\n --color-api-overall: var(--color-foreground-secondary);\n --color-api-name: var(--color-problematic);\n --color-api-pre-name: var(--color-problematic);\n --color-api-paren: var(--color-foreground-secondary);\n --color-api-keyword: var(--color-foreground-primary);\n\n --color-api-added: #21632c;\n --color-api-added-border: #38a84d;\n --color-api-changed: #046172;\n --color-api-changed-border: #06a1bc;\n --color-api-deprecated: #605706;\n --color-api-deprecated-border: #f0d90f;\n --color-api-removed: #b30000;\n --color-api-removed-border: #ff5c5c;\n\n --color-highlight-on-target: #ffffcc;\n\n // Inline code background\n --color-inline-code-background: var(--color-background-secondary);\n\n // Highlighted text (search)\n --color-highlighted-background: #ddeeff;\n --color-highlighted-text: var(--color-foreground-primary);\n\n // GUI Labels\n --color-guilabel-background: #ddeeff80;\n --color-guilabel-border: #bedaf580;\n --color-guilabel-text: var(--color-foreground-primary);\n\n // Admonitions!\n --color-admonition-background: transparent;\n\n //////////////////////////////////////////////////////////////////////////////\n // Everything below this should be one of:\n // - var(...)\n // - *-gradient(...)\n // - special literal values (eg: transparent, none)\n //////////////////////////////////////////////////////////////////////////////\n\n // Tables\n --color-table-header-background: var(--color-background-secondary);\n --color-table-border: var(--color-background-border);\n\n // Cards\n --color-card-border: var(--color-background-secondary);\n --color-card-background: transparent;\n --color-card-marginals-background: var(--color-background-secondary);\n\n // Header\n --color-header-background: var(--color-background-primary);\n --color-header-border: var(--color-background-border);\n --color-header-text: var(--color-foreground-primary);\n\n // Sidebar (left)\n --color-sidebar-background: var(--color-background-secondary);\n --color-sidebar-background-border: var(--color-background-border);\n\n --color-sidebar-brand-text: var(--color-foreground-primary);\n --color-sidebar-caption-text: var(--color-foreground-muted);\n --color-sidebar-link-text: var(--color-foreground-secondary);\n --color-sidebar-link-text--top-level: var(--color-brand-primary);\n\n --color-sidebar-item-background: var(--color-sidebar-background);\n --color-sidebar-item-background--current: var(\n --color-sidebar-item-background\n );\n --color-sidebar-item-background--hover: linear-gradient(\n 90deg,\n var(--color-background-hover--transparent) 0%,\n var(--color-background-hover) var(--sidebar-item-spacing-horizontal),\n var(--color-background-hover) 100%\n );\n\n --color-sidebar-item-expander-background: transparent;\n --color-sidebar-item-expander-background--hover: var(\n --color-background-hover\n );\n\n --color-sidebar-search-text: var(--color-foreground-primary);\n --color-sidebar-search-background: var(--color-background-secondary);\n --color-sidebar-search-background--focus: var(--color-background-primary);\n --color-sidebar-search-border: var(--color-background-border);\n --color-sidebar-search-icon: var(--color-foreground-muted);\n\n // Table of Contents (right)\n --color-toc-background: var(--color-background-primary);\n --color-toc-title-text: var(--color-foreground-muted);\n --color-toc-item-text: var(--color-foreground-secondary);\n --color-toc-item-text--hover: var(--color-foreground-primary);\n --color-toc-item-text--active: var(--color-brand-primary);\n\n // Actual page contents\n --color-content-foreground: var(--color-foreground-primary);\n --color-content-background: transparent;\n\n // Links\n --color-link: var(--color-brand-content);\n --color-link-underline: var(--color-background-border);\n --color-link--hover: var(--color-brand-content);\n --color-link-underline--hover: var(--color-foreground-border);\n\n --color-link--visited: var(--color-brand-visited);\n --color-link-underline--visited: var(--color-background-border);\n --color-link--visited--hover: var(--color-brand-visited);\n --color-link-underline--visited--hover: var(--color-foreground-border);\n}\n\n@mixin colors-dark {\n --color-problematic: #ee5151;\n\n // Base Colors\n --color-foreground-primary: #cfd0d0; // for main text and headings\n --color-foreground-secondary: #9ca0a5; // for secondary text\n --color-foreground-muted: #81868d; // for muted text\n --color-foreground-border: #666666; // for content borders\n\n --color-background-primary: #131416; // for content\n --color-background-secondary: #1a1c1e; // for navigation + ToC\n --color-background-hover: #1e2124ff; // for navigation-item hover\n --color-background-hover--transparent: #1e212400;\n --color-background-border: #303335; // for UI borders\n --color-background-item: #444; // for \"background\" items (eg: copybutton)\n\n // Announcements\n --color-announcement-background: #000000dd;\n --color-announcement-text: #eeebee;\n\n // Brand colors\n --color-brand-primary: #3d94ff;\n --color-brand-content: #5ca5ff;\n --color-brand-visited: #b27aeb;\n\n // Highlighted text (search)\n --color-highlighted-background: #083563;\n\n // GUI Labels\n --color-guilabel-background: #08356380;\n --color-guilabel-border: #13395f80;\n\n // API documentation\n --color-api-keyword: var(--color-foreground-secondary);\n --color-highlight-on-target: #333300;\n\n --color-api-added: #3db854;\n --color-api-added-border: #267334;\n --color-api-changed: #09b0ce;\n --color-api-changed-border: #056d80;\n --color-api-deprecated: #b1a10b;\n --color-api-deprecated-border: #6e6407;\n --color-api-removed: #ff7575;\n --color-api-removed-border: #b03b3b;\n\n // Admonitions\n --color-admonition-background: #18181a;\n\n // Cards\n --color-card-border: var(--color-background-secondary);\n --color-card-background: #18181a;\n --color-card-marginals-background: var(--color-background-hover);\n}\n","// This file contains the styling for making the content throughout the page,\n// including fonts, paragraphs, headings and spacing among these elements.\n\nbody\n font-family: var(--font-stack)\npre,\ncode,\nkbd,\nsamp\n font-family: var(--font-stack--monospace)\n\n// Make fonts look slightly nicer.\nbody\n -webkit-font-smoothing: antialiased\n -moz-osx-font-smoothing: grayscale\n\n// Line height from Bootstrap 4.1\narticle\n line-height: 1.5\n\n//\n// Headings\n//\nh1,\nh2,\nh3,\nh4,\nh5,\nh6\n line-height: 1.25\n font-family: var(--font-stack--headings)\n font-weight: bold\n\n border-radius: 0.5rem\n margin-top: 0.5rem\n margin-bottom: 0.5rem\n margin-left: -0.5rem\n margin-right: -0.5rem\n padding-left: 0.5rem\n padding-right: 0.5rem\n\n + p\n margin-top: 0\n\nh1\n font-size: 2.5em\n margin-top: 1.75rem\n margin-bottom: 1rem\nh2\n font-size: 2em\n margin-top: 1.75rem\nh3\n font-size: 1.5em\nh4\n font-size: 1.25em\nh5\n font-size: 1.125em\nh6\n font-size: 1em\n\nsmall\n opacity: 75%\n font-size: 80%\n\n// Paragraph\np\n margin-top: 0.5rem\n margin-bottom: 0.75rem\n\n// Horizontal rules\nhr.docutils\n height: 1px\n padding: 0\n margin: 2rem 0\n background-color: var(--color-background-border)\n border: 0\n\n.centered\n text-align: center\n\n// Links\na\n text-decoration: underline\n\n color: var(--color-link)\n text-decoration-color: var(--color-link-underline)\n\n &:visited\n color: var(--color-link--visited)\n text-decoration-color: var(--color-link-underline--visited)\n &:hover\n color: var(--color-link--visited--hover)\n text-decoration-color: var(--color-link-underline--visited--hover)\n\n &:hover\n color: var(--color-link--hover)\n text-decoration-color: var(--color-link-underline--hover)\n &.muted-link\n color: inherit\n &:hover\n color: var(--color-link--hover)\n text-decoration-color: var(--color-link-underline--hover)\n &:visited\n color: var(--color-link--visited--hover)\n text-decoration-color: var(--color-link-underline--visited--hover)\n","// This file contains the styles for the overall layouting of the documentation\n// skeleton, including the responsive changes as well as sidebar toggles.\n//\n// This is implemented as a mobile-last design, which isn't ideal, but it is\n// reasonably good-enough and I got pretty tired by the time I'd finished this\n// to move the rules around to fix this. Shouldn't take more than 3-4 hours,\n// if you know what you're doing tho.\n\n// HACK: Not all browsers account for the scrollbar width in media queries.\n// This results in horizontal scrollbars in the breakpoint where we go\n// from displaying everything to hiding the ToC. We accomodate for this by\n// adding a bit of padding to the TOC drawer, disabling the horizontal\n// scrollbar and allowing the scrollbars to cover the padding.\n// https://www.456bereastreet.com/archive/201301/media_query_width_and_vertical_scrollbars/\n\n// HACK: Always having the scrollbar visible, prevents certain browsers from\n// causing the content to stutter horizontally between taller-than-viewport and\n// not-taller-than-viewport pages.\n\n$icon-size: 1.25rem\n\nhtml\n overflow-x: hidden\n overflow-y: scroll\n scroll-behavior: smooth\n\n.sidebar-scroll, .toc-scroll, article[role=main] *\n // Override Firefox scrollbar style\n scrollbar-width: thin\n scrollbar-color: var(--color-foreground-border) transparent\n\n // Override Chrome scrollbar styles\n &::-webkit-scrollbar\n width: 0.25rem\n height: 0.25rem\n &::-webkit-scrollbar-thumb\n background-color: var(--color-foreground-border)\n border-radius: 0.125rem\n\n//\n// Overalls\n//\nhtml,\nbody\n height: 100%\n color: var(--color-foreground-primary)\n background: var(--color-background-primary)\n\n.skip-to-content\n position: fixed\n padding: 1rem\n border-radius: 1rem\n left: 0.25rem\n top: 0.25rem\n z-index: 40\n background: var(--color-background-primary)\n color: var(--color-foreground-primary)\n\n transform: translateY(-200%)\n transition: transform 300ms ease-in-out\n\n &:focus-within\n transform: translateY(0%)\n\narticle\n color: var(--color-content-foreground)\n background: var(--color-content-background)\n overflow-wrap: break-word\n\n.page\n display: flex\n // fill the viewport for pages with little content.\n min-height: 100%\n\n.mobile-header\n width: 100%\n height: var(--header-height)\n background-color: var(--color-header-background)\n color: var(--color-header-text)\n border-bottom: 1px solid var(--color-header-border)\n\n // Looks like sub-script/super-script have this, and we need this to\n // be \"on top\" of those.\n z-index: 10\n\n // We don't show the header on large screens.\n display: none\n\n // Add shadow when scrolled\n &.scrolled\n border-bottom: none\n box-shadow: 0 0 0.2rem rgba(0, 0, 0, 0.1), 0 0.2rem 0.4rem rgba(0, 0, 0, 0.2)\n\n .header-center\n a\n color: var(--color-header-text)\n text-decoration: none\n\n.main\n display: flex\n flex: 1\n\n// Sidebar (left) also covers the entire left portion of screen.\n.sidebar-drawer\n box-sizing: border-box\n\n border-right: 1px solid var(--color-sidebar-background-border)\n background: var(--color-sidebar-background)\n\n display: flex\n justify-content: flex-end\n // These next two lines took me two days to figure out.\n width: calc((100% - #{$full-width}) / 2 + #{$sidebar-width})\n min-width: $sidebar-width\n\n// Scroll-along sidebars\n.sidebar-container,\n.toc-drawer\n box-sizing: border-box\n width: $sidebar-width\n\n.toc-drawer\n background: var(--color-toc-background)\n // See HACK described on top of this document\n padding-right: 1rem\n\n.sidebar-sticky,\n.toc-sticky\n position: sticky\n top: 0\n height: min(100%, 100vh)\n height: 100vh\n\n display: flex\n flex-direction: column\n\n.sidebar-scroll,\n.toc-scroll\n flex-grow: 1\n flex-shrink: 1\n\n overflow: auto\n scroll-behavior: smooth\n\n// Central items.\n.content\n padding: 0 $content-padding\n width: $content-width\n\n display: flex\n flex-direction: column\n justify-content: space-between\n\n.icon\n display: inline-block\n height: 1rem\n width: 1rem\n svg\n width: 100%\n height: 100%\n\n//\n// Accommodate announcement banner\n//\n.announcement\n background-color: var(--color-announcement-background)\n color: var(--color-announcement-text)\n\n height: var(--header-height)\n display: flex\n align-items: center\n overflow-x: auto\n & + .page\n min-height: calc(100% - var(--header-height))\n\n.announcement-content\n box-sizing: border-box\n padding: 0.5rem\n min-width: 100%\n white-space: nowrap\n text-align: center\n\n a\n color: var(--color-announcement-text)\n text-decoration-color: var(--color-announcement-text)\n\n &:hover\n color: var(--color-announcement-text)\n text-decoration-color: var(--color-link--hover)\n\n////////////////////////////////////////////////////////////////////////////////\n// Toggles for theme\n////////////////////////////////////////////////////////////////////////////////\n.no-js .theme-toggle-container // don't show theme toggle if there's no JS\n display: none\n\n.theme-toggle-container\n vertical-align: middle\n\n.theme-toggle\n cursor: pointer\n border: none\n padding: 0\n background: transparent\n\n.theme-toggle svg\n vertical-align: middle\n height: $icon-size\n width: $icon-size\n color: var(--color-foreground-primary)\n display: none\n\n.theme-toggle-header\n float: left\n padding: 1rem 0.5rem\n\n////////////////////////////////////////////////////////////////////////////////\n// Toggles for elements\n////////////////////////////////////////////////////////////////////////////////\n.toc-overlay-icon, .nav-overlay-icon\n display: none\n cursor: pointer\n\n .icon\n color: var(--color-foreground-secondary)\n height: $icon-size\n width: $icon-size\n\n.toc-header-icon, .nav-overlay-icon\n // for when we set display: flex\n justify-content: center\n align-items: center\n\n.toc-content-icon\n height: 1.5rem\n width: 1.5rem\n\n.content-icon-container\n float: right\n display: flex\n margin-top: 1.5rem\n margin-left: 1rem\n margin-bottom: 1rem\n gap: 0.5rem\n\n .edit-this-page, .view-this-page\n svg\n color: inherit\n height: $icon-size\n width: $icon-size\n\n.sidebar-toggle\n position: absolute\n display: none\n// \n.sidebar-toggle[name=\"__toc\"]\n left: 20px\n.sidebar-toggle:checked\n left: 40px\n// \n\n.overlay\n position: fixed\n top: 0\n width: 0\n height: 0\n\n transition: width 0ms, height 0ms, opacity 250ms ease-out\n\n opacity: 0\n background-color: rgba(0, 0, 0, 0.54)\n.sidebar-overlay\n z-index: 20\n.toc-overlay\n z-index: 40\n\n// Keep things on top and smooth.\n.sidebar-drawer\n z-index: 30\n transition: left 250ms ease-in-out\n.toc-drawer\n z-index: 50\n transition: right 250ms ease-in-out\n\n// Show the Sidebar\n#__navigation:checked\n & ~ .sidebar-overlay\n width: 100%\n height: 100%\n opacity: 1\n & ~ .page\n .sidebar-drawer\n top: 0\n left: 0\n // Show the toc sidebar\n#__toc:checked\n & ~ .toc-overlay\n width: 100%\n height: 100%\n opacity: 1\n & ~ .page\n .toc-drawer\n top: 0\n right: 0\n\n////////////////////////////////////////////////////////////////////////////////\n// Back to top\n////////////////////////////////////////////////////////////////////////////////\n.back-to-top\n text-decoration: none\n\n display: none\n position: fixed\n left: 0\n top: 1rem\n padding: 0.5rem\n padding-right: 0.75rem\n border-radius: 1rem\n font-size: 0.8125rem\n\n background: var(--color-background-primary)\n box-shadow: 0 0.2rem 0.5rem rgba(0, 0, 0, 0.05), #6b728080 0px 0px 1px 0px\n\n z-index: 10\n\n margin-left: 50%\n transform: translateX(-50%)\n svg\n height: 1rem\n width: 1rem\n fill: currentColor\n display: inline-block\n\n span\n margin-left: 0.25rem\n\n .show-back-to-top &\n display: flex\n align-items: center\n\n////////////////////////////////////////////////////////////////////////////////\n// Responsive layouting\n////////////////////////////////////////////////////////////////////////////////\n// Make things a bit bigger on bigger screens.\n@media (min-width: $full-width + $sidebar-width)\n html\n font-size: 110%\n\n@media (max-width: $full-width)\n // Collapse \"toc\" into the icon.\n .toc-content-icon\n display: flex\n .toc-drawer\n position: fixed\n height: 100vh\n top: 0\n right: -$sidebar-width\n border-left: 1px solid var(--color-background-muted)\n .toc-tree\n border-left: none\n font-size: var(--toc-font-size--mobile)\n\n // Accomodate for a changed content width.\n .sidebar-drawer\n width: calc((100% - #{$full-width - $sidebar-width}) / 2 + #{$sidebar-width})\n\n@media (max-width: $full-width - $sidebar-width)\n // Collapse \"navigation\".\n .nav-overlay-icon\n display: flex\n .sidebar-drawer\n position: fixed\n height: 100vh\n width: $sidebar-width\n\n top: 0\n left: -$sidebar-width\n\n // Swap which icon is visible.\n .toc-header-icon\n display: flex\n .toc-content-icon, .theme-toggle-content\n display: none\n .theme-toggle-header\n display: block\n\n // Show the header.\n .mobile-header\n position: sticky\n top: 0\n display: flex\n justify-content: space-between\n align-items: center\n\n .header-left,\n .header-right\n display: flex\n height: var(--header-height)\n padding: 0 var(--header-padding)\n label\n height: 100%\n width: 100%\n user-select: none\n\n .nav-overlay-icon .icon,\n .theme-toggle svg\n height: $icon-size\n width: $icon-size\n\n // Add a scroll margin for the content\n :target\n scroll-margin-top: calc(var(--header-height) + 2.5rem)\n\n // Show back-to-top below the header\n .back-to-top\n top: calc(var(--header-height) + 0.5rem)\n\n // Center the page, and accommodate for the header.\n .page\n flex-direction: column\n justify-content: center\n .content\n margin-left: auto\n margin-right: auto\n\n@media (max-width: $content-width + 2* $content-padding)\n // Content should respect window limits.\n .content\n width: 100%\n overflow-x: auto\n\n@media (max-width: $content-width)\n .content\n padding: 0 $content-padding--small\n // Don't float sidebars to the right.\n article aside.sidebar\n float: none\n width: 100%\n margin: 1rem 0\n","// Overall Layout Variables\n//\n// Because CSS variables can't be used in media queries. The fact that this\n// makes the layout non-user-configurable is a good thing.\n$content-padding: 3em;\n$content-padding--small: 1em;\n$content-width: 46em;\n$sidebar-width: 15em;\n$full-width: $content-width + 2 * ($content-padding + $sidebar-width);\n","//\n// The design here is strongly inspired by mkdocs-material.\n.admonition, .topic\n margin: 1rem auto\n padding: 0 0.5rem 0.5rem 0.5rem\n\n background: var(--color-admonition-background)\n\n border-radius: 0.2rem\n box-shadow: 0 0.2rem 0.5rem rgba(0, 0, 0, 0.05), 0 0 0.0625rem rgba(0, 0, 0, 0.1)\n\n font-size: var(--admonition-font-size)\n\n overflow: hidden\n page-break-inside: avoid\n\n // First element should have no margin, since the title has it.\n > :nth-child(2)\n margin-top: 0\n\n // Last item should have no margin, since we'll control that w/ padding\n > :last-child\n margin-bottom: 0\n\n.admonition p.admonition-title,\np.topic-title\n position: relative\n margin: 0 -0.5rem 0.5rem\n padding-left: 2rem\n padding-right: .5rem\n padding-top: .4rem\n padding-bottom: .4rem\n\n font-weight: 500\n font-size: var(--admonition-title-font-size)\n line-height: 1.3\n\n // Our fancy icon\n &::before\n content: \"\"\n position: absolute\n left: 0.5rem\n width: 1rem\n height: 1rem\n\n// Default styles\np.admonition-title\n background-color: var(--color-admonition-title-background)\n &::before\n background-color: var(--color-admonition-title)\n mask-image: var(--icon-admonition-default)\n mask-repeat: no-repeat\n\np.topic-title\n background-color: var(--color-topic-title-background)\n &::before\n background-color: var(--color-topic-title)\n mask-image: var(--icon-topic-default)\n mask-repeat: no-repeat\n\n//\n// Variants\n//\n.admonition\n border-left: 0.2rem solid var(--color-admonition-title)\n\n @each $type, $value in $admonitions\n &.#{$type}\n border-left-color: var(--color-admonition-title--#{$type})\n > .admonition-title\n background-color: var(--color-admonition-title-background--#{$type})\n &::before\n background-color: var(--color-admonition-title--#{$type})\n mask-image: var(--icon-#{nth($value, 2)})\n\n.admonition-todo > .admonition-title\n text-transform: uppercase\n","// This file stylizes the API documentation (stuff generated by autodoc). It's\n// deeply nested due to how autodoc structures the HTML without enough classes\n// to select the relevant items.\n\n// API docs!\ndl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)\n // Tweak the spacing of all the things!\n dd\n margin-left: 2rem\n > :first-child\n margin-top: 0.125rem\n > :last-child\n margin-bottom: 0.75rem\n\n // This is used for the arguments\n .field-list\n margin-bottom: 0.75rem\n\n // \"Headings\" (like \"Parameters\" and \"Return\")\n > dt\n text-transform: uppercase\n font-size: var(--font-size--small)\n\n dd:empty\n margin-bottom: 0.5rem\n dd > ul\n margin-left: -1.2rem\n > li\n > p:nth-child(2)\n margin-top: 0\n // When the last-empty-paragraph follows a paragraph, it doesn't need\n // to augument the existing spacing.\n > p + p:last-child:empty\n margin-top: 0\n margin-bottom: 0\n\n // Colorize the elements\n > dt\n color: var(--color-api-overall)\n\n.sig:not(.sig-inline)\n font-weight: bold\n\n font-size: var(--api-font-size)\n font-family: var(--font-stack--monospace)\n\n margin-left: -0.25rem\n margin-right: -0.25rem\n padding-top: 0.25rem\n padding-bottom: 0.25rem\n padding-right: 0.5rem\n\n // These are intentionally em, to properly match the font size.\n padding-left: 3em\n text-indent: -2.5em\n\n border-radius: 0.25rem\n\n background: var(--color-api-background)\n transition: background 100ms ease-out\n\n &:hover\n background: var(--color-api-background-hover)\n\n // adjust the size of the [source] link on the right.\n a.reference\n .viewcode-link\n font-weight: normal\n width: 4.25rem\n\nem.property\n font-style: normal\n &:first-child\n color: var(--color-api-keyword)\n.sig-name\n color: var(--color-api-name)\n.sig-prename\n font-weight: normal\n color: var(--color-api-pre-name)\n.sig-paren\n color: var(--color-api-paren)\n.sig-param\n font-style: normal\n\ndiv.versionadded,\ndiv.versionchanged,\ndiv.deprecated,\ndiv.versionremoved\n border-left: 0.1875rem solid\n border-radius: 0.125rem\n\n padding-left: 0.75rem\n\n p\n margin-top: 0.125rem\n margin-bottom: 0.125rem\n\ndiv.versionadded\n border-color: var(--color-api-added-border)\n .versionmodified\n color: var(--color-api-added)\n\ndiv.versionchanged\n border-color: var(--color-api-changed-border)\n .versionmodified\n color: var(--color-api-changed)\n\ndiv.deprecated\n border-color: var(--color-api-deprecated-border)\n .versionmodified\n color: var(--color-api-deprecated)\n\ndiv.versionremoved\n border-color: var(--color-api-removed-border)\n .versionmodified\n color: var(--color-api-removed)\n\n// Align the [docs] and [source] to the right.\n.viewcode-link, .viewcode-back\n float: right\n text-align: right\n",".line-block\n margin-top: 0.5rem\n margin-bottom: 0.75rem\n .line-block\n margin-top: 0rem\n margin-bottom: 0rem\n padding-left: 1rem\n","// Captions\narticle p.caption,\ntable > caption,\n.code-block-caption\n font-size: var(--font-size--small)\n text-align: center\n\n// Caption above a TOCTree\n.toctree-wrapper.compound\n .caption, :not(.caption) > .caption-text\n font-size: var(--font-size--small)\n text-transform: uppercase\n\n text-align: initial\n margin-bottom: 0\n\n > ul\n margin-top: 0\n margin-bottom: 0\n","// Inline code\ncode.literal, .sig-inline\n background: var(--color-inline-code-background)\n border-radius: 0.2em\n // Make the font smaller, and use padding to recover.\n font-size: var(--font-size--small--2)\n padding: 0.1em 0.2em\n\n pre.literal-block &\n font-size: inherit\n padding: 0\n\n p &\n border: 1px solid var(--color-background-border)\n\n.sig-inline\n font-family: var(--font-stack--monospace)\n\n// Code and Literal Blocks\n$code-spacing-vertical: 0.625rem\n$code-spacing-horizontal: 0.875rem\n\n// Wraps every literal block + line numbers.\ndiv[class*=\" highlight-\"],\ndiv[class^=\"highlight-\"]\n margin: 1em 0\n display: flex\n\n .table-wrapper\n margin: 0\n padding: 0\n\npre\n margin: 0\n padding: 0\n overflow: auto\n\n // Needed to have more specificity than pygments' \"pre\" selector. :(\n article[role=\"main\"] .highlight &\n line-height: 1.5\n\n &.literal-block,\n .highlight &\n font-size: var(--code-font-size)\n padding: $code-spacing-vertical $code-spacing-horizontal\n\n // Make it look like all the other blocks.\n &.literal-block\n margin-top: 1rem\n margin-bottom: 1rem\n\n border-radius: 0.2rem\n background-color: var(--color-code-background)\n color: var(--color-code-foreground)\n\n// All code is always contained in this.\n.highlight\n width: 100%\n border-radius: 0.2rem\n\n // Make line numbers and prompts un-selectable.\n .gp, span.linenos\n user-select: none\n pointer-events: none\n\n // Expand the line-highlighting.\n .hll\n display: block\n margin-left: -$code-spacing-horizontal\n margin-right: -$code-spacing-horizontal\n padding-left: $code-spacing-horizontal\n padding-right: $code-spacing-horizontal\n\n/* Make code block captions be nicely integrated */\n.code-block-caption\n display: flex\n padding: $code-spacing-vertical $code-spacing-horizontal\n\n border-radius: 0.25rem\n border-bottom-left-radius: 0\n border-bottom-right-radius: 0\n font-weight: 300\n border-bottom: 1px solid\n\n background-color: var(--color-code-background)\n color: var(--color-code-foreground)\n border-color: var(--color-background-border)\n\n + div[class]\n margin-top: 0\n pre\n border-top-left-radius: 0\n border-top-right-radius: 0\n\n// When `html_codeblock_linenos_style` is table.\n.highlighttable\n width: 100%\n display: block\n tbody\n display: block\n\n tr\n display: flex\n\n // Line numbers\n td.linenos\n background-color: var(--color-code-background)\n color: var(--color-code-foreground)\n padding: $code-spacing-vertical $code-spacing-horizontal\n padding-right: 0\n border-top-left-radius: 0.2rem\n border-bottom-left-radius: 0.2rem\n\n .linenodiv\n padding-right: $code-spacing-horizontal\n font-size: var(--code-font-size)\n box-shadow: -0.0625rem 0 var(--color-foreground-border) inset\n\n // Actual code\n td.code\n padding: 0\n display: block\n flex: 1\n overflow: hidden\n\n .highlight\n border-top-left-radius: 0\n border-bottom-left-radius: 0\n\n// When `html_codeblock_linenos_style` is inline.\n.highlight\n span.linenos\n display: inline-block\n padding-left: 0\n padding-right: $code-spacing-horizontal\n margin-right: $code-spacing-horizontal\n box-shadow: -0.0625rem 0 var(--color-foreground-border) inset\n","// Inline Footnote Reference\n.footnote-reference\n font-size: var(--font-size--small--4)\n vertical-align: super\n\n// Definition list, listing the content of each note.\n// docutils <= 0.17\ndl.footnote.brackets\n font-size: var(--font-size--small)\n color: var(--color-foreground-secondary)\n\n display: grid\n grid-template-columns: max-content auto\n dt\n margin: 0\n > .fn-backref\n margin-left: 0.25rem\n\n &:after\n content: \":\"\n\n .brackets\n &:before\n content: \"[\"\n &:after\n content: \"]\"\n\n dd\n margin: 0\n padding: 0 1rem\n\n// docutils >= 0.18\naside.footnote\n font-size: var(--font-size--small)\n color: var(--color-foreground-secondary)\n\naside.footnote > span,\ndiv.citation > span\n float: left\n font-weight: 500\n padding-right: 0.25rem\n\naside.footnote > *:not(span),\ndiv.citation > p\n margin-left: 2rem\n","//\n// Figures\n//\nimg\n box-sizing: border-box\n max-width: 100%\n height: auto\n\narticle\n figure, .figure\n border-radius: 0.2rem\n\n margin: 0\n :last-child\n margin-bottom: 0\n\n .align-left\n float: left\n clear: left\n margin: 0 1rem 1rem\n\n .align-right\n float: right\n clear: right\n margin: 0 1rem 1rem\n\n .align-default,\n .align-center\n display: block\n text-align: center\n margin-left: auto\n margin-right: auto\n\n // WELL, table needs to be stylised like a table.\n table.align-default\n display: table\n text-align: initial\n",".genindex-jumpbox, .domainindex-jumpbox\n border-top: 1px solid var(--color-background-border)\n border-bottom: 1px solid var(--color-background-border)\n padding: 0.25rem\n\n.genindex-section, .domainindex-section\n h2\n margin-top: 0.75rem\n margin-bottom: 0.5rem\n ul\n margin-top: 0\n margin-bottom: 0\n","ul,\nol\n padding-left: 1.2rem\n\n // Space lists out like paragraphs\n margin-top: 1rem\n margin-bottom: 1rem\n // reduce margins within li.\n li\n > p:first-child\n margin-top: 0.25rem\n margin-bottom: 0.25rem\n\n > p:last-child\n margin-top: 0.25rem\n\n > ul,\n > ol\n margin-top: 0.5rem\n margin-bottom: 0.5rem\n\nol\n &.arabic\n list-style: decimal\n &.loweralpha\n list-style: lower-alpha\n &.upperalpha\n list-style: upper-alpha\n &.lowerroman\n list-style: lower-roman\n &.upperroman\n list-style: upper-roman\n\n// Don't space lists out when they're \"simple\" or in a `.. toctree::`\n.simple,\n.toctree-wrapper\n li\n > ul,\n > ol\n margin-top: 0\n margin-bottom: 0\n\n// Definition Lists\n.field-list,\n.option-list,\ndl:not([class]),\ndl.simple,\ndl.footnote,\ndl.glossary\n dt\n font-weight: 500\n margin-top: 0.25rem\n + dt\n margin-top: 0\n\n .classifier::before\n content: \":\"\n margin-left: 0.2rem\n margin-right: 0.2rem\n\n dd\n > p:first-child,\n ul\n margin-top: 0.125rem\n\n ul\n margin-bottom: 0.125rem\n",".math-wrapper\n width: 100%\n overflow-x: auto\n\ndiv.math\n position: relative\n text-align: center\n\n .headerlink,\n &:focus .headerlink\n display: none\n\n &:hover .headerlink\n display: inline-block\n\n span.eqno\n position: absolute\n right: 0.5rem\n top: 50%\n transform: translate(0, -50%)\n z-index: 1\n","// Abbreviations\nabbr[title]\n cursor: help\n\n// \"Problematic\" content, as identified by Sphinx\n.problematic\n color: var(--color-problematic)\n\n// Keyboard / Mouse \"instructions\"\nkbd:not(.compound)\n margin: 0 0.2rem\n padding: 0 0.2rem\n border-radius: 0.2rem\n border: 1px solid var(--color-foreground-border)\n color: var(--color-foreground-primary)\n vertical-align: text-bottom\n\n font-size: var(--font-size--small--3)\n display: inline-block\n\n box-shadow: 0 0.0625rem 0 rgba(0, 0, 0, 0.2), inset 0 0 0 0.125rem var(--color-background-primary)\n\n background-color: var(--color-background-secondary)\n\n// Blockquote\nblockquote\n border-left: 4px solid var(--color-background-border)\n background: var(--color-background-secondary)\n\n margin-left: 0\n margin-right: 0\n padding: 0.5rem 1rem\n\n .attribution\n font-weight: 600\n text-align: right\n\n &.pull-quote,\n &.highlights\n font-size: 1.25em\n\n &.epigraph,\n &.pull-quote\n border-left-width: 0\n border-radius: 0.5rem\n\n &.highlights\n border-left-width: 0\n background: transparent\n\n// Center align embedded-in-text images\np .reference img\n vertical-align: middle\n","p.rubric\n line-height: 1.25\n font-weight: bold\n font-size: 1.125em\n\n // For Numpy-style documentation that's got rubrics within it.\n // https://github.com/pradyunsg/furo/discussions/505\n dd &\n line-height: inherit\n font-weight: inherit\n\n font-size: var(--font-size--small)\n text-transform: uppercase\n","article .sidebar\n float: right\n clear: right\n width: 30%\n\n margin-left: 1rem\n margin-right: 0\n\n border-radius: 0.2rem\n background-color: var(--color-background-secondary)\n border: var(--color-background-border) 1px solid\n\n > *\n padding-left: 1rem\n padding-right: 1rem\n\n > ul, > ol // lists need additional padding, because bullets.\n padding-left: 2.2rem\n\n .sidebar-title\n margin: 0\n padding: 0.5rem 1rem\n border-bottom: var(--color-background-border) 1px solid\n\n font-weight: 500\n\n// TODO: subtitle\n// TODO: dedicated variables?\n",".table-wrapper\n width: 100%\n overflow-x: auto\n margin-top: 1rem\n margin-bottom: 0.5rem\n padding: 0.2rem 0.2rem 0.75rem\n\ntable.docutils\n border-radius: 0.2rem\n border-spacing: 0\n border-collapse: collapse\n\n box-shadow: 0 0.2rem 0.5rem rgba(0, 0, 0, 0.05), 0 0 0.0625rem rgba(0, 0, 0, 0.1)\n\n th\n background: var(--color-table-header-background)\n\n td,\n th\n // Space things out properly\n padding: 0 0.25rem\n\n // Get the borders looking just-right.\n border-left: 1px solid var(--color-table-border)\n border-right: 1px solid var(--color-table-border)\n border-bottom: 1px solid var(--color-table-border)\n\n p\n margin: 0.25rem\n\n &:first-child\n border-left: none\n &:last-child\n border-right: none\n\n // MyST-parser tables set these classes for control of column alignment\n &.text-left\n text-align: left\n &.text-right\n text-align: right\n &.text-center\n text-align: center\n",":target\n scroll-margin-top: 2.5rem\n\n@media (max-width: $full-width - $sidebar-width)\n :target\n scroll-margin-top: calc(2.5rem + var(--header-height))\n\n // When a heading is selected\n section > span:target\n scroll-margin-top: calc(2.8rem + var(--header-height))\n\n// Permalinks\n.headerlink\n font-weight: 100\n user-select: none\n\nh1,\nh2,\nh3,\nh4,\nh5,\nh6,\ndl dt,\np.caption,\nfigcaption p,\ntable > caption,\n.code-block-caption\n > .headerlink\n margin-left: 0.5rem\n visibility: hidden\n &:hover > .headerlink\n visibility: visible\n\n // Don't change to link-like, if someone adds the contents directive.\n > .toc-backref\n color: inherit\n text-decoration-line: none\n\n// Figure and table captions are special.\nfigure:hover > figcaption > p > .headerlink,\ntable:hover > caption > .headerlink\n visibility: visible\n\n:target >, // Regular section[id] style anchors\nspan:target ~ // Non-regular span[id] style \"extra\" anchors\n h1,\n h2,\n h3,\n h4,\n h5,\n h6\n &:nth-of-type(1)\n background-color: var(--color-highlight-on-target)\n // .headerlink\n // visibility: visible\n code.literal\n background-color: transparent\n\ntable:target > caption,\nfigure:target\n background-color: var(--color-highlight-on-target)\n\n// Inline page contents\n.this-will-duplicate-information-and-it-is-still-useful-here li :target\n background-color: var(--color-highlight-on-target)\n\n// Code block permalinks\n.literal-block-wrapper:target .code-block-caption\n background-color: var(--color-highlight-on-target)\n\n// When a definition list item is selected\n//\n// There isn't really an alternative to !important here, due to the\n// high-specificity of API documentation's selector.\ndt:target\n background-color: var(--color-highlight-on-target) !important\n\n// When a footnote reference is selected\n.footnote > dt:target + dd,\n.footnote-reference:target\n background-color: var(--color-highlight-on-target)\n",".guilabel\n background-color: var(--color-guilabel-background)\n border: 1px solid var(--color-guilabel-border)\n color: var(--color-guilabel-text)\n\n padding: 0 0.3em\n border-radius: 0.5em\n font-size: 0.9em\n","// This file contains the styles used for stylizing the footer that's shown\n// below the content.\n\nfooter\n font-size: var(--font-size--small)\n display: flex\n flex-direction: column\n\n margin-top: 2rem\n\n// Bottom of page information\n.bottom-of-page\n display: flex\n align-items: center\n justify-content: space-between\n\n margin-top: 1rem\n padding-top: 1rem\n padding-bottom: 1rem\n\n color: var(--color-foreground-secondary)\n border-top: 1px solid var(--color-background-border)\n\n line-height: 1.5\n\n @media (max-width: $content-width)\n text-align: center\n flex-direction: column-reverse\n gap: 0.25rem\n\n .left-details\n font-size: var(--font-size--small)\n\n .right-details\n display: flex\n flex-direction: column\n gap: 0.25rem\n text-align: right\n\n .icons\n display: flex\n justify-content: flex-end\n gap: 0.25rem\n font-size: 1rem\n\n a\n text-decoration: none\n\n svg,\n img\n font-size: 1.125rem\n height: 1em\n width: 1em\n\n// Next/Prev page information\n.related-pages\n a\n display: flex\n align-items: center\n\n text-decoration: none\n &:hover .page-info .title\n text-decoration: underline\n color: var(--color-link)\n text-decoration-color: var(--color-link-underline)\n\n svg.furo-related-icon,\n svg.furo-related-icon > use\n flex-shrink: 0\n\n color: var(--color-foreground-border)\n\n width: 0.75rem\n height: 0.75rem\n margin: 0 0.5rem\n\n &.next-page\n max-width: 50%\n\n float: right\n clear: right\n text-align: right\n\n &.prev-page\n max-width: 50%\n\n float: left\n clear: left\n\n svg\n transform: rotate(180deg)\n\n.page-info\n display: flex\n flex-direction: column\n overflow-wrap: anywhere\n\n .next-page &\n align-items: flex-end\n\n .context\n display: flex\n align-items: center\n\n padding-bottom: 0.1rem\n\n color: var(--color-foreground-muted)\n font-size: var(--font-size--small)\n text-decoration: none\n","// This file contains the styles for the contents of the left sidebar, which\n// contains the navigation tree, logo, search etc.\n\n////////////////////////////////////////////////////////////////////////////////\n// Brand on top of the scrollable tree.\n////////////////////////////////////////////////////////////////////////////////\n.sidebar-brand\n display: flex\n flex-direction: column\n flex-shrink: 0\n\n padding: var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal)\n text-decoration: none\n\n.sidebar-brand-text\n color: var(--color-sidebar-brand-text)\n overflow-wrap: break-word\n margin: var(--sidebar-item-spacing-vertical) 0\n font-size: 1.5rem\n\n.sidebar-logo-container\n margin: var(--sidebar-item-spacing-vertical) 0\n\n.sidebar-logo\n margin: 0 auto\n display: block\n max-width: 100%\n\n////////////////////////////////////////////////////////////////////////////////\n// Search\n////////////////////////////////////////////////////////////////////////////////\n.sidebar-search-container\n display: flex\n align-items: center\n margin-top: var(--sidebar-search-space-above)\n\n position: relative\n\n background: var(--color-sidebar-search-background)\n &:hover,\n &:focus-within\n background: var(--color-sidebar-search-background--focus)\n\n &::before\n content: \"\"\n position: absolute\n left: var(--sidebar-item-spacing-horizontal)\n width: var(--sidebar-search-icon-size)\n height: var(--sidebar-search-icon-size)\n\n background-color: var(--color-sidebar-search-icon)\n mask-image: var(--icon-search)\n\n.sidebar-search\n box-sizing: border-box\n\n border: none\n border-top: 1px solid var(--color-sidebar-search-border)\n border-bottom: 1px solid var(--color-sidebar-search-border)\n\n padding-top: var(--sidebar-search-input-spacing-vertical)\n padding-bottom: var(--sidebar-search-input-spacing-vertical)\n padding-right: var(--sidebar-search-input-spacing-horizontal)\n padding-left: calc(var(--sidebar-item-spacing-horizontal) + var(--sidebar-search-input-spacing-horizontal) + var(--sidebar-search-icon-size))\n\n width: 100%\n\n color: var(--color-sidebar-search-foreground)\n background: transparent\n z-index: 10\n\n &:focus\n outline: none\n\n &::placeholder\n font-size: var(--sidebar-search-input-font-size)\n\n//\n// Hide Search Matches link\n//\n#searchbox .highlight-link\n padding: var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal) 0\n margin: 0\n text-align: center\n\n a\n color: var(--color-sidebar-search-icon)\n font-size: var(--font-size--small--2)\n\n////////////////////////////////////////////////////////////////////////////////\n// Structure/Skeleton of the navigation tree (left)\n////////////////////////////////////////////////////////////////////////////////\n.sidebar-tree\n font-size: var(--sidebar-item-font-size)\n margin-top: var(--sidebar-tree-space-above)\n margin-bottom: var(--sidebar-item-spacing-vertical)\n\n ul\n padding: 0\n margin-top: 0\n margin-bottom: 0\n\n display: flex\n flex-direction: column\n\n list-style: none\n\n li\n position: relative\n margin: 0\n\n > ul\n margin-left: var(--sidebar-item-spacing-horizontal)\n\n .icon\n color: var(--color-sidebar-link-text)\n\n .reference\n box-sizing: border-box\n color: var(--color-sidebar-link-text)\n\n // Fill the parent.\n display: inline-block\n line-height: var(--sidebar-item-line-height)\n text-decoration: none\n\n // Don't allow long words to cause wrapping.\n overflow-wrap: anywhere\n\n height: 100%\n width: 100%\n\n padding: var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal)\n\n &:hover\n color: var(--color-sidebar-link-text)\n background: var(--color-sidebar-item-background--hover)\n\n // Add a nice little \"external-link\" arrow here.\n &.external::after\n content: url('data:image/svg+xml,')\n margin: 0 0.25rem\n vertical-align: middle\n color: var(--color-sidebar-link-text)\n\n // Make the current page reference bold.\n .current-page > .reference\n font-weight: bold\n\n label\n position: absolute\n top: 0\n right: 0\n height: var(--sidebar-item-height)\n width: var(--sidebar-expander-width)\n\n cursor: pointer\n user-select: none\n\n display: flex\n justify-content: center\n align-items: center\n\n .caption, :not(.caption) > .caption-text\n font-size: var(--sidebar-caption-font-size)\n color: var(--color-sidebar-caption-text)\n\n font-weight: bold\n text-transform: uppercase\n\n margin: var(--sidebar-caption-space-above) 0 0 0\n padding: var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal)\n\n // If it has children, add a bit more padding to wrap the content to avoid\n // overlapping with the
    -
    sloyka 0.1.0 documentation
     +
    sloyka 0.2.1 documentation
    @@ -207,7 +194,7 @@
    - sloyka 0.1.0 documentation + sloyka 0.2.1 documentation
    - + \ No newline at end of file diff --git a/docs/build/html/about/introduction.html b/docs/build/html/about/introduction.html index 9d8127a..065b5b4 100644 --- a/docs/build/html/about/introduction.html +++ b/docs/build/html/about/introduction.html @@ -5,11 +5,11 @@ - - Introduction - sloyka 0.1.0 documentation + + Introduction - sloyka 0.2.1 documentation - - + + @@ -89,19 +89,6 @@ - - Auto light/dark mode - - - - - - - - - - Auto light/dark, in light mode - @@ -180,7 +167,7 @@
    -
    sloyka 0.1.0 documentation
     +
    sloyka 0.2.1 documentation
    @@ -207,7 +194,7 @@
    - sloyka 0.1.0 documentation + sloyka 0.2.1 documentation @@ -386,9 +373,9 @@

    Main features +

    - + \ No newline at end of file diff --git a/docs/build/html/about/pipeline.html b/docs/build/html/about/pipeline.html index a710660..f81a562 100644 --- a/docs/build/html/about/pipeline.html +++ b/docs/build/html/about/pipeline.html @@ -5,11 +5,11 @@ - - Main pipeline - sloyka 0.1.0 documentation + + Main pipeline - sloyka 0.2.1 documentation - - + + @@ -89,19 +89,6 @@ - - Auto light/dark mode - - - - - - - - - - Auto light/dark, in light mode - @@ -180,7 +167,7 @@
    -
    sloyka 0.1.0 documentation
     +
    sloyka 0.2.1 documentation
    @@ -207,7 +194,7 @@
    - sloyka 0.1.0 documentation + sloyka 0.2.1 documentation @@ -306,13 +293,10 @@

    Main pipelineData getter and Geocoding )

    +text data mentioning urban sites, otherwise the steps are very important - Data getter and geocoder )

    -

    Each of the methods in this group requires certain labeling columns: Semantic graph Regional activity

    -
      +

    • Data modelling: Section consists of further synthesis of the obtained data, risk assessment and forecasting. Each of the methods in this group requires certain labeling columns: Semantic graph Regional activity

    • Data visualization: The last step is applied to the already generated semantic graph - Graph visualization

    You can get more info about each step in!

    @@ -366,9 +350,9 @@

    Main pipeline +

    - + \ No newline at end of file diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html index e956563..d94e106 100644 --- a/docs/build/html/genindex.html +++ b/docs/build/html/genindex.html @@ -4,10 +4,10 @@ - Index - sloyka 0.1.0 documentation + Index - sloyka 0.2.1 documentation - - + + @@ -87,19 +87,6 @@ - - Auto light/dark mode - - - - - - - - - - Auto light/dark, in light mode - @@ -178,7 +165,7 @@
    -
    sloyka 0.1.0 documentation
     +
    sloyka 0.2.1 documentation
    @@ -205,7 +192,7 @@
    - sloyka 0.1.0 documentation + sloyka 0.2.1 documentation @@ -288,11 +275,15 @@

    Index

    -
    A | B | C | D | E | G | I | M | O | P | R | S | T | U
    +
    A | B | C | D | E | F | G | I | M | O | P | R | S | T | U | V

    A

    +
  • StreetExtractor (class in sloyka.src.geocoder.street_extractor), [1] +
    • +
  • Streets (class in sloyka.src.utils.data_getter.street_getter)
    • @@ -554,6 +601,10 @@

    T

    +
    @@ -569,6 +620,20 @@

    U

    +
    +

    V

    + + + +
    +
    +
    @@ -600,9 +665,9 @@

    U

    -
    +
    - + \ No newline at end of file diff --git a/docs/build/html/index.html b/docs/build/html/index.html index bdad101..2a692b6 100644 --- a/docs/build/html/index.html +++ b/docs/build/html/index.html @@ -5,11 +5,11 @@ - - sloyka 0.1.0 documentation + + sloyka 0.2.1 documentation - - + + @@ -89,19 +89,6 @@ - - Auto light/dark mode - - - - - - - - - - Auto light/dark, in light mode - @@ -180,7 +167,7 @@
    -
    sloyka 0.1.0 documentation
     +
    sloyka 0.2.1 documentation
    @@ -207,7 +194,7 @@
    - sloyka 0.1.0 documentation + sloyka 0.2.1 documentation @@ -366,9 +353,9 @@

    Indices and tables +

    - + \ No newline at end of file diff --git a/docs/build/html/modules/GeoDataGetter.html b/docs/build/html/modules/GeoDataGetter.html index baee5c5..2e427d3 100644 --- a/docs/build/html/modules/GeoDataGetter.html +++ b/docs/build/html/modules/GeoDataGetter.html @@ -5,11 +5,11 @@ - - GeoDataGetter - sloyka 0.1.0 documentation + + GeoDataGetter - sloyka 0.2.1 documentation - - + + @@ -89,19 +89,6 @@ - - Auto light/dark mode - - - - - - - - - - Auto light/dark, in light mode - @@ -180,7 +167,7 @@
    -
    sloyka 0.1.0 documentation
     +
    sloyka 0.2.1 documentation
    @@ -192,7 +179,7 @@
    -
    - sloyka 0.1.0 documentation + sloyka 0.2.1 documentation @@ -287,7 +274,7 @@
    -
    -
    -
    +
    - + \ No newline at end of file diff --git a/docs/build/html/modules/Geocoder_special.html b/docs/build/html/modules/Geocoder_special.html index 9f359fd..2bee8c5 100644 --- a/docs/build/html/modules/Geocoder_special.html +++ b/docs/build/html/modules/Geocoder_special.html @@ -5,11 +5,11 @@ - - Geocoder - sloyka 0.1.0 documentation + + Geocoder - sloyka 0.2.1 documentation - - + + @@ -89,19 +89,6 @@ - - Auto light/dark mode - - - - - - - - - - Auto light/dark, in light mode - @@ -180,7 +167,7 @@
    -
    sloyka 0.1.0 documentation
     +
    sloyka 0.2.1 documentation
    @@ -207,7 +194,7 @@
    - sloyka 0.1.0 documentation + sloyka 0.2.1 documentation @@ -297,12 +284,13 @@

    Geocoder

    -class sloyka.src.geocoder.geocoder.Geocoder(df, model_path: str = 'Geor111y/flair-ner-addresses-extractor', device: str = 'cpu', osm_id: int = None, city_tags: dict = {'place': ['state']})[source]
    +class sloyka.src.geocoder.geocoder.Geocoder(df, model_path: str = 'Geor111y/flair-ner-addresses-extractor', device: str = 'cpu', osm_id: int | None = None, city_tags: dict = {'place': ['state']}, stemmer_lang: str = 'russian', text_column_name: str = 'text')[source]

    This class provides a functionality of simple geocoder

    assign_street()[source]
    -
    +

    Simple workaround

    +
    @@ -310,11 +298,6 @@

    Function simply creates gdf from the recognised geocoded geometries.

    -
    -
    -dir_path = '/Users/test/Documents/code/sloyka/sloyka/src/geocoder'
    -
    -
    get_df_areas(osm_id, tags)[source]
    @@ -356,11 +339,6 @@ names dictionary (df).

    -
    -
    -global_crs: int = 4326
    -
    -
    match_group_to_area(group_name, df_areas)[source]
    @@ -434,7 +412,7 @@
    -run(df: DataFrame = None, tags: dict | None = None, text_column: str = 'text', group_column: str | None = 'group_name', search_for_objects=False)[source]
    +run(df: DataFrame | None = None, tags: dict | None = None, group_column: str | None = 'group_name', search_for_objects=False)[source]

    Runs the data processing pipeline on the input DataFrame.

    Parameters:
    @@ -469,7 +447,7 @@
    -

    Back to all Geocoding

    +

    Back to all geocoder

    @@ -530,11 +508,9 @@
  • Geocoder
    • -
    +
    - + \ No newline at end of file diff --git a/docs/build/html/modules/OtherGeoObjects.html b/docs/build/html/modules/OtherGeoObjects.html index 30d6e7a..6d03f1e 100644 --- a/docs/build/html/modules/OtherGeoObjects.html +++ b/docs/build/html/modules/OtherGeoObjects.html @@ -5,11 +5,11 @@ - - OtherGeoObjects - sloyka 0.1.0 documentation + + OtherGeoObjects - sloyka 0.2.1 documentation - - + + @@ -89,19 +89,6 @@ - - Auto light/dark mode - - - - - - - - - - Auto light/dark, in light mode - @@ -180,7 +167,7 @@
    -
    sloyka 0.1.0 documentation
     +
    sloyka 0.2.1 documentation
    @@ -207,7 +194,7 @@
    - sloyka 0.1.0 documentation + sloyka 0.2.1 documentation @@ -295,34 +282,113 @@

    OtherGeoObjects

    +
    +
    +class sloyka.src.geocoder.city_objects_extractor.OtherGeoObjects[source]
    +
    +
    +static calculate_centroid(geometry) → Point[source]
    +

    Calculates the centroid for polygons.

    +
    + +
    +
    +static combine_city_obj(df_obj) → DataFrame[source]
    +

    Combines the found named urban objects and urban objects whose names are in the form of numbers.

    +
    + +
    +
    +static expand_toponym(df_obj) → DataFrame[source]
    +

    Splits the list of found entities into different rows for further analysis.

    +
    + +
    +
    +static extract_geo_obj(text) → List[str][source]
    +

    The function extracts location entities from the text, using the Natasha library.

    +
    + +
    +
    +static find_geo_obj_tag(toponym, osm_combined_df) → str[source]
    +

    Finds the geo_obj_tag in the OSM array by the name of the city object.

    +
    + +
    +
    +static find_geometry(toponym, osm_combined_df) → Point[source]
    +

    Finds the coordinate in the OSM array by the name of the city object.

    +
    + +
    +
    +static find_num_city_obj(text) → List[str][source]
    +

    This function searches for urban objects in the text, +the names of which are represented as a number. For example, “school No. 6”.

    +
    +
    -static OtherGeoObjects.get_and_process_osm_data(osm_id: int, tags: dict) → DataFrame[source]
    +static get_and_process_osm_data(osm_id: int, tags: dict) → DataFrame[source]

    Retrieves and processes OSM data for different urban objects.

    +
    +
    +static get_unique_part_types(df)[source]
    +
    + +
    +
    +static restoration_of_normal_form(other_geo_obj, osm_combined_df, threshold=0.7) → List[str][source]
    +

    This function compares the extracted location entity with an OSM array +and returns a normalized form if the percentage of similarity is at least 70%.

    +
    + +
    +
    +static run(osm_id: int, df: DataFrame, text_column: str) → DataFrame[source]
    +

    Launches the module for extracting urban objects from texts that do not relate to streets.

    +
    +
    -static OtherGeoObjects.run_osm_dfs(osm_id: int) → DataFrame[source]
    +static run_osm_dfs(osm_id: int) → DataFrame[source]

    Collects dataframes with OSM spatial data, finds centroids and combines them into one.

    +
    +
    -
    -static OtherGeoObjects.calculate_centroid(geometry) → Point[source]
    +
    +static OtherGeoObjects.get_and_process_osm_data(osm_id: int, tags: dict) → DataFrame[source]
    +

    Retrieves and processes OSM data for different urban objects.

    +
    + +
    +
    +static OtherGeoObjects.run_osm_dfs(osm_id: int) → DataFrame[source]
    +

    Collects dataframes with OSM spatial data, finds centroids and combines them into one.

    +
    + +
    +
    +static OtherGeoObjects.calculate_centroid(geometry) → Point[source]

    Calculates the centroid for polygons.

    -
    -static OtherGeoObjects.extract_geo_obj(text) → List[str][source]
    +
    +static OtherGeoObjects.extract_geo_obj(text) → List[str][source]

    The function extracts location entities from the text, using the Natasha library.

    -
    -static OtherGeoObjects.restoration_of_normal_form(other_geo_obj, osm_combined_df, threshold=0.7) → List[str][source]
    -

    This function compares the extracted location entity with an OSM array and returns a normalized form if the percentage of similarity is at least 70%.

    +
    +static OtherGeoObjects.restoration_of_normal_form(other_geo_obj, osm_combined_df, threshold=0.7) → List[str][source]
    +

    This function compares the extracted location entity with an OSM array +and returns a normalized form if the percentage of similarity is at least 70%.

    @@ -382,11 +448,26 @@
    @@ -398,9 +479,9 @@
    -
    +
    - + \ No newline at end of file diff --git a/docs/build/html/modules/StreetExtractor.html b/docs/build/html/modules/StreetExtractor.html index 2b2c22a..af7c170 100644 --- a/docs/build/html/modules/StreetExtractor.html +++ b/docs/build/html/modules/StreetExtractor.html @@ -5,11 +5,11 @@ - - StreetExtractor - sloyka 0.1.0 documentation + + StreetExtractor - sloyka 0.2.1 documentation - - + + @@ -89,19 +89,6 @@ - - Auto light/dark mode - - - - - - - - - - Auto light/dark, in light mode - @@ -180,7 +167,7 @@
    -
    sloyka 0.1.0 documentation
     +
    sloyka 0.2.1 documentation
    @@ -207,7 +194,7 @@
    - sloyka 0.1.0 documentation + sloyka 0.2.1 documentation @@ -430,9 +417,9 @@
    -
    +
    - + \ No newline at end of file diff --git a/docs/build/html/modules/Streets.html b/docs/build/html/modules/Streets.html index 9b7e525..4bde4ae 100644 --- a/docs/build/html/modules/Streets.html +++ b/docs/build/html/modules/Streets.html @@ -5,11 +5,11 @@ - - Streets - sloyka 0.1.0 documentation + + Streets - sloyka 0.2.1 documentation - - + + @@ -89,19 +89,6 @@     - - Auto light/dark mode - - - - - - - - - - Auto light/dark, in light mode - @@ -180,7 +167,7 @@
    -
    sloyka 0.1.0 documentation
     +
    sloyka 0.2.1 documentation
    @@ -192,7 +179,7 @@
    -
    - sloyka 0.1.0 documentation + sloyka 0.2.1 documentation @@ -287,7 +274,7 @@ -     - - Auto light/dark mode - - - - - - - - - - Auto light/dark, in light mode - @@ -180,7 +167,7 @@
    -
    sloyka 0.1.0 documentation
     +
    sloyka 0.2.1 documentation
    @@ -207,7 +194,7 @@
    - sloyka 0.1.0 documentation + sloyka 0.2.1 documentation @@ -303,7 +290,7 @@ category using multiple models.

    -class sloyka.src.risks.emotion_classifier.EmotionRecognizer(model_name=Text.Bert_Large, device=None)[source]
    +class sloyka.src.risks.emotion_classifier.EmotionRecognizer(model_name=Text.Bert_Tiny, device='cpu')[source]

    This class is designed to categorise input texts into emotion categories.

    Attributes:

    @@ -417,9 +404,9 @@

    Example

    -
    + - + \ No newline at end of file diff --git a/docs/build/html/modules/event_dynamic_prediction.html b/docs/build/html/modules/event_dynamic_prediction.html index 95b1c25..1387f5a 100644 --- a/docs/build/html/modules/event_dynamic_prediction.html +++ b/docs/build/html/modules/event_dynamic_prediction.html @@ -5,11 +5,11 @@ - - Event detector - sloyka 0.1.0 documentation + + Event detector - sloyka 0.2.1 documentation - - + + @@ -89,19 +89,6 @@     - - Auto light/dark mode - - - - - - - - - - Auto light/dark, in light mode - @@ -180,7 +167,7 @@
    -
    sloyka 0.1.0 documentation
     +
    sloyka 0.2.1 documentation
    @@ -207,7 +194,7 @@
    - sloyka 0.1.0 documentation + sloyka 0.2.1 documentation @@ -393,9 +380,9 @@
    - + - + \ No newline at end of file diff --git a/docs/build/html/modules/geocoder.html b/docs/build/html/modules/geocoder.html index f27980b..6c7c2f1 100644 --- a/docs/build/html/modules/geocoder.html +++ b/docs/build/html/modules/geocoder.html @@ -5,11 +5,11 @@ - - Geocoding - sloyka 0.1.0 documentation + + Geocoding - sloyka 0.2.1 documentation - - + + @@ -89,19 +89,6 @@ - - Auto light/dark mode - - - - - - - - - - Auto light/dark, in light mode - @@ -180,7 +167,7 @@
    -
    sloyka 0.1.0 documentation
     +
    sloyka 0.2.1 documentation
    @@ -207,7 +194,7 @@
    - sloyka 0.1.0 documentation + sloyka 0.2.1 documentation @@ -293,19 +280,19 @@
    -
    -

    Geocoding

    -

    To perform classification with generalized linear models, see -Geocoder.

    +
    +
    +

    Geocoding

    +

    To perform classification with generalized linear models, see Geocoder.

    Geocoder

    -class sloyka.src.geocoder.geocoder.Geocoder(df, model_path: str = 'Geor111y/flair-ner-addresses-extractor', device: str = 'cpu', osm_id: int = None, city_tags: dict = {'place': ['state']})[source]
    +class sloyka.src.geocoder.geocoder.Geocoder(df, model_path: str = 'Geor111y/flair-ner-addresses-extractor', device: str = 'cpu', osm_id: int | None = None, city_tags: dict = {'place': ['state']}, stemmer_lang: str = 'russian', text_column_name: str = 'text')[source]

    This class provides a functionality of simple geocoder

    -run(df: DataFrame = None, tags: dict | None = None, text_column: str = 'text', group_column: str | None = 'group_name', search_for_objects=False)[source]
    +run(df: DataFrame | None = None, tags: dict | None = None, group_column: str | None = 'group_name', search_for_objects=False)[source]

    Runs the data processing pipeline on the input DataFrame.

    Parameters:
    @@ -453,9 +440,9 @@

    more:< - + - + \ No newline at end of file diff --git a/docs/build/html/modules/regional_activity.html b/docs/build/html/modules/regional_activity.html index 25a80b0..a2a1e1c 100644 --- a/docs/build/html/modules/regional_activity.html +++ b/docs/build/html/modules/regional_activity.html @@ -5,11 +5,11 @@ - - Regional activity - sloyka 0.1.0 documentation + + Regional activity - sloyka 0.2.1 documentation - - + + @@ -89,19 +89,6 @@ - - Auto light/dark mode - - - - - - - - - - Auto light/dark, in light mode - @@ -180,7 +167,7 @@
    -
    sloyka 0.1.0 documentation
     +
    sloyka 0.2.1 documentation
    @@ -207,7 +194,7 @@
    - sloyka 0.1.0 documentation + sloyka 0.2.1 documentation @@ -350,9 +337,9 @@
    - + - + \ No newline at end of file diff --git a/docs/build/html/modules/semantic_graph.html b/docs/build/html/modules/semantic_graph.html index d8382c5..cef9a05 100644 --- a/docs/build/html/modules/semantic_graph.html +++ b/docs/build/html/modules/semantic_graph.html @@ -5,11 +5,11 @@ - - Semantic graph - sloyka 0.1.0 documentation + + Semantic graph - sloyka 0.2.1 documentation - - + + @@ -89,19 +89,6 @@     - - Auto light/dark mode - - - - - - - - - - Auto light/dark, in light mode - @@ -180,7 +167,7 @@
    -
    sloyka 0.1.0 documentation
     +
    sloyka 0.2.1 documentation
    @@ -207,7 +194,7 @@
    - sloyka 0.1.0 documentation + sloyka 0.2.1 documentation @@ -472,9 +459,9 @@
    - + - + \ No newline at end of file diff --git a/docs/build/html/modules/text_classifier.html b/docs/build/html/modules/text_classifier.html index 1b80282..b1e9e08 100644 --- a/docs/build/html/modules/text_classifier.html +++ b/docs/build/html/modules/text_classifier.html @@ -5,11 +5,11 @@ - - Text Classifier - sloyka 0.1.0 documentation + + Text Classifier - sloyka 0.2.1 documentation - - + + @@ -89,19 +89,6 @@     - - Auto light/dark mode - - - - - - - - - - Auto light/dark, in light mode - @@ -180,7 +167,7 @@
    -
    sloyka 0.1.0 documentation
     +
    sloyka 0.2.1 documentation
    @@ -207,7 +194,7 @@
    - sloyka 0.1.0 documentation + sloyka 0.2.1 documentation @@ -416,9 +403,9 @@
    - + - + \ No newline at end of file diff --git a/docs/build/html/modules/topic_modeler.html b/docs/build/html/modules/topic_modeler.html index acad63c..9164883 100644 --- a/docs/build/html/modules/topic_modeler.html +++ b/docs/build/html/modules/topic_modeler.html @@ -5,11 +5,11 @@ - - Topic Modelling - sloyka 0.1.0 documentation + + Topic Modelling - sloyka 0.2.1 documentation - - + + @@ -89,19 +89,6 @@     - - Auto light/dark mode - - - - - - - - - - Auto light/dark, in light mode - @@ -180,7 +167,7 @@
    -
    sloyka 0.1.0 documentation
     +
    sloyka 0.2.1 documentation
    @@ -207,7 +194,7 @@
    - sloyka 0.1.0 documentation + sloyka 0.2.1 documentation @@ -356,9 +343,9 @@
    - + - + \ No newline at end of file diff --git a/docs/build/html/modules/visualize_graph.html b/docs/build/html/modules/visualize_graph.html index 649e3ef..4103e68 100644 --- a/docs/build/html/modules/visualize_graph.html +++ b/docs/build/html/modules/visualize_graph.html @@ -5,11 +5,11 @@ - - Graph visualization - sloyka 0.1.0 documentation + + Graph visualization - sloyka 0.2.1 documentation - - + + @@ -89,19 +89,6 @@     - - Auto light/dark mode - - - - - - - - - - Auto light/dark, in light mode - @@ -180,7 +167,7 @@
    -
    sloyka 0.1.0 documentation
     +
    sloyka 0.2.1 documentation
    @@ -207,7 +194,7 @@
    - sloyka 0.1.0 documentation + sloyka 0.2.1 documentation @@ -298,15 +285,12 @@

    The function results in an interactive map, which will display graph nodes grouped by clusters. Each cluster will have its own color and name. Node markers will have a random offset to avoid overlapping.

    -
    -sloyka.src.visual.graph_visualization.draw_graph_folium(graph_path, output_file=None)[source]
    +
    +sloyka.src.visual.graph_visualization.visualize_graph(G, zoom: int)[source]

    Visualizes a graph from the given graph_path using Folium and MarkerCluster.

    Parameters:
    -
      -

    • graph_path (str) – The path to the graphml file.

      • -

    • output_file (str, optional) – The file to save the visualization to. Defaults to None.

      • -
    +

    output_file (str, optional) – The file to save the visualization to. Defaults to None.

    Returns:

    The folium map object representing the visualized graph.

    @@ -374,7 +358,7 @@
    @@ -386,9 +370,9 @@
    -
    + - + \ No newline at end of file diff --git a/docs/build/html/objects.inv b/docs/build/html/objects.inv index 03cef36..25f8306 100644 Binary files a/docs/build/html/objects.inv and b/docs/build/html/objects.inv differ diff --git a/docs/build/html/py-modindex.html b/docs/build/html/py-modindex.html index faa2657..5980b36 100644 --- a/docs/build/html/py-modindex.html +++ b/docs/build/html/py-modindex.html @@ -4,10 +4,10 @@ - Python Module Index - sloyka 0.1.0 documentation + Python Module Index - sloyka 0.2.1 documentation - - + + @@ -87,19 +87,6 @@     - - Auto light/dark mode - - - - - - - - - - Auto light/dark, in light mode - @@ -178,7 +165,7 @@
    -
    sloyka 0.1.0 documentation
     +
    sloyka 0.2.1 documentation
    @@ -205,7 +192,7 @@
    - sloyka 0.1.0 documentation + sloyka 0.2.1 documentation @@ -372,9 +359,9 @@

    Python Module Index

    - + - + \ No newline at end of file diff --git a/docs/build/html/search.html b/docs/build/html/search.html index 48982df..69c81d3 100644 --- a/docs/build/html/search.html +++ b/docs/build/html/search.html @@ -5,11 +5,11 @@ - + -Search - sloyka 0.1.0 documentation - - +Search - sloyka 0.2.1 documentation + + @@ -89,19 +89,6 @@     - - Auto light/dark mode - - - - - - - - - - Auto light/dark, in light mode - @@ -180,7 +167,7 @@
    -
    sloyka 0.1.0 documentation
     +
    sloyka 0.2.1 documentation
    @@ -207,7 +194,7 @@
    - sloyka 0.1.0 documentation + sloyka 0.2.1 documentation @@ -329,10 +316,10 @@
    - + - + diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js index d8b071a..0ea7dd5 100644 --- a/docs/build/html/searchindex.js +++ b/docs/build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"Advanced geocoding": [[12, null], [15, null]], "Data getter": [[12, "data-getter"]], "Emotion classifier": [[13, "module-sloyka.src.risks.emotion_classifier"]], "Event detector": [[14, "module-sloyka.src.risks.event_detector"]], "Example": [[13, "example"]], "General:": [[4, null]], "GeoDataGetter": [[5, "geodatagetter"]], "Geocoder": [[6, "geocoder"], [15, "id1"]], "Geocoding": [[15, "geocoding"]], "Graph visualization": [[20, "graph-visualization"]], "Indices and tables": [[4, "indices-and-tables"]], "Installation": [[1, "installation"]], "Introduction": [[2, "introduction"]], "Main features": [[2, "main-features"]], "Main pipeline": [[3, "main-pipeline"]], "OtherGeoObjects": [[7, "othergeoobjects"], [15, "othergeoobjects"]], "Page Not Found": [[0, "page-not-found"]], "Regional activity": [[16, "regional-activity"]], "Semantic graph": [[17, "module-sloyka.src.semantic_graph.semantic_graph_builder"]], "Services extraction": [[11, "services-extraction"]], "StreetExtractor": [[8, "streetextractor"], [15, "streetextractor"]], "Streets": [[9, "streets"]], "Text Classifier": [[18, "text-classifier"]], "Topic Modelling": [[19, "topic-modelling"]], "VKparser": [[10, "vkparser"]], "Welcome to Sloyka\u2019s documentation!": [[4, "welcome-to-sloyka-s-documentation"]], "more:": [[12, "more"], [15, "more"]]}, "docnames": ["404", "about/installation", "about/introduction", "about/pipeline", "index", "modules/GeoDataGetter", "modules/Geocoder_special", "modules/OtherGeoObjects", "modules/StreetExtractor", "modules/Streets", "modules/VKParser", "modules/city_services_extract", "modules/data_getter", "modules/emotion_classifier", "modules/event_dynamic_prediction", "modules/geocoder", "modules/regional_activity", "modules/semantic_graph", "modules/text_classifier", "modules/topic_modeler", "modules/visualize_graph"], "envversion": {"sphinx": 61, "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": ["404.rst", "about/installation.rst", "about/introduction.rst", "about/pipeline.rst", "index.rst", "modules/GeoDataGetter.rst", "modules/Geocoder_special.rst", "modules/OtherGeoObjects.rst", "modules/StreetExtractor.rst", "modules/Streets.rst", "modules/VKParser.rst", "modules/city_services_extract.rst", "modules/data_getter.rst", "modules/emotion_classifier.rst", "modules/event_dynamic_prediction.rst", "modules/geocoder.rst", "modules/regional_activity.rst", "modules/semantic_graph.rst", "modules/text_classifier.rst", "modules/topic_modeler.rst", "modules/visualize_graph.rst"], "indexentries": {"assign_street() (sloyka.src.geocoder.geocoder.geocoder method)": [[6, "sloyka.src.geocoder.geocoder.Geocoder.assign_street", false]], "build_graph() (sloyka.src.semantic_graph.semantic_graph_builder.semgraph method)": [[17, "sloyka.src.semantic_graph.semantic_graph_builder.Semgraph.build_graph", false]], "calculate_centroid() (sloyka.src.geocoder.city_objects_extractor.othergeoobjects static method)": [[7, "sloyka.src.geocoder.city_objects_extractor.OtherGeoObjects.calculate_centroid", false]], "city_services (class in sloyka.src.utils.data_processing.city_services_extract)": [[11, "sloyka.src.utils.data_processing.city_services_extract.City_services", false]], "classify_text() (sloyka.src.risks.text_classifier.textclassifiers method)": [[18, "sloyka.src.risks.text_classifier.TextClassifiers.classify_text", false]], "convert_df_to_edge_df() (sloyka.src.semantic_graph.semantic_graph_builder.semgraph static method)": [[17, "sloyka.src.semantic_graph.semantic_graph_builder.Semgraph.convert_df_to_edge_df", false]], "create_gdf() (sloyka.src.geocoder.geocoder.geocoder method)": [[6, "sloyka.src.geocoder.geocoder.Geocoder.create_gdf", false]], "dir_path (sloyka.src.geocoder.geocoder.geocoder attribute)": [[6, "sloyka.src.geocoder.geocoder.Geocoder.dir_path", false]], "draw_graph_folium() (in module sloyka.src.visual.graph_visualization)": [[20, "sloyka.src.visual.graph_visualization.draw_graph_folium", false]], "emotionrecognizer (class in sloyka.src.risks.emotion_classifier)": [[13, "sloyka.src.risks.emotion_classifier.EmotionRecognizer", false]], "eventdetection (class in sloyka.src.risks.event_detector)": [[14, "sloyka.src.risks.event_detector.EventDetection", false]], "extract_geo_obj() (sloyka.src.geocoder.city_objects_extractor.othergeoobjects static method)": [[7, "sloyka.src.geocoder.city_objects_extractor.OtherGeoObjects.extract_geo_obj", false]], "extract_ner_street() (sloyka.src.geocoder.street_extractor.streetextractor static method)": [[8, "sloyka.src.geocoder.street_extractor.StreetExtractor.extract_ner_street", false]], "extract_toponym() (sloyka.src.geocoder.street_extractor.streetextractor static method)": [[8, "sloyka.src.geocoder.street_extractor.StreetExtractor.extract_toponym", false]], "extraction_services() (sloyka.src.utils.data_processing.city_services_extract.city_services method)": [[11, "sloyka.src.utils.data_processing.city_services_extract.City_services.extraction_services", false]], "extractor (sloyka.src.geocoder.street_extractor.streetextractor attribute)": [[8, "sloyka.src.geocoder.street_extractor.StreetExtractor.extractor", false]], "geocoder (class in sloyka.src.geocoder.geocoder)": [[6, "sloyka.src.geocoder.geocoder.Geocoder", false], [15, "sloyka.src.geocoder.geocoder.Geocoder", false]], "get_and_process_osm_data() (sloyka.src.geocoder.city_objects_extractor.othergeoobjects static method)": [[7, "sloyka.src.geocoder.city_objects_extractor.OtherGeoObjects.get_and_process_osm_data", false]], "get_df_areas() (sloyka.src.geocoder.geocoder.geocoder method)": [[6, "sloyka.src.geocoder.geocoder.Geocoder.get_df_areas", false]], "get_level() (sloyka.src.geocoder.geocoder.geocoder static method)": [[6, "sloyka.src.geocoder.geocoder.Geocoder.get_level", false]], "get_stem() (sloyka.src.geocoder.geocoder.geocoder static method)": [[6, "sloyka.src.geocoder.geocoder.Geocoder.get_stem", false]], "global_crs (sloyka.src.geocoder.geocoder.geocoder attribute)": [[6, "sloyka.src.geocoder.geocoder.Geocoder.global_crs", false]], "initialize_classifier() (sloyka.src.risks.text_classifier.textclassifiers method)": [[18, "sloyka.src.risks.text_classifier.TextClassifiers.initialize_classifier", false]], "match_group_to_area() (sloyka.src.geocoder.geocoder.geocoder method)": [[6, "sloyka.src.geocoder.geocoder.Geocoder.match_group_to_area", false]], "merge_to_initial_df() (sloyka.src.geocoder.geocoder.geocoder method)": [[6, "sloyka.src.geocoder.geocoder.Geocoder.merge_to_initial_df", false]], "module": [[11, "module-sloyka.src.utils.data_processing.city_services_extract", false], [13, "module-sloyka.src.risks.emotion_classifier", false], [14, "module-sloyka.src.risks.event_detector", false], [17, "module-sloyka.src.semantic_graph.semantic_graph_builder", false], [18, "module-sloyka.src.risks.text_classifier", false], [20, "module-sloyka.src.visual.graph_visualization", false]], "othergeoobjects (class in sloyka.src.geocoder.city_objects_extractor)": [[15, "sloyka.src.geocoder.city_objects_extractor.OtherGeoObjects", false]], "preprocess_area_names() (sloyka.src.geocoder.geocoder.geocoder method)": [[6, "sloyka.src.geocoder.geocoder.Geocoder.preprocess_area_names", false]], "preprocess_group_name() (sloyka.src.geocoder.geocoder.geocoder method)": [[6, "sloyka.src.geocoder.geocoder.Geocoder.preprocess_group_name", false]], "process_pipeline() (sloyka.src.geocoder.street_extractor.streetextractor static method)": [[8, "sloyka.src.geocoder.street_extractor.StreetExtractor.process_pipeline", false]], "recognize_average_emotion_from_multiple_models() (sloyka.src.risks.emotion_classifier.emotionrecognizer method)": [[13, "sloyka.src.risks.emotion_classifier.EmotionRecognizer.recognize_average_emotion_from_multiple_models", false]], "recognize_emotion() (sloyka.src.risks.emotion_classifier.emotionrecognizer method)": [[13, "sloyka.src.risks.emotion_classifier.EmotionRecognizer.recognize_emotion", false]], "remove_last_letter() (sloyka.src.utils.data_processing.city_services_extract.city_services method)": [[11, "sloyka.src.utils.data_processing.city_services_extract.City_services.remove_last_letter", false]], "replace_with_most_similar() (sloyka.src.utils.data_processing.city_services_extract.city_services method)": [[11, "sloyka.src.utils.data_processing.city_services_extract.City_services.replace_with_most_similar", false]], "restoration_of_normal_form() (sloyka.src.geocoder.city_objects_extractor.othergeoobjects static method)": [[7, "sloyka.src.geocoder.city_objects_extractor.OtherGeoObjects.restoration_of_normal_form", false]], "run() (sloyka.src.geocoder.city_objects_extractor.othergeoobjects static method)": [[15, "sloyka.src.geocoder.city_objects_extractor.OtherGeoObjects.run", false]], "run() (sloyka.src.geocoder.geocoder.geocoder method)": [[6, "sloyka.src.geocoder.geocoder.Geocoder.run", false], [15, "sloyka.src.geocoder.geocoder.Geocoder.run", false]], "run() (sloyka.src.risks.event_detector.eventdetection method)": [[14, "sloyka.src.risks.event_detector.EventDetection.run", false]], "run() (sloyka.src.utils.data_processing.city_services_extract.city_services method)": [[11, "sloyka.src.utils.data_processing.city_services_extract.City_services.run", false]], "run_osm_dfs() (sloyka.src.geocoder.city_objects_extractor.othergeoobjects static method)": [[7, "sloyka.src.geocoder.city_objects_extractor.OtherGeoObjects.run_osm_dfs", false]], "run_text_classifier() (sloyka.src.risks.text_classifier.textclassifiers method)": [[18, "sloyka.src.risks.text_classifier.TextClassifiers.run_text_classifier", false]], "run_text_classifier_topics() (sloyka.src.risks.text_classifier.textclassifiers method)": [[18, "sloyka.src.risks.text_classifier.TextClassifiers.run_text_classifier_topics", false]], "semgraph (class in sloyka.src.semantic_graph.semantic_graph_builder)": [[17, "sloyka.src.semantic_graph.semantic_graph_builder.Semgraph", false]], "set_global_repr_point() (sloyka.src.geocoder.geocoder.geocoder method)": [[6, "sloyka.src.geocoder.geocoder.Geocoder.set_global_repr_point", false]], "sloyka.src.risks.emotion_classifier": [[13, "module-sloyka.src.risks.emotion_classifier", false]], "sloyka.src.risks.event_detector": [[14, "module-sloyka.src.risks.event_detector", false]], "sloyka.src.risks.text_classifier": [[18, "module-sloyka.src.risks.text_classifier", false]], "sloyka.src.semantic_graph.semantic_graph_builder": [[17, "module-sloyka.src.semantic_graph.semantic_graph_builder", false]], "sloyka.src.utils.data_processing.city_services_extract": [[11, "module-sloyka.src.utils.data_processing.city_services_extract", false]], "sloyka.src.visual.graph_visualization": [[20, "module-sloyka.src.visual.graph_visualization", false]], "streetextractor (class in sloyka.src.geocoder.street_extractor)": [[8, "sloyka.src.geocoder.street_extractor.StreetExtractor", false], [15, "sloyka.src.geocoder.street_extractor.StreetExtractor", false]], "textclassifiers (class in sloyka.src.risks.text_classifier)": [[18, "sloyka.src.risks.text_classifier.TextClassifiers", false]], "update_graph() (sloyka.src.semantic_graph.semantic_graph_builder.semgraph method)": [[17, "sloyka.src.semantic_graph.semantic_graph_builder.Semgraph.update_graph", false]]}, "objects": {"sloyka.src.geocoder.city_objects_extractor": [[15, 0, 1, "", "OtherGeoObjects"]], "sloyka.src.geocoder.city_objects_extractor.OtherGeoObjects": [[7, 1, 1, "", "calculate_centroid"], [7, 1, 1, "", "extract_geo_obj"], [7, 1, 1, "", "get_and_process_osm_data"], [7, 1, 1, "", "restoration_of_normal_form"], [15, 1, 1, "", "run"], [7, 1, 1, "", "run_osm_dfs"]], "sloyka.src.geocoder.geocoder": [[15, 0, 1, "", "Geocoder"]], "sloyka.src.geocoder.geocoder.Geocoder": [[6, 1, 1, "", "assign_street"], [6, 1, 1, "", "create_gdf"], [6, 2, 1, "", "dir_path"], [6, 1, 1, "", "get_df_areas"], [6, 1, 1, "", "get_level"], [6, 1, 1, "", "get_stem"], [6, 2, 1, "", "global_crs"], [6, 1, 1, "", "match_group_to_area"], [6, 1, 1, "", "merge_to_initial_df"], [6, 1, 1, "", "preprocess_area_names"], [6, 1, 1, "", "preprocess_group_name"], [15, 1, 1, "", "run"], [6, 1, 1, "", "set_global_repr_point"]], "sloyka.src.geocoder.street_extractor": [[15, 0, 1, "", "StreetExtractor"]], "sloyka.src.geocoder.street_extractor.StreetExtractor": [[8, 1, 1, "", "extract_ner_street"], [8, 1, 1, "", "extract_toponym"], [8, 2, 1, "", "extractor"], [8, 1, 1, "", "process_pipeline"]], "sloyka.src.risks": [[13, 3, 0, "-", "emotion_classifier"], [14, 3, 0, "-", "event_detector"], [18, 3, 0, "-", "text_classifier"]], "sloyka.src.risks.emotion_classifier": [[13, 0, 1, "", "EmotionRecognizer"]], "sloyka.src.risks.emotion_classifier.EmotionRecognizer": [[13, 1, 1, "", "recognize_average_emotion_from_multiple_models"], [13, 1, 1, "", "recognize_emotion"]], "sloyka.src.risks.event_detector": [[14, 0, 1, "", "EventDetection"]], "sloyka.src.risks.event_detector.EventDetection": [[14, 1, 1, "", "run"]], "sloyka.src.risks.text_classifier": [[18, 0, 1, "", "TextClassifiers"]], "sloyka.src.risks.text_classifier.TextClassifiers": [[18, 1, 1, "", "classify_text"], [18, 1, 1, "", "initialize_classifier"], [18, 1, 1, "", "run_text_classifier"], [18, 1, 1, "", "run_text_classifier_topics"]], "sloyka.src.semantic_graph": [[17, 3, 0, "-", "semantic_graph_builder"]], "sloyka.src.semantic_graph.semantic_graph_builder": [[17, 0, 1, "", "Semgraph"]], "sloyka.src.semantic_graph.semantic_graph_builder.Semgraph": [[17, 1, 1, "", "build_graph"], [17, 1, 1, "", "convert_df_to_edge_df"], [17, 1, 1, "", "update_graph"]], "sloyka.src.utils.data_processing": [[11, 3, 0, "-", "city_services_extract"]], "sloyka.src.utils.data_processing.city_services_extract": [[11, 0, 1, "", "City_services"]], "sloyka.src.utils.data_processing.city_services_extract.City_services": [[11, 1, 1, "", "extraction_services"], [11, 1, 1, "", "remove_last_letter"], [11, 1, 1, "", "replace_with_most_similar"], [11, 1, 1, "", "run"]], "sloyka.src.visual": [[20, 3, 0, "-", "graph_visualization"]], "sloyka.src.visual.graph_visualization": [[20, 4, 1, "", "draw_graph_folium"]]}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "method", "Python method"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "module", "Python module"], "4": ["py", "function", "Python function"]}, "objtypes": {"0": "py:class", "1": "py:method", "2": "py:attribute", "3": "py:module", "4": "py:function"}, "terms": {"": [2, 3], "0": [2, 7, 17], "000": 18, "1": [6, 17, 18, 19], "100": [], "131": [], "15": 19, "2": 6, "2024": 2, "3": 6, "4326": 6, "5": [], "50": [], "6": [2, 17], "7": 7, "70": 7, "75": 17, "90": 18, "A": [6, 8, 9, 12, 17], "And": [], "As": 17, "By": 3, "For": 17, "If": 6, "In": 18, "It": [6, 13, 14, 15, 17, 18, 19], "Its": 2, "Not": [], "The": [2, 3, 6, 7, 8, 11, 13, 14, 15, 16, 17, 18, 19, 20], "To": [1, 15], "_collect_popul": 14, "_geocoder_speci": [], "_get_build": 14, "_get_road": 14, "_preprocess": 14, "about": [3, 16, 19], "access": 18, "access_token": [], "accord": 6, "account": 11, "accsess_token": [], "across": 3, "activ": [2, 3], "actual": 6, "ad": 13, "add": 6, "addit": [2, 19], "address": [6, 8, 15], "admin": [6, 15], "after": [2, 6, 15, 16, 17], "against": 6, "aggreg": [16, 17], "aggregate_data": 17, "aim": [2, 14, 17, 18, 19], "algorithm": 11, "all": [3, 6], "alreadi": [2, 3, 6], "also": [2, 6, 15], "amen": 18, "an": [6, 7, 13, 14, 15, 20], "analyz": [4, 13], "ani": [3, 6, 13, 17, 19], "api": [], "api_verison": [], "appdata": [], "appli": [3, 8, 13], "applic": [14, 17], "ar": [3, 6, 15, 17], "area": [3, 6, 15], "area_nam": 6, "area_name_process": 6, "area_stem": 6, "around": 8, "arrai": 7, "assess": [2, 3], "assign": [6, 15], "assign_street": 6, "attribut": [6, 13, 16, 17, 18], "augment": 2, "authent": [], "autoclass": 9, "autom": [], "automat": 13, "automodul": [], "avail": 13, "averag": 13, "avoid": 20, "back": [6, 13], "base": [5, 12, 14, 16, 17, 18], "basic": 16, "being": 18, "belong": 19, "below": 8, "bert": [17, 18], "bert_larg": 13, "bert_nam": 17, "bertop": [14, 19], "best": [6, 15], "between": [14, 17], "bool": 17, "box": 0, "build": [2, 14, 17], "build_graph": 17, "c": [], "cach": 6, "calcul": [7, 13], "calculate_centroid": 7, "call": [16, 18], "can": [2, 3, 13, 16], "care": 18, "carri": 3, "case": [3, 17, 18], "categor": 2, "categori": [13, 18], "categoris": 13, "centroid": [6, 7], "certain": 3, "chang": 11, "charact": 6, "character": 3, "chat": 2, "check": 6, "child": 17, "citi": [2, 4, 6, 11, 14, 18, 19], "citizen": 2, "city_cr": 14, "city_nam": 14, "city_objects_extractor": 15, "city_servic": 11, "city_services_extract": [11, 16], "city_tag": [6, 15], "class": [5, 6, 8, 9, 11, 12, 13, 14, 15, 16, 17, 18, 19], "classif": [15, 18], "classifi": [2, 3, 8, 16], "classify_text": 18, "clean": 17, "clean_from_digit": 17, "clean_from_dubl": 17, "clean_from_toponym": 17, "cluster": [14, 19, 20], "code": 6, "cointegr": 19, "collect": [2, 7, 14], "color": 20, "column": [2, 3, 6, 11, 13, 15, 17], "combin": 7, "comment": 2, "comments_to_datafram": [], "commun": [2, 3], "compar": 7, "comparison": 11, "compat": 13, "comprehens": [], "confid": 8, "connect": 14, "consist": 3, "construct": [2, 17], "contain": [6, 8, 12, 13, 14, 17, 18], "content": 8, "context": 14, "conveni": 17, "convert": 6, "convert_df_to_edge_df": 17, "convini": 17, "correctli": 18, "correspond": [6, 15], "cosin": 17, "couldn": 0, "count": [17, 18], "count_item": [], "counts_attribut": 17, "cpu": [6, 13, 15, 17], "creat": [6, 15, 16, 17, 19], "create_gdf": 6, "csv": 13, "cuda": 13, "custom": 8, "cutoff": [], "cutoff_d": [], "d": [], "dai": 19, "data": [2, 3, 4, 5, 6, 7, 9, 13, 14, 15, 16, 17, 19], "data_gett": 9, "data_process": 11, "datafram": [6, 7, 8, 11, 13, 15, 16, 17], "dataset": 3, "date": [2, 6, 15, 19], "deeppavlov": 17, "default": [6, 13, 15, 17, 20], "design": [11, 13, 16, 18, 19], "detector": [], "determin": 17, "devic": [6, 13, 15, 17, 18], "device_typ": 18, "df": [6, 8, 11, 13, 15], "df_area": 6, "dict": [6, 7, 15], "dictionari": 6, "didn": 6, "differ": [6, 7], "digit": [2, 17], "dir_path": 6, "direct": 17, "displai": 20, "distanc": 17, "divid": 3, "do": 15, "document": [2, 6], "domain": [], "don": 6, "done": 19, "draw_graph_folium": 20, "duplic": 17, "dure": 13, "dynam": 19, "each": [3, 6, 14, 15, 17, 19, 20], "effici": 18, "element": [2, 6], "embed": [17, 19], "embedding_model_nam": 19, "emot": [2, 3], "emotion_classifi": [13, 16], "emotionclassifi": 13, "emotionrecogn": 13, "empti": [], "enabl": 13, "end": 11, "end_dat": 19, "enrich": 2, "entiti": [2, 7, 11], "environ": 2, "evalu": 2, "event": [2, 18], "event_detector": 14, "eventdetect": 14, "exampl": 18, "exist": 2, "extract": [2, 3, 7, 8, 15, 17, 19], "extract_building_num": [], "extract_geo_obj": 7, "extract_ner_street": 8, "extract_toponym": 8, "extraction_servic": 11, "extractor": [6, 8, 15], "fail": 8, "fall": 13, "fals": [6, 15, 18], "famili": 18, "featur": [], "fetch": [], "file": 20, "filepath_to_popul": 14, "filter": [6, 15, 17], "final": [2, 6, 15, 17], "find": [0, 6, 7, 15], "finder": [], "first": [6, 8], "flag": 17, "flair": [6, 11, 15], "float": 17, "folium": 20, "follow": [13, 14, 17, 18, 19], "footprint": 2, "forecast": 3, "form": [6, 7, 15], "format": [], "found": [6, 8], "from": [2, 5, 6, 7, 8, 11, 12, 15, 17, 19, 20], "function": [3, 6, 7, 8, 15, 16, 17, 18, 19, 20], "further": [2, 3], "g": 17, "gdf": [6, 19], "gener": [2, 3, 14, 15], "geo": [], "geocod": [3, 8, 16, 17], "geodatafram": [2, 6, 14, 15, 16, 17, 19], "geodatagett": 12, "geograph": [6, 15], "geoloc": [3, 17], "geometri": [6, 7, 17], "geometry_column": 17, "geor111i": [6, 15], "geospati": [5, 12], "get": [2, 3, 14], "get_and_process_osm_data": 7, "get_com": [], "get_df_area": 6, "get_group_nam": [], "get_group_post_id": [], "get_level": 6, "get_owner_id_by_domain": [], "get_risk": 16, "get_stem": 6, "get_subcom": [], "getter": 3, "given": [5, 6, 12, 13, 15, 17, 20], "global": [6, 19], "global_cr": 6, "go": 0, "gpd": [6, 15, 17], "gpu": 13, "graph": [2, 3], "graph_path": 20, "graph_visu": 20, "graphml": 20, "group": [3, 6, 15, 20], "group_column": [6, 15], "group_nam": [6, 15], "ha": [13, 14, 17, 18, 19], "have": 20, "health": 18, "histgeodatagett": 6, "hold": 13, "homepag": 0, "hous": [6, 18], "howev": 3, "http": 2, "huggingfac": [13, 18], "huggingfacemodel": 13, "hypergraph": 2, "i": [2, 3, 4, 5, 6, 7, 8, 11, 12, 13, 14, 16, 17, 18, 19], "id": [5, 6, 12, 15, 18], "id_column": 17, "ident": 4, "identifi": [8, 17, 18, 19], "import": 3, "includ": 16, "incom": 19, "index": 4, "indic": 17, "inf": [], "infer": [13, 17], "infin": [], "info": [3, 6], "inform": [16, 17], "initi": [6, 16, 18], "initial_df": 6, "initialize_classifi": 18, "input": [6, 8, 13, 15, 17, 18], "instal": 4, "instanti": 13, "int": [6, 7, 14, 15, 17, 18], "interact": 20, "interpret": 2, "introduct": 4, "is_top": 18, "its": 20, "june": 2, "keep": 6, "kei": 17, "key_score_filt": 17, "keybert": 17, "keyword": 17, "know": 6, "label": 3, "languag": 17, "last": 3, "launch": 15, "least": 7, "level": [6, 15, 18], "librari": [2, 3, 4, 7, 11, 17], "like": 13, "limit": 3, "linear": 15, "link": [2, 14], "list": [3, 7, 11], "locat": [2, 7, 17], "location_column": 17, "logistic_regress": [], "low": 18, "lowercas": 6, "m": [], "machin": 2, "mai": 19, "main": [4, 17, 18, 19], "major": 3, "mani": 18, "map": 20, "mark": 18, "marker": 20, "markerclust": 20, "match": [6, 15, 17], "match_group_to_area": 6, "maximum": [], "me": 2, "media": [2, 4], "member": 9, "mention": [2, 3, 8], "meow": [], "merg": [6, 15, 19], "merge_to_initial_df": 6, "messag": [2, 3, 6, 11, 14, 17, 18, 19], "method": [2, 3, 11, 13, 14, 17, 18, 19], "min_event_s": 14, "min_text": 19, "model": [2, 3, 6, 8, 13, 14, 15, 17, 18], "model_nam": 13, "model_path": [6, 15], "modul": [2, 4, 12, 13, 14, 15, 16, 17, 18, 19], "more": [3, 17], "most": [11, 13], "multipl": 13, "name": [6, 8, 11, 13, 15, 17, 20], "natasha": 7, "natashaextractor": 8, "ner": [6, 8, 15], "network": [2, 3, 12, 14], "new": [2, 11, 17], "node": [2, 17, 20], "none": [6, 8, 13, 15, 17, 18, 20], "normal": 7, "number": [6, 17, 18], "number_of_categori": 18, "number_of_messag": [], "nx": 17, "object": [2, 3, 6, 7, 8, 11, 14, 15, 18, 20], "obtain": [2, 3, 17], "offset": 20, "one": 7, "onli": [3, 6], "onlin": 3, "openstreetmap": [5, 6, 12], "option": [6, 8, 15, 20], "order": [3, 6], "origin": [6, 11], "osm": [5, 6, 7, 12, 15], "osm_combined_df": 7, "osm_id": [6, 7, 15], "other": [6, 13, 15, 16, 18], "other_geo_obj": 7, "otherwis": [3, 6, 8, 13], "out": [3, 6], "output_fil": 20, "overlap": 20, "own": 20, "owner": [], "owner_id": [], "packag": [], "page": 4, "panda": [], "param": 17, "paramet": [6, 8, 15, 17, 20], "parent": 17, "parents_stack_column": 17, "pars": 2, "parser": [], "particular": 2, "path": 20, "pd": [6, 8, 13, 15, 17], "per": 18, "percentag": 7, "perform": 15, "perisiqu": [], "pip": 1, "pipelin": [4, 6, 15, 18], "place": [2, 6, 15, 17], "point": [6, 7], "polygon": 7, "popul": 14, "posit": 8, "possibl": 3, "post": [2, 17, 19], "post_id": [], "post_id_column": 17, "post_num_limit": [], "pre": [8, 18], "predict": [2, 18], "preprocess": [6, 14, 15], "preprocess_area_nam": 6, "preprocess_group_nam": 6, "present": 8, "prevail": 13, "previous": [], "probabl": [11, 18], "process": [2, 6, 7, 8, 15, 16, 18, 19], "process_pipelin": 8, "process_top": 19, "processed_geodata": 16, "provid": [2, 6, 15, 16, 17], "proxim": 17, "public": 18, "python": [], "python311": [], "pytorch": 17, "qualiti": 2, "random": 20, "rang": [8, 19], "read_csv": 13, "receiv": [2, 3], "recogn": [6, 13], "recognis": 6, "recognit": [2, 13], "recognize_average_emotion_from_multiple_model": 13, "recognize_emot": 13, "refer": 17, "regard": 2, "region": [2, 3], "regional_act": 16, "regionalact": 16, "relat": [8, 15], "relationship": 17, "remov": [6, 8, 17], "remove_last_lett": 11, "replace_with_most_similar": 11, "repli": 2, "repositori": 18, "repository_id": 18, "repres": [6, 20], "request": [], "requir": 3, "restoration_of_normal_form": 7, "result": [2, 17, 19, 20], "retriev": [5, 6, 7, 12, 15], "return": [6, 7, 8, 13, 14, 15, 16, 17, 18, 20], "risk": [2, 3, 13, 14, 16, 18], "road": 14, "roadmap": 4, "roam": [], "row": 6, "rubert": [17, 18, 19], "run": [1, 3, 6, 11, 14, 15], "run_com": [], "run_osm_df": 7, "run_pars": [], "run_post": [], "run_text_classifi": 18, "run_text_classifier_top": 18, "russian": [17, 18], "save": 20, "scale": 6, "score": [8, 17], "search": [0, 4, 8], "search_for_object": [6, 15], "section": 3, "see": 15, "select": [3, 13], "semant": [2, 3, 14], "semantic_graph": 17, "semantic_graph_build": 17, "semantic_score_filt": 17, "semgraph": 17, "sentenc": 11, "seri": [6, 8], "servic": [2, 3], "set": [6, 13, 17], "set_global_repr_point": 6, "similar": 7, "simpl": [6, 15], "simpli": 6, "site": 3, "size": [], "skip": 3, "sloyka": [1, 2, 3, 6, 8, 9, 11, 12, 13, 14, 15, 17, 18, 20], "sloyka_commun": 2, "so": 18, "social": [2, 3, 4, 12, 16], "some": [3, 19], "sorri": 0, "sourc": [6, 7, 8, 11, 13, 14, 15, 17, 18, 20], "spatial": [2, 7, 14], "special": 6, "specif": 18, "specifi": [6, 8, 17, 18, 19], "src": [6, 8, 9, 11, 13, 14, 15, 17, 18, 20], "stage": 2, "start_dat": 19, "state": [6, 15], "static": [6, 7, 8, 15, 17], "stem": 6, "step": 3, "stop": [], "stopword": 6, "store": [11, 16, 19], "str": [6, 7, 8, 14, 15, 17, 18, 20], "street": [6, 8, 12, 14, 15], "street_extractor": [8, 15], "street_nam": 8, "street_names_df": 6, "string": 11, "structur": 18, "subcom": [], "success": [], "synthesi": 3, "synthet": 18, "t": [0, 2, 6], "tag": [2, 3, 5, 6, 7, 12, 15], "take": [11, 18], "target_text": 14, "test": 6, "text": [2, 3, 6, 7, 8, 11, 13, 14, 15, 16, 17, 19], "text_address_extractor_by_rul": 8, "text_classifi": 18, "text_column": [6, 8, 11, 13, 15, 17], "text_type_column": 17, "textclassifi": 18, "textual": 2, "thank": 17, "thei": 3, "them": [2, 6, 7, 11], "theme": 18, "thi": [3, 5, 6, 7, 8, 12, 13, 14, 15, 17, 18], "those": 6, "three": 18, "threshold": [7, 8, 17], "timeout_limit": [], "tini": 18, "tiny2": [18, 19], "token": 18, "too": 18, "top": 17, "top_n": 17, "topic": [2, 3], "topicmodel": 19, "toponym": [8, 17], "toponym_column": 17, "toponym_name_column": 17, "toponym_type_column": 17, "train": [6, 8, 13, 18], "transform": [13, 18], "transport": 18, "true": [13, 17], "try": 0, "tupl": 6, "two": 2, "type": [6, 8, 11, 12, 15, 17, 18, 20], "undoc": 9, "uniqu": 17, "unknown_\u0436\u043a\u0445": 18, "unnecessari": 8, "up": 18, "updat": 17, "update_graph": 17, "upper": 18, "urban": [2, 3, 7, 14, 15, 18], "us": [0, 2, 4, 5, 7, 8, 11, 12, 13, 16, 17, 18, 19, 20], "user": [6, 16], "util": [9, 11, 18], "variou": 12, "veri": 3, "vernacular": 2, "version": 2, "visual": [2, 3], "vk": 12, "vk_data_gett": [], "vkontakt": 12, "vkparser": 12, "wa": 18, "wai": 6, "we": [0, 6], "well": [2, 11, 12], "were": [3, 18], "weren": 6, "where": 6, "which": [2, 3, 13, 14, 16, 17, 18, 19, 20], "whose": [], "wide": 19, "within": [2, 8], "word": [6, 15, 17], "word_info_column": 17, "words_scor": 17, "work": [9, 12], "y": [], "you": 3}, "titles": ["Page Not Found", "Installation", "Introduction", "Main pipeline", "Welcome to Sloyka\u2019s documentation!", "GeoDataGetter", "Geocoder", "OtherGeoObjects", "StreetExtractor", "Streets", "VKparser", "Services extraction", "Data getter", "Emotion classifier", "Event detector", "Geocoding", "Regional activity", "Semantic graph", "Text Classifier", "Topic Modelling", "Graph visualization"], "titleterms": {"": 4, "Not": 0, "about": [], "activ": 16, "advanc": [12, 15], "class": [], "classifi": [13, 18], "data": 12, "detector": 14, "document": 4, "emot": 13, "event": 14, "exampl": 13, "extract": 11, "featur": 2, "finder": [], "found": 0, "function": [], "gener": 4, "geo": [], "geocod": [6, 12, 15], "geodatagett": 5, "getter": 12, "graph": [17, 20], "indic": 4, "inner": [], "instal": 1, "introduct": 2, "main": [2, 3], "model": 19, "more": [12, 15], "object": [], "othergeoobject": [7, 15], "page": 0, "pipelin": 3, "receiv": [], "region": 16, "semant": 17, "servic": 11, "sloyka": 4, "street": 9, "streetextractor": [8, 15], "tabl": 4, "tag": [], "text": 18, "topic": 19, "visual": 20, "vkparser": 10, "welcom": 4, "work": []}}) \ No newline at end of file +Search.setIndex({"alltitles": {"Advanced geocoding": [[12, null], [15, null]], "Data getter": [[12, "data-getter"]], "Emotion classifier": [[13, "module-sloyka.src.risks.emotion_classifier"]], "Event detector": [[14, "module-sloyka.src.risks.event_detector"]], "Example": [[13, "example"]], "General:": [[4, null]], "GeoDataGetter": [[5, "geodatagetter"]], "Geocoder": [[6, "geocoder"], [15, "id1"]], "Geocoding": [[15, "geocoding"]], "Graph visualization": [[20, "graph-visualization"]], "Indices and tables": [[4, "indices-and-tables"]], "Installation": [[1, "installation"]], "Introduction": [[2, "introduction"]], "Main features": [[2, "main-features"]], "Main pipeline": [[3, "main-pipeline"]], "OtherGeoObjects": [[7, "othergeoobjects"], [15, "othergeoobjects"]], "Page Not Found": [[0, "page-not-found"]], "Regional activity": [[16, "regional-activity"]], "Semantic graph": [[17, "module-sloyka.src.semantic_graph.semantic_graph_builder"]], "Services extraction": [[11, "services-extraction"]], "StreetExtractor": [[8, "streetextractor"], [15, "streetextractor"]], "Streets": [[9, "streets"]], "Text Classifier": [[18, "text-classifier"]], "Topic Modelling": [[19, "topic-modelling"]], "VKparser": [[10, "vkparser"]], "Welcome to Sloyka\u2019s documentation!": [[4, "welcome-to-sloyka-s-documentation"]], "more:": [[12, "more"], [15, "more"]]}, "docnames": ["404", "about/installation", "about/introduction", "about/pipeline", "index", "modules/GeoDataGetter", "modules/Geocoder_special", "modules/OtherGeoObjects", "modules/StreetExtractor", "modules/Streets", "modules/VKParser", "modules/city_services_extract", "modules/data_getter", "modules/emotion_classifier", "modules/event_dynamic_prediction", "modules/geocoder", "modules/regional_activity", "modules/semantic_graph", "modules/text_classifier", "modules/topic_modeler", "modules/visualize_graph"], "envversion": {"sphinx": 61, "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": ["404.rst", "about/installation.rst", "about/introduction.rst", "about/pipeline.rst", "index.rst", "modules/GeoDataGetter.rst", "modules/Geocoder_special.rst", "modules/OtherGeoObjects.rst", "modules/StreetExtractor.rst", "modules/Streets.rst", "modules/VKParser.rst", "modules/city_services_extract.rst", "modules/data_getter.rst", "modules/emotion_classifier.rst", "modules/event_dynamic_prediction.rst", "modules/geocoder.rst", "modules/regional_activity.rst", "modules/semantic_graph.rst", "modules/text_classifier.rst", "modules/topic_modeler.rst", "modules/visualize_graph.rst"], "indexentries": {"api_verison (sloyka.src.utils.data_getter.vk_data_getter.vkparser attribute)": [[10, "sloyka.src.utils.data_getter.vk_data_getter.VKParser.API_VERISON", false]], "assign_street() (sloyka.src.geocoder.geocoder.geocoder method)": [[6, "sloyka.src.geocoder.geocoder.Geocoder.assign_street", false]], "build_graph() (sloyka.src.semantic_graph.semantic_graph_builder.semgraph method)": [[17, "sloyka.src.semantic_graph.semantic_graph_builder.Semgraph.build_graph", false]], "calculate_centroid() (sloyka.src.geocoder.city_objects_extractor.othergeoobjects static method)": [[7, "id2", false], [7, "sloyka.src.geocoder.city_objects_extractor.OtherGeoObjects.calculate_centroid", false]], "city_services (class in sloyka.src.utils.data_processing.city_services_extract)": [[11, "sloyka.src.utils.data_processing.city_services_extract.City_services", false]], "classify_text() (sloyka.src.risks.text_classifier.textclassifiers method)": [[18, "sloyka.src.risks.text_classifier.TextClassifiers.classify_text", false]], "clear_names() (sloyka.src.utils.data_getter.street_getter.streets static method)": [[9, "sloyka.src.utils.data_getter.street_getter.Streets.clear_names", false]], "combine_city_obj() (sloyka.src.geocoder.city_objects_extractor.othergeoobjects static method)": [[7, "sloyka.src.geocoder.city_objects_extractor.OtherGeoObjects.combine_city_obj", false]], "comments_to_dataframe() (sloyka.src.utils.data_getter.vk_data_getter.vkparser static method)": [[10, "sloyka.src.utils.data_getter.vk_data_getter.VKParser.comments_to_dataframe", false]], "convert_df_to_edge_df() (sloyka.src.semantic_graph.semantic_graph_builder.semgraph static method)": [[17, "sloyka.src.semantic_graph.semantic_graph_builder.Semgraph.convert_df_to_edge_df", false]], "count_items (sloyka.src.utils.data_getter.vk_data_getter.vkparser attribute)": [[10, "sloyka.src.utils.data_getter.vk_data_getter.VKParser.COUNT_ITEMS", false]], "create_gdf() (sloyka.src.geocoder.geocoder.geocoder method)": [[6, "sloyka.src.geocoder.geocoder.Geocoder.create_gdf", false]], "drop_words_from_name() (sloyka.src.utils.data_getter.street_getter.streets static method)": [[9, "sloyka.src.utils.data_getter.street_getter.Streets.drop_words_from_name", false]], "emotionrecognizer (class in sloyka.src.risks.emotion_classifier)": [[13, "sloyka.src.risks.emotion_classifier.EmotionRecognizer", false]], "eventdetection (class in sloyka.src.risks.event_detector)": [[14, "sloyka.src.risks.event_detector.EventDetection", false]], "expand_toponym() (sloyka.src.geocoder.city_objects_extractor.othergeoobjects static method)": [[7, "sloyka.src.geocoder.city_objects_extractor.OtherGeoObjects.expand_toponym", false]], "extract_geo_obj() (sloyka.src.geocoder.city_objects_extractor.othergeoobjects static method)": [[7, "id3", false], [7, "sloyka.src.geocoder.city_objects_extractor.OtherGeoObjects.extract_geo_obj", false]], "extract_ner_street() (sloyka.src.geocoder.street_extractor.streetextractor static method)": [[8, "sloyka.src.geocoder.street_extractor.StreetExtractor.extract_ner_street", false]], "extract_toponym() (sloyka.src.geocoder.street_extractor.streetextractor static method)": [[8, "sloyka.src.geocoder.street_extractor.StreetExtractor.extract_toponym", false]], "extraction_services() (sloyka.src.utils.data_processing.city_services_extract.city_services method)": [[11, "sloyka.src.utils.data_processing.city_services_extract.City_services.extraction_services", false]], "extractor (sloyka.src.geocoder.street_extractor.streetextractor attribute)": [[8, "sloyka.src.geocoder.street_extractor.StreetExtractor.extractor", false]], "find_geo_obj_tag() (sloyka.src.geocoder.city_objects_extractor.othergeoobjects static method)": [[7, "sloyka.src.geocoder.city_objects_extractor.OtherGeoObjects.find_geo_obj_tag", false]], "find_geometry() (sloyka.src.geocoder.city_objects_extractor.othergeoobjects static method)": [[7, "sloyka.src.geocoder.city_objects_extractor.OtherGeoObjects.find_geometry", false]], "find_num_city_obj() (sloyka.src.geocoder.city_objects_extractor.othergeoobjects static method)": [[7, "sloyka.src.geocoder.city_objects_extractor.OtherGeoObjects.find_num_city_obj", false]], "find_toponim_words_from_name() (sloyka.src.utils.data_getter.street_getter.streets static method)": [[9, "sloyka.src.utils.data_getter.street_getter.Streets.find_toponim_words_from_name", false]], "geocoder (class in sloyka.src.geocoder.geocoder)": [[6, "sloyka.src.geocoder.geocoder.Geocoder", false], [15, "sloyka.src.geocoder.geocoder.Geocoder", false]], "geodatagetter (class in sloyka.src.utils.data_getter.geo_data_getter)": [[5, "sloyka.src.utils.data_getter.geo_data_getter.GeoDataGetter", false]], "get_and_process_osm_data() (sloyka.src.geocoder.city_objects_extractor.othergeoobjects static method)": [[7, "id0", false], [7, "sloyka.src.geocoder.city_objects_extractor.OtherGeoObjects.get_and_process_osm_data", false]], "get_city_bounds() (sloyka.src.utils.data_getter.geo_data_getter.geodatagetter static method)": [[5, "sloyka.src.utils.data_getter.geo_data_getter.GeoDataGetter.get_city_bounds", false]], "get_comments() (sloyka.src.utils.data_getter.vk_data_getter.vkparser method)": [[10, "sloyka.src.utils.data_getter.vk_data_getter.VKParser.get_comments", false]], "get_df_areas() (sloyka.src.geocoder.geocoder.geocoder method)": [[6, "sloyka.src.geocoder.geocoder.Geocoder.get_df_areas", false]], "get_drive_graph() (sloyka.src.utils.data_getter.geo_data_getter.geodatagetter static method)": [[5, "sloyka.src.utils.data_getter.geo_data_getter.GeoDataGetter.get_drive_graph", false]], "get_features_from_id() (sloyka.src.utils.data_getter.geo_data_getter.geodatagetter static method)": [[5, "sloyka.src.utils.data_getter.geo_data_getter.GeoDataGetter.get_features_from_id", false]], "get_group_name() (sloyka.src.utils.data_getter.vk_data_getter.vkparser static method)": [[10, "sloyka.src.utils.data_getter.vk_data_getter.VKParser.get_group_name", false]], "get_group_post_ids() (sloyka.src.utils.data_getter.vk_data_getter.vkparser static method)": [[10, "sloyka.src.utils.data_getter.vk_data_getter.VKParser.get_group_post_ids", false]], "get_level() (sloyka.src.geocoder.geocoder.geocoder static method)": [[6, "sloyka.src.geocoder.geocoder.Geocoder.get_level", false]], "get_osm_data() (sloyka.src.utils.data_getter.geo_data_getter.geodatagetter static method)": [[5, "sloyka.src.utils.data_getter.geo_data_getter.GeoDataGetter.get_osm_data", false]], "get_owner_id_by_domain() (sloyka.src.utils.data_getter.vk_data_getter.vkparser static method)": [[10, "sloyka.src.utils.data_getter.vk_data_getter.VKParser.get_owner_id_by_domain", false]], "get_stem() (sloyka.src.geocoder.geocoder.geocoder static method)": [[6, "sloyka.src.geocoder.geocoder.Geocoder.get_stem", false]], "get_street_names() (sloyka.src.utils.data_getter.street_getter.streets static method)": [[9, "sloyka.src.utils.data_getter.street_getter.Streets.get_street_names", false]], "get_subcomments() (sloyka.src.utils.data_getter.vk_data_getter.vkparser static method)": [[10, "sloyka.src.utils.data_getter.vk_data_getter.VKParser.get_subcomments", false]], "get_unique_part_types() (sloyka.src.geocoder.city_objects_extractor.othergeoobjects static method)": [[7, "sloyka.src.geocoder.city_objects_extractor.OtherGeoObjects.get_unique_part_types", false]], "initialize_classifier() (sloyka.src.risks.text_classifier.textclassifiers method)": [[18, "sloyka.src.risks.text_classifier.TextClassifiers.initialize_classifier", false]], "match_group_to_area() (sloyka.src.geocoder.geocoder.geocoder method)": [[6, "sloyka.src.geocoder.geocoder.Geocoder.match_group_to_area", false]], "merge_to_initial_df() (sloyka.src.geocoder.geocoder.geocoder method)": [[6, "sloyka.src.geocoder.geocoder.Geocoder.merge_to_initial_df", false]], "module": [[11, "module-sloyka.src.utils.data_processing.city_services_extract", false], [13, "module-sloyka.src.risks.emotion_classifier", false], [14, "module-sloyka.src.risks.event_detector", false], [17, "module-sloyka.src.semantic_graph.semantic_graph_builder", false], [18, "module-sloyka.src.risks.text_classifier", false], [20, "module-sloyka.src.visual.graph_visualization", false]], "othergeoobjects (class in sloyka.src.geocoder.city_objects_extractor)": [[7, "sloyka.src.geocoder.city_objects_extractor.OtherGeoObjects", false], [15, "sloyka.src.geocoder.city_objects_extractor.OtherGeoObjects", false]], "preprocess_area_names() (sloyka.src.geocoder.geocoder.geocoder method)": [[6, "sloyka.src.geocoder.geocoder.Geocoder.preprocess_area_names", false]], "preprocess_group_name() (sloyka.src.geocoder.geocoder.geocoder method)": [[6, "sloyka.src.geocoder.geocoder.Geocoder.preprocess_group_name", false]], "process_pipeline() (sloyka.src.geocoder.street_extractor.streetextractor static method)": [[8, "sloyka.src.geocoder.street_extractor.StreetExtractor.process_pipeline", false]], "recognize_average_emotion_from_multiple_models() (sloyka.src.risks.emotion_classifier.emotionrecognizer method)": [[13, "sloyka.src.risks.emotion_classifier.EmotionRecognizer.recognize_average_emotion_from_multiple_models", false]], "recognize_emotion() (sloyka.src.risks.emotion_classifier.emotionrecognizer method)": [[13, "sloyka.src.risks.emotion_classifier.EmotionRecognizer.recognize_emotion", false]], "remove_last_letter() (sloyka.src.utils.data_processing.city_services_extract.city_services method)": [[11, "sloyka.src.utils.data_processing.city_services_extract.City_services.remove_last_letter", false]], "replace_with_most_similar() (sloyka.src.utils.data_processing.city_services_extract.city_services method)": [[11, "sloyka.src.utils.data_processing.city_services_extract.City_services.replace_with_most_similar", false]], "restoration_of_normal_form() (sloyka.src.geocoder.city_objects_extractor.othergeoobjects static method)": [[7, "id4", false], [7, "sloyka.src.geocoder.city_objects_extractor.OtherGeoObjects.restoration_of_normal_form", false]], "run() (sloyka.src.geocoder.city_objects_extractor.othergeoobjects static method)": [[7, "sloyka.src.geocoder.city_objects_extractor.OtherGeoObjects.run", false], [15, "sloyka.src.geocoder.city_objects_extractor.OtherGeoObjects.run", false]], "run() (sloyka.src.geocoder.geocoder.geocoder method)": [[6, "sloyka.src.geocoder.geocoder.Geocoder.run", false], [15, "sloyka.src.geocoder.geocoder.Geocoder.run", false]], "run() (sloyka.src.risks.event_detector.eventdetection method)": [[14, "sloyka.src.risks.event_detector.EventDetection.run", false]], "run() (sloyka.src.utils.data_getter.street_getter.streets static method)": [[9, "sloyka.src.utils.data_getter.street_getter.Streets.run", false]], "run() (sloyka.src.utils.data_processing.city_services_extract.city_services method)": [[11, "sloyka.src.utils.data_processing.city_services_extract.City_services.run", false]], "run_comments() (sloyka.src.utils.data_getter.vk_data_getter.vkparser static method)": [[10, "sloyka.src.utils.data_getter.vk_data_getter.VKParser.run_comments", false]], "run_osm_dfs() (sloyka.src.geocoder.city_objects_extractor.othergeoobjects static method)": [[7, "id1", false], [7, "sloyka.src.geocoder.city_objects_extractor.OtherGeoObjects.run_osm_dfs", false]], "run_parser() (sloyka.src.utils.data_getter.vk_data_getter.vkparser static method)": [[10, "sloyka.src.utils.data_getter.vk_data_getter.VKParser.run_parser", false]], "run_posts() (sloyka.src.utils.data_getter.vk_data_getter.vkparser static method)": [[10, "sloyka.src.utils.data_getter.vk_data_getter.VKParser.run_posts", false]], "run_text_classifier() (sloyka.src.risks.text_classifier.textclassifiers method)": [[18, "sloyka.src.risks.text_classifier.TextClassifiers.run_text_classifier", false]], "run_text_classifier_topics() (sloyka.src.risks.text_classifier.textclassifiers method)": [[18, "sloyka.src.risks.text_classifier.TextClassifiers.run_text_classifier_topics", false]], "semgraph (class in sloyka.src.semantic_graph.semantic_graph_builder)": [[17, "sloyka.src.semantic_graph.semantic_graph_builder.Semgraph", false]], "set_global_repr_point() (sloyka.src.geocoder.geocoder.geocoder method)": [[6, "sloyka.src.geocoder.geocoder.Geocoder.set_global_repr_point", false]], "sloyka.src.risks.emotion_classifier": [[13, "module-sloyka.src.risks.emotion_classifier", false]], "sloyka.src.risks.event_detector": [[14, "module-sloyka.src.risks.event_detector", false]], "sloyka.src.risks.text_classifier": [[18, "module-sloyka.src.risks.text_classifier", false]], "sloyka.src.semantic_graph.semantic_graph_builder": [[17, "module-sloyka.src.semantic_graph.semantic_graph_builder", false]], "sloyka.src.utils.data_processing.city_services_extract": [[11, "module-sloyka.src.utils.data_processing.city_services_extract", false]], "sloyka.src.visual.graph_visualization": [[20, "module-sloyka.src.visual.graph_visualization", false]], "streetextractor (class in sloyka.src.geocoder.street_extractor)": [[8, "sloyka.src.geocoder.street_extractor.StreetExtractor", false], [15, "sloyka.src.geocoder.street_extractor.StreetExtractor", false]], "streets (class in sloyka.src.utils.data_getter.street_getter)": [[9, "sloyka.src.utils.data_getter.street_getter.Streets", false]], "textclassifiers (class in sloyka.src.risks.text_classifier)": [[18, "sloyka.src.risks.text_classifier.TextClassifiers", false]], "timeout_limit (sloyka.src.utils.data_getter.vk_data_getter.vkparser attribute)": [[10, "sloyka.src.utils.data_getter.vk_data_getter.VKParser.TIMEOUT_LIMIT", false]], "update_graph() (sloyka.src.semantic_graph.semantic_graph_builder.semgraph method)": [[17, "sloyka.src.semantic_graph.semantic_graph_builder.Semgraph.update_graph", false]], "visualize_graph() (in module sloyka.src.visual.graph_visualization)": [[20, "sloyka.src.visual.graph_visualization.visualize_graph", false]], "vkparser (class in sloyka.src.utils.data_getter.vk_data_getter)": [[10, "sloyka.src.utils.data_getter.vk_data_getter.VKParser", false]]}, "objects": {"sloyka.src.geocoder.city_objects_extractor": [[15, 0, 1, "", "OtherGeoObjects"]], "sloyka.src.geocoder.city_objects_extractor.OtherGeoObjects": [[7, 1, 1, "id2", "calculate_centroid"], [7, 1, 1, "", "combine_city_obj"], [7, 1, 1, "", "expand_toponym"], [7, 1, 1, "id3", "extract_geo_obj"], [7, 1, 1, "", "find_geo_obj_tag"], [7, 1, 1, "", "find_geometry"], [7, 1, 1, "", "find_num_city_obj"], [7, 1, 1, "id0", "get_and_process_osm_data"], [7, 1, 1, "", "get_unique_part_types"], [7, 1, 1, "id4", "restoration_of_normal_form"], [15, 1, 1, "", "run"], [7, 1, 1, "id1", "run_osm_dfs"]], "sloyka.src.geocoder.geocoder": [[15, 0, 1, "", "Geocoder"]], "sloyka.src.geocoder.geocoder.Geocoder": [[6, 1, 1, "", "assign_street"], [6, 1, 1, "", "create_gdf"], [6, 1, 1, "", "get_df_areas"], [6, 1, 1, "", "get_level"], [6, 1, 1, "", "get_stem"], [6, 1, 1, "", "match_group_to_area"], [6, 1, 1, "", "merge_to_initial_df"], [6, 1, 1, "", "preprocess_area_names"], [6, 1, 1, "", "preprocess_group_name"], [15, 1, 1, "", "run"], [6, 1, 1, "", "set_global_repr_point"]], "sloyka.src.geocoder.street_extractor": [[15, 0, 1, "", "StreetExtractor"]], "sloyka.src.geocoder.street_extractor.StreetExtractor": [[8, 1, 1, "", "extract_ner_street"], [8, 1, 1, "", "extract_toponym"], [8, 2, 1, "", "extractor"], [8, 1, 1, "", "process_pipeline"]], "sloyka.src.risks": [[13, 3, 0, "-", "emotion_classifier"], [14, 3, 0, "-", "event_detector"], [18, 3, 0, "-", "text_classifier"]], "sloyka.src.risks.emotion_classifier": [[13, 0, 1, "", "EmotionRecognizer"]], "sloyka.src.risks.emotion_classifier.EmotionRecognizer": [[13, 1, 1, "", "recognize_average_emotion_from_multiple_models"], [13, 1, 1, "", "recognize_emotion"]], "sloyka.src.risks.event_detector": [[14, 0, 1, "", "EventDetection"]], "sloyka.src.risks.event_detector.EventDetection": [[14, 1, 1, "", "run"]], "sloyka.src.risks.text_classifier": [[18, 0, 1, "", "TextClassifiers"]], "sloyka.src.risks.text_classifier.TextClassifiers": [[18, 1, 1, "", "classify_text"], [18, 1, 1, "", "initialize_classifier"], [18, 1, 1, "", "run_text_classifier"], [18, 1, 1, "", "run_text_classifier_topics"]], "sloyka.src.semantic_graph": [[17, 3, 0, "-", "semantic_graph_builder"]], "sloyka.src.semantic_graph.semantic_graph_builder": [[17, 0, 1, "", "Semgraph"]], "sloyka.src.semantic_graph.semantic_graph_builder.Semgraph": [[17, 1, 1, "", "build_graph"], [17, 1, 1, "", "convert_df_to_edge_df"], [17, 1, 1, "", "update_graph"]], "sloyka.src.utils.data_getter.geo_data_getter": [[5, 0, 1, "", "GeoDataGetter"]], "sloyka.src.utils.data_getter.geo_data_getter.GeoDataGetter": [[5, 1, 1, "", "get_city_bounds"], [5, 1, 1, "", "get_drive_graph"], [5, 1, 1, "", "get_features_from_id"], [5, 1, 1, "", "get_osm_data"]], "sloyka.src.utils.data_getter.street_getter": [[9, 0, 1, "", "Streets"]], "sloyka.src.utils.data_getter.street_getter.Streets": [[9, 1, 1, "", "clear_names"], [9, 1, 1, "", "drop_words_from_name"], [9, 1, 1, "", "find_toponim_words_from_name"], [9, 1, 1, "", "get_street_names"], [9, 1, 1, "", "run"]], "sloyka.src.utils.data_getter.vk_data_getter": [[10, 0, 1, "", "VKParser"]], "sloyka.src.utils.data_getter.vk_data_getter.VKParser": [[10, 2, 1, "", "API_VERISON"], [10, 2, 1, "", "COUNT_ITEMS"], [10, 2, 1, "", "TIMEOUT_LIMIT"], [10, 1, 1, "", "comments_to_dataframe"], [10, 1, 1, "", "get_comments"], [10, 1, 1, "", "get_group_name"], [10, 1, 1, "", "get_group_post_ids"], [10, 1, 1, "", "get_owner_id_by_domain"], [10, 1, 1, "", "get_subcomments"], [10, 1, 1, "", "run_comments"], [10, 1, 1, "", "run_parser"], [10, 1, 1, "", "run_posts"]], "sloyka.src.utils.data_processing": [[11, 3, 0, "-", "city_services_extract"]], "sloyka.src.utils.data_processing.city_services_extract": [[11, 0, 1, "", "City_services"]], "sloyka.src.utils.data_processing.city_services_extract.City_services": [[11, 1, 1, "", "extraction_services"], [11, 1, 1, "", "remove_last_letter"], [11, 1, 1, "", "replace_with_most_similar"], [11, 1, 1, "", "run"]], "sloyka.src.visual": [[20, 3, 0, "-", "graph_visualization"]], "sloyka.src.visual.graph_visualization": [[20, 4, 1, "", "visualize_graph"]]}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "method", "Python method"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "module", "Python module"], "4": ["py", "function", "Python function"]}, "objtypes": {"0": "py:class", "1": "py:method", "2": "py:attribute", "3": "py:module", "4": "py:function"}, "terms": {"": [2, 3], "0": [2, 7, 17], "000": 18, "1": [6, 17, 18, 19], "100": 10, "131": 10, "15": [10, 19], "2": 6, "2024": 2, "3": 6, "5": 10, "50": 10, "6": [2, 7, 17], "7": 7, "70": 7, "75": 17, "90": 18, "A": [6, 8, 9, 10, 12, 17], "As": 17, "By": 3, "For": [7, 17], "If": 6, "In": 18, "It": [6, 13, 14, 15, 17, 18, 19], "Its": 2, "No": 7, "The": [2, 3, 5, 6, 7, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20], "To": [1, 15], "_collect_popul": 14, "_get_build": 14, "_get_features_from_plac": 5, "_get_place_from_id": 5, "_get_road": 14, "_handle_error": 5, "_preprocess": 14, "_process_tag": 5, "about": [3, 16, 19], "access": [10, 18], "access_token": 10, "accord": 6, "account": 11, "accsess_token": 10, "across": 3, "activ": [2, 3], "actual": 6, "ad": 13, "add": 6, "addit": [2, 10, 19], "address": [6, 8, 9, 15], "admin": [6, 15], "after": [2, 6, 15, 16, 17], "against": 6, "aggreg": [16, 17], "aggregate_data": 17, "aim": [2, 14, 17, 18, 19], "algorithm": 11, "all": [3, 6], "almost": 9, "alreadi": [2, 3, 6], "also": [2, 6, 15], "amen": 18, "an": [5, 6, 7, 13, 14, 15, 20], "analysi": 7, "analyz": [4, 13], "ani": [3, 5, 6, 13, 17, 19], "api": [5, 10], "api_verison": 10, "appli": [3, 8, 13], "applic": [14, 17], "ar": [3, 6, 7, 9, 10, 15, 17], "area": [3, 6, 15], "area_nam": 6, "area_name_process": 6, "area_stem": 6, "around": 8, "arrai": 7, "assess": [2, 3], "assign": [6, 15], "assign_street": 6, "attribut": [6, 13, 16, 17, 18], "augment": 2, "authent": 10, "automat": 13, "avail": 13, "avenu": 9, "averag": 13, "avoid": 20, "back": [6, 13], "base": [5, 9, 10, 12, 14, 16, 17, 18], "basic": 16, "becaus": 9, "being": [10, 18], "belong": 19, "below": 8, "bert": [17, 18], "bert_larg": 13, "bert_nam": 17, "bert_tini": 13, "bertop": [14, 19], "best": [6, 15], "between": [9, 14, 17], "bool": 17, "boundari": 5, "box": 0, "build": [2, 14, 17], "build_graph": 17, "cach": 6, "calcul": [7, 13], "calculate_centroid": 7, "call": [10, 16, 18], "can": [2, 3, 13, 16], "care": 18, "carri": 3, "case": [3, 17, 18], "categor": 2, "categori": [5, 13, 18], "categoris": 13, "centroid": [5, 6, 7], "certain": 3, "chang": 11, "charact": 6, "character": 3, "chat": 2, "check": 6, "child": 17, "citi": [2, 4, 5, 6, 7, 9, 11, 14, 18, 19], "citizen": 2, "city_bound": 5, "city_cr": 14, "city_nam": 14, "city_objects_extractor": [7, 15], "city_servic": 11, "city_services_extract": [11, 16], "city_tag": [6, 15], "class": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "classif": [15, 18], "classifi": [2, 3, 8, 16], "classify_text": 18, "clean": 17, "clean_from_digit": 17, "clean_from_dubl": 17, "clean_from_toponym": 17, "clear_nam": 9, "cluster": [14, 19, 20], "cointegr": 19, "collect": [2, 7, 14], "color": 20, "column": [2, 3, 5, 6, 10, 11, 13, 15, 17], "combin": [7, 10], "combine_city_obj": 7, "comment": [2, 10], "comments_to_datafram": 10, "commun": [2, 3], "compar": 7, "comparison": 11, "compat": 13, "confid": 8, "connect": 14, "consist": 3, "construct": [2, 17], "contain": [5, 6, 8, 10, 12, 13, 14, 17, 18], "content": 8, "context": 14, "conveni": 17, "convert": [6, 10], "convert_df_to_edge_df": 17, "convini": 17, "coordin": 7, "correctli": 18, "correspond": [6, 15], "cosin": 17, "couldn": 0, "count": [17, 18], "count_item": 10, "counts_attribut": 17, "cpu": [6, 13, 15, 17], "creat": [6, 15, 16, 17, 19], "create_gdf": 6, "csv": 13, "cuda": 13, "custom": 8, "cutoff": 10, "cutoff_d": 10, "d": 10, "dai": 19, "data": [2, 3, 4, 5, 6, 7, 9, 10, 13, 14, 15, 16, 17, 19], "data_gett": [5, 9, 10], "data_process": 11, "databas": 9, "datafram": [5, 6, 7, 8, 9, 10, 11, 13, 15, 16, 17], "dataset": 3, "date": [2, 6, 10, 15, 19], "deeppavlov": 17, "default": [5, 6, 10, 13, 15, 17, 20], "design": [11, 13, 16, 18, 19], "determin": 17, "devic": [6, 13, 15, 17, 18], "device_typ": 18, "df": [6, 7, 8, 11, 13, 15], "df_area": 6, "df_obj": 7, "dict": [5, 6, 7, 10, 15], "dictionari": [6, 10], "didn": 6, "differ": [6, 7], "digit": [2, 17], "direct": 17, "displai": 20, "distanc": 17, "divid": 3, "do": [7, 9, 15], "document": 2, "domain": 10, "don": 6, "done": 19, "drop": 9, "drop_words_from_nam": 9, "duplic": 17, "dure": [5, 13], "dynam": 19, "e": 9, "each": [3, 5, 6, 10, 14, 15, 17, 19, 20], "edg": 5, "effici": 18, "element": [2, 6], "element_typ": 5, "embed": [17, 19], "embedding_model_nam": 19, "emot": [2, 3], "emotion_classifi": [13, 16], "emotionclassifi": 13, "emotionrecogn": 13, "enabl": 13, "encapsul": 9, "end": 11, "end_dat": 19, "enrich": 2, "entiti": [2, 7, 11], "environ": 2, "error": 5, "evalu": 2, "event": [2, 18], "event_detector": 14, "eventdetect": 14, "exact": 9, "exampl": [7, 18], "exist": 2, "expand_toponym": 7, "extract": [2, 3, 7, 8, 9, 15, 17, 19], "extract_geo_obj": 7, "extract_ner_street": 8, "extract_toponym": 8, "extraction_servic": 11, "extractor": [6, 8, 15], "fail": 8, "fall": 13, "fals": [6, 15, 18], "famili": 18, "featur": 5, "fetch": 10, "file": 20, "filepath_to_popul": 14, "filter": [5, 6, 15, 17], "final": [2, 6, 15, 17], "find": [0, 6, 7, 9, 15], "find_geo_obj_tag": 7, "find_geometri": 7, "find_num_city_obj": 7, "find_toponim_words_from_nam": 9, "first": [6, 8], "flag": 17, "flair": [6, 11, 15], "float": [10, 17], "folium": 20, "follow": [13, 14, 17, 18, 19], "footprint": 2, "forecast": 3, "form": [6, 7, 15], "format": 10, "found": [6, 7, 8, 9], "from": [2, 5, 6, 7, 8, 9, 10, 11, 12, 15, 17, 19, 20], "function": [3, 6, 7, 8, 9, 10, 15, 16, 17, 18, 19, 20], "further": [2, 3, 7], "g": [9, 17, 20], "gdf": [6, 9, 19], "gener": [2, 3, 14, 15], "geo_data_gett": 5, "geo_obj_tag": 7, "geocod": [3, 7, 8, 9, 16, 17], "geodatafram": [2, 5, 6, 9, 14, 15, 16, 17, 19], "geodatagett": 12, "geograph": [6, 15], "geoloc": [3, 17], "geometri": [5, 6, 7, 17], "geometry_column": 17, "geor111i": [6, 15], "geospati": [5, 12], "get": [2, 3, 5, 9, 10, 14], "get_and_process_osm_data": 7, "get_city_bound": 5, "get_com": 10, "get_df_area": 6, "get_drive_graph": 5, "get_features_from_id": 5, "get_group_nam": 10, "get_group_post_id": 10, "get_level": 6, "get_osm_data": 5, "get_owner_id_by_domain": 10, "get_risk": 16, "get_stem": 6, "get_street_nam": 9, "get_subcom": 10, "get_unique_part_typ": 7, "getter": 3, "given": [5, 6, 9, 10, 12, 13, 15, 17, 20], "glebosol": 11, "global": [6, 19], "go": 0, "gpd": [5, 6, 15, 17], "gpu": 13, "graph": [2, 3], "graph_path": 20, "graph_visu": 20, "group": [3, 6, 10, 15, 20], "group_column": [6, 15], "group_nam": [6, 15], "ha": [13, 14, 17, 18, 19], "handl": 5, "have": 20, "health": 18, "histgeodatagett": 6, "hold": 13, "homepag": 0, "hous": [6, 18], "howev": 3, "http": 2, "huggingfac": [13, 18], "huggingfacemodel": 13, "hypergraph": 2, "i": [2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 16, 17, 18, 19], "id": [5, 6, 9, 10, 12, 15, 18], "id_column": 17, "ident": 4, "identifi": [8, 17, 18, 19], "import": 3, "includ": [5, 16], "incom": 19, "index": 4, "indic": 17, "inf": 10, "infer": [13, 17], "infin": 10, "info": [3, 6], "inform": [9, 10, 16, 17], "initi": [6, 16, 18], "initial_df": 6, "initialize_classifi": 18, "input": [6, 8, 9, 10, 13, 15, 17, 18], "instal": 4, "instanti": 13, "int": [5, 6, 7, 9, 10, 14, 15, 17, 18, 20], "interact": 20, "interpret": 2, "intersect": 5, "introduct": 4, "is_top": 18, "its": [10, 20], "june": 2, "keep": 6, "kei": 17, "key_score_filt": 17, "keybert": 17, "keyword": 17, "know": 6, "label": 3, "languag": 17, "last": 3, "later": 9, "launch": [7, 15], "least": 7, "level": [6, 15, 18], "librari": [2, 3, 4, 5, 7, 11, 17], "like": 13, "limit": [3, 10], "linear": 15, "link": [2, 14], "list": [3, 5, 7, 10, 11], "locat": [2, 7, 17], "location_column": 17, "low": 18, "lowercas": 6, "m": 10, "machin": 2, "mai": 19, "main": [4, 17, 18, 19], "major": 3, "mani": 18, "map": 20, "mark": 18, "marker": 20, "markerclust": 20, "match": [6, 9, 15, 17], "match_group_to_area": 6, "maximum": 10, "me": 2, "media": [2, 4, 10], "mention": [2, 3, 8], "merg": [6, 15, 19], "merge_to_initial_df": 6, "messag": [2, 3, 5, 6, 10, 11, 14, 17, 18, 19], "method": [2, 3, 5, 9, 10, 11, 13, 14, 17, 18, 19], "min_event_s": 14, "min_text": 19, "model": [2, 3, 6, 8, 13, 14, 15, 17, 18], "model_nam": [11, 13], "model_path": [6, 15], "modul": [2, 4, 7, 12, 13, 14, 15, 16, 17, 18, 19], "more": [3, 17], "most": [11, 13], "multidigraph": 5, "multipl": 13, "name": [5, 6, 7, 8, 9, 11, 13, 15, 17, 20], "natasha": 7, "natashaextractor": 8, "necessari": 9, "need": 9, "ner": [6, 8, 15], "network": [2, 3, 5, 12, 14], "networkx": 5, "new": [2, 11, 17], "node": [2, 5, 17, 20], "nominatim": 9, "none": [6, 8, 9, 10, 13, 15, 17, 18, 20], "normal": 7, "number": [6, 7, 10, 17, 18], "number_of_categori": 18, "number_of_messag": 10, "nx": 17, "object": [2, 3, 5, 6, 7, 8, 11, 14, 15, 18, 20], "obtain": [2, 3, 17], "occur": 5, "offset": 20, "one": 7, "onli": [3, 6], "onlin": 3, "openstreetmap": [5, 6, 12], "option": [5, 6, 8, 15, 20], "order": [3, 6], "origin": [6, 11], "osm": [5, 6, 7, 9, 12, 15], "osm_combined_df": 7, "osm_id": [5, 6, 7, 9, 15], "osm_typ": 5, "osmid": 5, "osmnx": 5, "other": [6, 13, 15, 16, 18], "other_geo_obj": 7, "otherwis": [3, 6, 8, 13], "out": [3, 6], "output_fil": 20, "overlap": 20, "overpass": 5, "own": 20, "owner": 10, "owner_id": 10, "page": 4, "panda": [9, 10], "param": [10, 17], "paramet": [5, 6, 8, 9, 10, 15, 17, 20], "parent": 17, "parents_stack_column": 17, "pars": 2, "parser": 10, "part": 9, "particular": 2, "pd": [6, 8, 13, 15, 17], "per": 18, "percentag": 7, "perform": 15, "pip": 1, "pipelin": [4, 6, 15, 18], "place": [2, 5, 6, 15, 17], "point": [6, 7], "polygon": [5, 7], "popul": 14, "posit": [8, 10], "possibl": 3, "post": [2, 10, 17, 19], "post_id": 10, "post_id_column": 17, "post_num_limit": 10, "pre": [8, 9, 18], "predict": [2, 18], "preprocess": [6, 14, 15], "preprocess_area_nam": 6, "preprocess_group_nam": 6, "present": 8, "prevail": 13, "print": 5, "probabl": [11, 18], "process": [2, 5, 6, 7, 8, 9, 15, 16, 18, 19], "process_pipelin": 8, "process_top": 19, "processed_geodata": 16, "provid": [2, 5, 6, 15, 16, 17], "proxim": 17, "public": 18, "purpos": 9, "pytorch": 17, "qualiti": 2, "r": 5, "random": 20, "rang": [8, 19], "read_csv": 13, "receiv": [2, 3], "recogn": [6, 13], "recognis": [6, 9], "recognit": [2, 13], "recognize_average_emotion_from_multiple_model": 13, "recognize_emot": 13, "refer": 17, "regard": 2, "region": [2, 3], "regional_act": 16, "regionalact": 16, "relat": [7, 8, 15], "relationship": 17, "remov": [6, 8, 17], "remove_last_lett": 11, "replace_with_most_similar": 11, "repli": 2, "repositori": 18, "repository_id": 18, "repres": [5, 6, 7, 20], "request": 10, "requir": [3, 9], "restoration_of_normal_form": 7, "result": [2, 5, 17, 19, 20], "retriev": [5, 6, 7, 9, 10, 12, 15], "return": [5, 6, 7, 8, 9, 10, 13, 14, 15, 16, 17, 18, 20], "risk": [2, 3, 13, 14, 16, 18], "road": 14, "roadmap": 4, "row": [6, 7], "rubert": [17, 18, 19], "run": [1, 3, 6, 7, 9, 10, 11, 14, 15], "run_com": 10, "run_osm_df": 7, "run_pars": 10, "run_post": 10, "run_text_classifi": 18, "run_text_classifier_top": 18, "russian": [6, 15, 17, 18], "save": 20, "scale": 6, "school": 7, "score": [8, 17], "search": [0, 4, 7, 8], "search_for_object": [6, 15], "section": 3, "see": 15, "segment": [5, 9], "select": [3, 5, 13], "selected_column": 5, "semant": [2, 3, 14], "semantic_graph": 17, "semantic_graph_build": 17, "semantic_score_filt": 17, "semgraph": 17, "sensit": 9, "sentenc": 11, "seri": [6, 8], "servic": [2, 3], "set": [6, 13, 17], "set_global_repr_point": 6, "similar": 7, "simpl": [6, 15], "simpli": 6, "site": 3, "size": 10, "skip": 3, "sloyka": [1, 2, 3, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 17, 18, 20], "sloyka_commun": 2, "so": 18, "social": [2, 3, 4, 10, 12, 16], "some": [3, 19], "sorri": 0, "sourc": [5, 6, 7, 8, 9, 10, 11, 13, 14, 15, 17, 18, 20], "spatial": [2, 5, 7, 14], "special": 6, "specif": [5, 10, 18], "specifi": [5, 6, 8, 9, 10, 17, 18, 19], "split": 7, "src": [5, 6, 7, 8, 9, 10, 11, 13, 14, 15, 17, 18, 20], "stage": 2, "start_dat": 19, "state": [6, 15], "static": [5, 6, 7, 8, 9, 10, 15, 17], "stem": 6, "stemmer_lang": [6, 15], "step": [3, 9, 10], "stop": 10, "stopword": 6, "store": [11, 16, 19], "str": [5, 6, 7, 8, 9, 10, 11, 14, 15, 17, 18, 20], "street": [5, 6, 7, 8, 12, 14, 15], "street_extractor": [8, 15], "street_gett": 9, "street_nam": 8, "street_names_df": 6, "streets_df": 9, "string": [9, 11], "structur": 18, "subcom": 10, "success": 10, "synthesi": 3, "synthet": 18, "t": [0, 2, 6], "tag": [2, 3, 5, 6, 7, 12, 15], "take": [11, 18], "target_text": 14, "text": [2, 3, 6, 7, 8, 11, 13, 14, 15, 16, 17, 19], "text_address_extractor_by_rul": 8, "text_classifi": 18, "text_column": [6, 7, 8, 11, 13, 15, 17], "text_column_nam": [6, 15], "text_type_column": 17, "textclassifi": 18, "textual": 2, "thank": 17, "thei": 3, "them": [2, 6, 7, 11], "theme": 18, "thi": [3, 5, 6, 7, 8, 9, 12, 13, 14, 15, 17, 18], "those": 6, "three": 18, "threshold": [7, 8, 17], "timeout_limit": 10, "tini": 18, "tiny2": [18, 19], "token": [10, 18], "too": 18, "top": 17, "top_n": 17, "topic": [2, 3], "topicmodel": 19, "toponim": 9, "toponym": [7, 8, 17], "toponym_column": 17, "toponym_name_column": 17, "toponym_type_column": 17, "train": [6, 8, 13, 18], "transform": [13, 18], "transport": 18, "true": [13, 17], "try": 0, "tupl": 6, "two": 2, "type": [5, 6, 8, 9, 10, 11, 12, 15, 17, 18, 20], "uniqu": [9, 17], "unknown_\u0436\u043a\u0445": 18, "unnecessari": 8, "up": 18, "updat": 17, "update_graph": 17, "upper": 18, "urban": [2, 3, 7, 14, 15, 18], "us": [0, 2, 4, 5, 7, 8, 9, 10, 11, 12, 13, 16, 17, 18, 19, 20], "user": [10, 16], "util": [5, 9, 10, 11, 18], "variou": 12, "veri": [3, 9], "vernacular": 2, "version": 2, "visual": [2, 3], "visualize_graph": 20, "vk": [10, 12], "vk_data_gett": 10, "vkontakt": 12, "vkparser": 12, "wa": [10, 18], "wai": 6, "we": [0, 6, 9], "well": [2, 11, 12], "were": [3, 18], "weren": 6, "where": [5, 6], "which": [2, 3, 7, 13, 14, 16, 17, 18, 19, 20], "whose": [7, 10], "wide": 19, "within": [2, 8], "word": [6, 9, 15, 17], "word_info_column": 17, "words_scor": 17, "work": [9, 12], "workaround": 6, "x": 9, "y": 10, "you": 3, "zoom": 20}, "titles": ["Page Not Found", "Installation", "Introduction", "Main pipeline", "Welcome to Sloyka\u2019s documentation!", "GeoDataGetter", "Geocoder", "OtherGeoObjects", "StreetExtractor", "Streets", "VKparser", "Services extraction", "Data getter", "Emotion classifier", "Event detector", "Geocoding", "Regional activity", "Semantic graph", "Text Classifier", "Topic Modelling", "Graph visualization"], "titleterms": {"": 4, "Not": 0, "activ": 16, "advanc": [12, 15], "classifi": [13, 18], "data": 12, "detector": 14, "document": 4, "emot": 13, "event": 14, "exampl": 13, "extract": 11, "featur": 2, "found": 0, "gener": 4, "geocod": [6, 12, 15], "geodatagett": 5, "getter": 12, "graph": [17, 20], "indic": 4, "instal": 1, "introduct": 2, "main": [2, 3], "model": 19, "more": [12, 15], "othergeoobject": [7, 15], "page": 0, "pipelin": 3, "region": 16, "semant": 17, "servic": 11, "sloyka": 4, "street": 9, "streetextractor": [8, 15], "tabl": 4, "text": 18, "topic": 19, "visual": 20, "vkparser": 10, "welcom": 4}}) \ No newline at end of file diff --git a/docs/source/about/introduction.rst b/docs/source/about/introduction.rst index a31cce5..95c22a9 100644 --- a/docs/source/about/introduction.rst +++ b/docs/source/about/introduction.rst @@ -14,7 +14,7 @@ or to visualize already existing nodes and links and their further interpretatio SLOYKA also provides methods for modeling social risks regarding the emotional evaluation of mentioned places. Main features --------- +-------------- * Social media parsing: getting posts, comments and replys * City services and places extraction * Emotion and text classifiers categorizing diff --git a/docs/source/about/pipeline.rst b/docs/source/about/pipeline.rst index 0b6ee8a..c19fc24 100644 --- a/docs/source/about/pipeline.rst +++ b/docs/source/about/pipeline.rst @@ -1,5 +1,5 @@ Main pipeline -============ +=================== By selecting a limited urbanized area and a list of online communities in a social network, it is possible to run this dataset across all major library functions. However, in some cases, @@ -17,8 +17,7 @@ text data mentioning urban sites, otherwise the steps are very important - :ref: * Data tagging: Characterization of messages and urban objects, which can be carried out in any order: :ref:`emotion_classifier` :ref:`text_classifier` :ref:`city_services` :ref:`topic_modeler` -* Data modelling: Section consists of further synthesis of the obtained data, risk assessment and forecasting. -Each of the methods in this group requires certain labeling columns: :ref:`sem_graph` :ref:`regional_activity` +* Data modelling: Section consists of further synthesis of the obtained data, risk assessment and forecasting. Each of the methods in this group requires certain labeling columns: :ref:`sem_graph` :ref:`regional_activity` * Data visualization: The last step is applied to the already generated semantic graph - :ref:`graph_visualization` diff --git a/docs/source/conf.py b/docs/source/conf.py index ffb95b8..7fba588 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -7,7 +7,10 @@ # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information import os import sys -sys.path.insert(0, os.path.abspath('./sloyka')) + +folder = os.getcwd().split("\\docs")[0] +sys.path.append(folder) + project = 'sloyka' copyright = '2024, itmo_idu' diff --git a/docs/source/modules/GeoDataGetter.rst b/docs/source/modules/GeoDataGetter.rst index 359b53a..e007103 100644 --- a/docs/source/modules/GeoDataGetter.rst +++ b/docs/source/modules/GeoDataGetter.rst @@ -4,6 +4,6 @@ GeoDataGetter ========================== This class is used to retrieve geospatial data from OpenStreetMap (OSM) based on given OSM ID and tags. -.. autoclass:: sloyka.src.utils.data_getter.GeoDataGetter +.. autoclass:: sloyka.src.utils.data_getter.geo_data_getter.GeoDataGetter :members: :undoc-members: \ No newline at end of file diff --git a/docs/source/modules/Geocoder_special.rst b/docs/source/modules/Geocoder_special.rst index e2390e1..f8254b7 100644 --- a/docs/source/modules/Geocoder_special.rst +++ b/docs/source/modules/Geocoder_special.rst @@ -1,4 +1,5 @@ .. _Geocoder_special: + Geocoder ================== .. autoclass:: sloyka.src.geocoder.geocoder.Geocoder @@ -6,4 +7,4 @@ Geocoder :undoc-members: :no-members: run -Back to all :ref:`geocoder` \ No newline at end of file +Back to all :ref:`geocoder` diff --git a/docs/source/modules/OtherGeoObjects.rst b/docs/source/modules/OtherGeoObjects.rst index 332483c..061ae50 100644 --- a/docs/source/modules/OtherGeoObjects.rst +++ b/docs/source/modules/OtherGeoObjects.rst @@ -4,7 +4,7 @@ OtherGeoObjects ================== .. currentmodule:: sloyka.src.geocoder -.. autoclass:: city_objects_extractor.OtherGeoObjects +.. autoclass:: sloyka.src.geocoder.city_objects_extractor.OtherGeoObjects :members: :undoc-members: diff --git a/docs/source/modules/Streets.rst b/docs/source/modules/Streets.rst index 24453b1..f04cb31 100644 --- a/docs/source/modules/Streets.rst +++ b/docs/source/modules/Streets.rst @@ -3,6 +3,7 @@ Streets ========================== A class for working with street data. -.. autoclass:: sloyka.src.utils.data_getter.Streets + +.. autoclass:: sloyka.src.utils.data_getter.street_getter.Streets :members: - :undoc-members: \ No newline at end of file + :undoc-members: diff --git a/docs/source/modules/VKParser.rst b/docs/source/modules/VKParser.rst index 2e20215..4020c27 100644 --- a/docs/source/modules/VKParser.rst +++ b/docs/source/modules/VKParser.rst @@ -2,6 +2,6 @@ VKparser ========================== -.. autoclass:: sloyka.src.utils.data_getter.VKParser +.. autoclass:: sloyka.src.utils.data_getter.vk_data_getter.VKParser :members: :undoc-members: \ No newline at end of file diff --git a/docs/source/modules/city_services_extract.rst b/docs/source/modules/city_services_extract.rst index 6e1be51..38388fd 100644 --- a/docs/source/modules/city_services_extract.rst +++ b/docs/source/modules/city_services_extract.rst @@ -3,9 +3,10 @@ Services extraction ========================== The City_services class is designed to extract city service names from text using a string comparison algorithm, taking into account - the changing service endings in the text. Using the flair library, the City_services.run() method in messages extracts named entities - from the Sentence object as a list, as well as the most probable service type, and stores them in new columns of the original DataFrame(). +the changing service endings in the text. Using the flair library, the City_services.run() method in messages extracts named entities +from the Sentence object as a list, as well as the most probable service type, and stores them in new columns of the original DataFrame(). + .. automodule:: sloyka.src.utils.data_processing.city_services_extract - :members: - :undoc-members: + :members: + :undoc-members: \ No newline at end of file diff --git a/docs/source/modules/geocoder.rst b/docs/source/modules/geocoder.rst index b5a6f00..4ef23d8 100644 --- a/docs/source/modules/geocoder.rst +++ b/docs/source/modules/geocoder.rst @@ -1,14 +1,14 @@ .. _geocoder: ================== + Geocoding ================== -To perform classification with generalized linear models, see -:ref:`Geocoder_special`. +To perform classification with generalized linear models, see :ref:`Geocoder_special`. Geocoder ------------------- .. autoclass:: sloyka.src.geocoder.geocoder.Geocoder - :members: run + :members: run OtherGeoObjects --------------------- diff --git a/docs/source/modules/visualize_graph.rst b/docs/source/modules/visualize_graph.rst index 4db45d1..f5e1255 100644 --- a/docs/source/modules/visualize_graph.rst +++ b/docs/source/modules/visualize_graph.rst @@ -6,4 +6,4 @@ The function results in an interactive map, which will display graph nodes group Each cluster will have its own color and name. Node markers will have a random offset to avoid overlapping. .. automodule:: sloyka.src.visual.graph_visualization - :members: draw_graph_folium \ No newline at end of file + :members: visualize_graph \ No newline at end of file