diff --git a/.buildinfo b/.buildinfo new file mode 100644 index 00000000..a2e637fd --- /dev/null +++ b/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: ba8b2b53d022aac728b752e2882b487f +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/.doctrees/developer_guide.doctree b/.doctrees/developer_guide.doctree new file mode 100644 index 00000000..1966a8e8 Binary files /dev/null and b/.doctrees/developer_guide.doctree differ diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle new file mode 100644 index 00000000..094eec0f Binary files /dev/null and b/.doctrees/environment.pickle differ diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree new file mode 100644 index 00000000..ae32198a Binary files /dev/null and b/.doctrees/index.doctree differ diff --git a/.doctrees/install/index.doctree b/.doctrees/install/index.doctree new file mode 100644 index 00000000..10030b91 Binary files /dev/null and b/.doctrees/install/index.doctree differ diff --git a/.doctrees/install/install_linux.doctree b/.doctrees/install/install_linux.doctree new file mode 100644 index 00000000..15437c1b Binary files /dev/null and b/.doctrees/install/install_linux.doctree differ diff --git a/.doctrees/install/install_windows.doctree b/.doctrees/install/install_windows.doctree new file mode 100644 index 00000000..fac0da2e Binary files /dev/null and b/.doctrees/install/install_windows.doctree differ diff --git a/.doctrees/methodology.doctree b/.doctrees/methodology.doctree new file mode 100644 index 00000000..e8a13f2b Binary files /dev/null and b/.doctrees/methodology.doctree differ diff --git a/.doctrees/python_api.doctree b/.doctrees/python_api.doctree new file mode 100644 index 00000000..aee27d89 Binary files /dev/null and b/.doctrees/python_api.doctree differ diff --git a/.doctrees/usage/index.doctree b/.doctrees/usage/index.doctree new file mode 100644 index 00000000..c6370f0d Binary files /dev/null and b/.doctrees/usage/index.doctree differ diff --git a/.doctrees/usage/python_api_usage.doctree b/.doctrees/usage/python_api_usage.doctree new file mode 100644 index 00000000..f59511fb Binary files /dev/null and b/.doctrees/usage/python_api_usage.doctree differ diff --git a/.doctrees/usage/python_cli_usage.doctree b/.doctrees/usage/python_cli_usage.doctree new file mode 100644 index 00000000..0c672d8a Binary files /dev/null and b/.doctrees/usage/python_cli_usage.doctree differ diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/_modules/geouned/GEOUNED/core.html b/_modules/geouned/GEOUNED/core.html new file mode 100644 index 00000000..08e8cda0 --- /dev/null +++ b/_modules/geouned/GEOUNED/core.html @@ -0,0 +1,1107 @@ + + + + + + geouned.GEOUNED.core — GEOUNED 1.0.1 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for geouned.GEOUNED.core

+import configparser
+import json
+import logging
+import typing
+from datetime import datetime
+from pathlib import Path
+from typing import get_type_hints
+from importlib.metadata import version
+
+import FreeCAD
+import Part
+from tqdm import tqdm
+
+from .code_version import *
+from .conversion import cell_definition as Conv
+from .cuboid.translate import translate
+from .decompose import decom_one as Decom
+from .loadfile import load_step as Load
+from .utils import functions as UF
+from .utils.boolean_solids import build_c_table_from_solids
+from .utils.data_classes import NumericFormat, Options, Settings, Tolerances
+from .void import void as void
+from .write.functions import write_mcnp_cell_def
+from .write.write_files import write_geometry
+
+logger = logging.getLogger("general_logger")
+logger.info(f"GEOUNED version {version('geouned')}")
+logger.info(f"FreeCAD version {'.'.join(FreeCAD.Version()[:3])}")
+
+
+
+[docs] +class CadToCsg: + """Base class for the conversion of CAD to CSG models + + Args: + stepFile (str, optional): Name of the CAD file (in STEP format) to + be converted. Defaults to "". + options (geouned.Options, optional): An instance of a geouned.Options + class with the attributes set for the desired conversion. Defaults + to a geouned.Options with default attributes values. + tolerances (geouned.Tolerances, optional): An instance of a + geouned.Tolerances class with the attributes set for the desired + conversion. Defaults to a geouned.Tolerances with default + attributes values. + numeric_format (geouned.NumericFormat, optional): An instance of a + geouned.NumericFormat class with the attributes set for the desired + conversion. Defaults to a geouned.NumericFormat with default + attributes values. + settings (geouned.Settings, optional): An instance of a + geouned.Settings class with the attributes set for the desired + conversion. Defaults to a geouned.Settings with default + attributes values. + """ + + def __init__( + self, + stepFile: str = "", + options: Options = Options(), + tolerances: Tolerances = Tolerances(), + numeric_format: NumericFormat = NumericFormat(), + settings: Settings = Settings(), + ): + + self.stepFile = stepFile + self.options = options + self.tolerances = tolerances + self.numeric_format = numeric_format + self.settings = settings + + # define later when running the code + self.geometry_bounding_box = None + self.meta_list = [] + + @property + def stepFile(self): + return self._stepFile + + @stepFile.setter + def stepFile(self, value: str): + if not isinstance(value, str): + raise TypeError(f"geouned.CadToCsg.stepFile should be a str, not a {type(value)}") + self._stepFile = value + + @property + def options(self): + return self._options + + @options.setter + def options(self, value: Options): + if not isinstance(value, Options): + raise TypeError(f"geouned.CadToCsg.options should be an instance of geouned.Options, not a {type(value)}") + self._options = value + + @property + def tolerances(self): + return self._tolerances + + @tolerances.setter + def tolerances(self, value: tolerances): + if not isinstance(value, Tolerances): + raise TypeError(f"geouned.CadToCsg.tolerances should be an instance of geouned.Tolerances, not a {type(value)}") + self._tolerances = value + + @property + def numeric_format(self): + return self._numeric_format + + @numeric_format.setter + def numeric_format(self, value: numeric_format): + if not isinstance(value, NumericFormat): + raise TypeError( + f"geouned.CadToCsg.numeric_format should be an instance of geouned.NumericFormat, not a {type(value)}" + ) + self._numeric_format = value + + @property + def settings(self): + return self._settings + + @settings.setter + def settings(self, value: settings): + if not isinstance(value, Settings): + raise TypeError(f"geouned.CadToCsg.settings should be an instance of geouned.Settings, not a {type(value)}") + self._settings = value + +
+[docs] + def export_csg( + self, + title: str = "Converted with GEOUNED", + geometryName: str = "csg", + outFormat: typing.Tuple[str] = ( + "openmc_xml", + "openmc_py", + "serpent", + "phits", + "mcnp", + ), + volSDEF: bool = False, + volCARD: bool = True, + UCARD: typing.Union[int, type(None)] = 101, + dummyMat: bool = False, + cellCommentFile: bool = False, + cellSummaryFile: bool = True, + ): + """Writes out a CSG file in the requested Monte Carlo code format. + + Args: + title (str, optional): Title of the model written at the top of the + output file. Defaults to "Geouned conversion". + geometryName (str, optional): the file stem of the output file(s). + Defaults to "converted_with_geouned". + outFormat (typing.Tuple[str], optional): Format for the output + geometry. Available format are: "mcnp", "openmc_xml", + "openmc_py", "phits" and "serpent". Several output format can + be written in the same method call. Defaults to output all codes. + volSDEF (bool, optional): Write SDEF definition and tally of solid + cell for stochastic volume checking. Defaults to False. + volCARD (bool, optional): Write the CAD calculated volume in the + cell definition using the VOL card. Defaults to True. + UCARD (int, optional): Write universe card in the cell definition + with the specified universe number (if value = 0 Universe card + is not written). Defaults to None. + dummyMat (bool, optional): Write dummy material definition card in + the MCNP output file for all material labels present in the + model. Dummy material definition is "MX 1001 1". Defaults to False. + cellCommentFile (bool, optional): Write an additional file with + comment associated to each CAD cell in the MCNP output file. + Defaults to False. + cellSummaryFile (bool, optional): Write an additional file with + information on the CAD cell translated. Defaults to True. + """ + + if not isinstance(UCARD, int) and not isinstance(UCARD, type(None)): + raise TypeError(f"UCARD should be of type int or None not {type(UCARD)}") + + for arg, arg_str in ( + (volSDEF, "volSDEF"), + (volCARD, "volCARD"), + (dummyMat, "dummyMat"), + (cellCommentFile, "cellCommentFile"), + (cellSummaryFile, "cellSummaryFile"), + ): + if not isinstance(arg, bool): + raise TypeError(f"{arg} should be of type bool not {type(arg_str)}") + + for arg, arg_str in ((title, "title"), (geometryName, "geometryName")): + if not isinstance(arg, str): + raise TypeError(f"{arg} should be of type str not {type(arg_str)}") + + # if the geometry_bounding_box has not previuosly been calculated, then make a default one + if self.geometry_bounding_box is None: + self._get_geometry_bounding_box() + + write_geometry( + UniverseBox=self.geometry_bounding_box, + MetaList=self.meta_list, + Surfaces=self.Surfaces, + settings=self.settings, + options=self.options, + tolerances=self.tolerances, + numeric_format=self.numeric_format, + geometryName=geometryName, + outFormat=outFormat, + cellCommentFile=cellCommentFile, + cellSummaryFile=cellSummaryFile, + title=title, + volSDEF=volSDEF, + volCARD=volCARD, + UCARD=UCARD, + dummyMat=dummyMat, + stepFile=self.stepFile, + ) + + logger.info("End of Monte Carlo code translation phase")
+ + +
+[docs] + @classmethod + def from_json(cls, filename: str): + """Creates a CadToCsg instance and returns the instance. Populating the + Options, Tolerance, Settings and NumericFormat attributes from matching + key names in the JSON. If export_to_csg key is present then this method + also runs .start() and .export_to_csg() on the instance. + + Args: + filename str: The filename of the config file. Defaults to "config.json". + + Raises: + FileNotFoundError: If the config file is not found + ValueError: If the config JSON file is found to contain an invalid key + + Returns: + geouned.CadToCsg: returns a geouned CadToCsg class instance. + """ + + if not Path(filename).exists(): + raise FileNotFoundError(f"config file {filename} not found") + + with open(filename) as f: + config = json.load(f) + + cad_to_csg = cls(stepFile=config["stepFile"]) + for key in config.keys(): + + if key in ["stepFile", "export_csg"]: + pass # these two keys are used before or after this loop + + elif key == "Tolerances": + cad_to_csg.tolerances = Tolerances(**config["Tolerances"]) + + elif key == "Options": + cad_to_csg.options = Options(**config["Options"]) + + elif key == "NumericFormat": + cad_to_csg.numeric_format = NumericFormat(**config["NumericFormat"]) + + elif key == "Settings": + cad_to_csg.settings = Settings(**config["Settings"]) + + else: + raise ValueError( + f"Invalid key '{key}' found in config file {filename}. Acceptable key names are 'stepFile', 'export_csg', 'Settings', 'Parameters', 'Tolerances' and 'NumericFormat'" + ) + + cad_to_csg.start() + if "export_csg" in config.keys(): + cad_to_csg.export_csg(**config["export_csg"]) + else: + cad_to_csg.export_csg() + return cad_to_csg
+ + + # TODO add tests as set_configuration is not currently tested + def set_configuration(self, configFile=None): + + if configFile is None: + return + + config = configparser.ConfigParser() + config.optionxform = str + config.read(configFile) + for section in config.sections(): + if section == "Files": + for key in config["Files"].keys(): + if key in ("geometryName", "matFile", "title"): + self.set(key, config.get("Files", key)) + + elif key == "stepFile": + value = config.get("Files", key).strip() + lst = value.split() + if value[0] in ("(", "[") and value[-1] in ("]", ")"): + data = value[1:-1].split(",") + data = [x.strip() for x in data] + self.set(key, data) + elif len(lst) > 1: + self.set(key, lst) + else: + self.set(key, value) + + elif key == "outFormat": + raw = config.get("Files", key).strip() + values = tuple(x.strip() for x in raw.split(",")) + outFormat = [] + for v in values: + if v.lower() == "mcnp": + outFormat.append("mcnp") + elif v.lower() == "openmc_xml": + outFormat.append("openmc_xml") + elif v.lower() == "openmc_py": + outFormat.append("openmc_py") + elif v.lower() == "serpent": + outFormat.append("serpent") + elif v.lower() == "phits": + outFormat.append("phits") + self.set(key, tuple(outFormat)) + + elif section == "Parameters": + for key in config["Parameters"].keys(): + if key in ( + "voidGen", + "debug", + "compSolids", + "volSDEF", + "volCARD", + "dummyMat", + "cellSummaryFile", + "cellCommentFile", + "sort_enclosure", + ): + self.set(key, config.getboolean("Parameters", key)) + elif key in ( + "minVoidSize", + "maxSurf", + "maxBracket", + "startCell", + "startSurf", + ): + self.set(key, config.getint("Parameters", key)) + elif key in ("exportSolids", "UCARD", "simplify"): + self.set(key, config.get("Parameters", key)) + elif key == "voidMat": + value = config.get("Parameters", key).strip() + data = value[1:-1].split(",") + self.set(key, (int(data[0]), float(data[1]), data[2])) + else: + value = config.get("Parameters", key).strip() + data = value[1:-1].split(",") + self.set(key, tuple(map(int, data))) + + elif section == "Options": + attributes_and_types = get_type_hints(Options()) + for key in config["Options"].keys(): + if key in attributes_and_types.keys(): + if attributes_and_types[key] is bool: + value = config.getboolean("Options", key) + elif attributes_and_types[key] is float or attributes_and_types[key] is int: + value = config.getfloat("Options", key) + setattr(self.options, key, value) + + elif section == "Tolerances": + attributes_and_types = get_type_hints(Tolerances()) + for key in config["Tolerances"].keys(): + if key in attributes_and_types.keys(): + if attributes_and_types[key] is bool: + value = config.getboolean("Tolerances", key) + elif attributes_and_types[key] is float: + value = config.getfloat("Tolerances", key) + setattr(self.tolerances, key, value) + + elif section == "MCNP_Numeric_Format": + attributes_and_types = get_type_hints(NumericFormat()) + PdEntry = False + for key in config["MCNP_Numeric_Format"].keys(): + if key in attributes_and_types.keys(): + value = config.get("MCNP_Numeric_Format", key) + setattr(self.numeric_format, key, value) + if key == "P_d": + PdEntry = True + + else: + logger.info(f"bad section name : {section}") + + if self.__dict__["geometryName"] == "": + self.__dict__["geometryName"] = self.__dict__["stepFile"][:-4] + + # TODO see if we can find another way to do this + if self.options.prnt3PPlane and not PdEntry: + self.NumericFormat.P_d = "22.15e" + + logger.info(self.__dict__) + + # TODO add tests as set is not currently tested + def set(self, kwrd, value): + + if kwrd == "stepFile": + if isinstance(value, (list, tuple)): + for v in value: + if not isinstance(v, str): + logger.info(f"elemt in {kwrd} list should be string") + return + elif not isinstance(value, str): + logger.info(f"{kwrd} should be string or tuple of strings") + return + + elif kwrd == "UCARD": + if value == "None": + value = None + elif value.isdigit(): + value = int(value) + else: + logger.info(f"{kwrd} value should be None or integer") + return + elif kwrd == "outFormat": + if len(value) == 0: + return + elif kwrd in ("geometryName", "matFile", "exportSolids"): + if not isinstance(value, str): + logger.info(f"{kwrd} value should be str instance") + return + elif kwrd in ("cellRange", "voidMat", "voidExclude"): + if not isinstance(value, (list, tuple)): + logger.info(f"{kwrd} value should be list or tuple") + return + elif kwrd in ("minVoidSize", "maxSurf", "maxBracket", "startCell", "startSurf"): + if not isinstance(value, int): + logger.info(f"{kwrd} value should be integer") + return + elif kwrd in ( + "voidGen", + "debug", + "compSolids", + "simplifyCTable", + "volSDEF", + "volCARD", + "dummyMat", + "cellSummaryFile", + "cellCommentFile", + "sort_enclosure", + ): + if not isinstance(value, bool): + logger.info(f"{kwrd} value should be boolean") + return + + self.__dict__[kwrd] = value + if kwrd == "stepFile" and self.__dict__["geometryName"] == "": + if isinstance(value, (tuple, list)): + self.__dict__["geometryName"] == "joined_step_files" + else: + self.__dict__["geometryName"] == value[:-4] + + def _load_step_file( + self, + filename: str, + # TODO consider having discrete indexes (1,5,7) instead of range (1,7) as this offers more flexibility to the user + cell_range: typing.Union[None, typing.Tuple[int, int]] = None, + ): + """ + Load STEP file(s) and extract solid volumes and enclosure volumes. + + Args: + filename (str): The path to the STEP file or a list of paths to multiple STEP files. + cell_range (tuple[int, int], optional): A tuple representing the range of solids to select from the original STEP solids. Defaults to None. + + Returns: + tuple: A tuple containing the solid volumes list and enclosure volumes list extracted from the STEP files. + """ + + logger.info("Start of step file loading phase") + + if isinstance(filename, (list, tuple)): + step_files = filename + else: + step_files = [filename] + + for step_file in step_files: + if not Path(step_file).is_file(): + raise FileNotFoundError(f"Step file {step_file} not found.") + + MetaChunk = [] + EnclosureChunk = [] + for step_file in tqdm(step_files, desc="Loading CAD files"): + logger.info(f"read step file : {step_file}") + Meta, Enclosure = Load.load_cad(step_file, self.settings, self.options) + MetaChunk.append(Meta) + EnclosureChunk.append(Enclosure) + self.meta_list = join_meta_lists(MetaChunk) + self.enclosure_list = join_meta_lists(EnclosureChunk) + + # Select a specific solid range from original STEP solids + if cell_range: + self.meta_list = self.meta_list[cell_range[0] : cell_range[1]] + + logger.info("End of step file loading phase") + + return self.meta_list, self.enclosure_list + + def _export_solids(self, filename: str): + """Export all the solid volumes from the loaded geometry to a STEP file. + + Args: + filename (str): filepath of the output STEP file. + """ + # export in STEP format solids read from input file + if self.meta_list == []: + raise ValueError( + "No solids in CadToCsg.meta_list to export. Try loading the STEP file first with CadToCsg._load_step_file" + ) + solids = [] + for m in self.meta_list: + if m.IsEnclosure: + continue + solids.extend(m.Solids) + Part.makeCompound(solids).exportStep(filename) + + def _get_geometry_bounding_box(self, padding: float = 10.0): + """ + Get the bounding box of the geometry. + + Args: + padding (float): The padding value to add to the bounding box dimensions. + + Returns: + FreeCAD.BoundBox: The universe bounding box. + """ + # set up Universe + meta_list = self.meta_list + if self.enclosure_list: + meta_list += self.enclosure_list + + Box = meta_list[0].BoundBox + xmin = Box.XMin + xmax = Box.XMax + ymin = Box.YMin + ymax = Box.YMax + zmin = Box.ZMin + zmax = Box.ZMax + for m in meta_list[1:]: + # MIO. This was removed since in HELIAS the enclosure cell is the biggest one + # if m.IsEnclosure: continue + xmin = min(m.BoundBox.XMin, xmin) + xmax = max(m.BoundBox.XMax, xmax) + ymin = min(m.BoundBox.YMin, ymin) + ymax = max(m.BoundBox.YMax, ymax) + zmin = min(m.BoundBox.ZMin, zmin) + zmax = max(m.BoundBox.ZMax, zmax) + + self.geometry_bounding_box = FreeCAD.BoundBox( + FreeCAD.Vector(xmin - padding, ymin - padding, zmin - padding), + FreeCAD.Vector(xmax + padding, ymax + padding, zmax + padding), + ) + return self.geometry_bounding_box + + def start(self): + + startTime = datetime.now() + + # sets the self.meta_list and self.enclosure_list + self._load_step_file(filename=self.stepFile, cell_range=self.settings.cellRange) + + if self.settings.exportSolids: + self._export_solids(filename=self.settings.exportSolids) + + logger.info("End of loading phase") + tempstr1 = str(datetime.now() - startTime) + logger.info(tempstr1) + tempTime = datetime.now() + + # sets self.geometry_bounding_box with default padding + self._get_geometry_bounding_box() + + self.Surfaces = UF.SurfacesDict(offset=self.settings.startSurf - 1) + + warnSolids = [] + warnEnclosures = [] + coneInfo = dict() + tempTime0 = datetime.now() + if not self.options.Facets: + + # decompose all solids in elementary solids (convex ones) + warningSolidList = self._decompose_solids(meta=True) + + # decompose Enclosure solids + if self.settings.voidGen and self.enclosure_list: + warningEnclosureList = self._decompose_solids(meta=False) + + logger.info("End of decomposition phase") + + # start Building CGS cells phase + + for j, m in enumerate(tqdm(self.meta_list, desc="Translating solid cells")): + if m.IsEnclosure: + continue + logger.info(f"Building cell: {j+1}") + cones = Conv.cellDef( + m, + self.Surfaces, + self.geometry_bounding_box, + self.options, + self.tolerances, + self.numeric_format, + ) + if cones: + coneInfo[m.__id__] = cones + if j in warningSolidList: + warnSolids.append(m) + if not m.Solids: + logger.info(f"none {j}, {m.__id__}") + logger.info(m.Definition) + + if self.options.forceNoOverlap: + Conv.no_overlapping_cell(self.meta_list, self.Surfaces, self.options) + + else: + translate( + self.meta_list, + self.Surfaces, + self.geometry_bounding_box, + self.settings, + self.options, + self.tolerances, + ) + # decompose Enclosure solids + if self.settings.voidGen and self.enclosure_list: + warningEnclosureList = self._decompose_solids(meta=False) + + tempstr2 = str(datetime.now() - tempTime) + logger.info(tempstr2) + + # building enclosure solids + + if self.settings.voidGen and self.enclosure_list: + for j, m in enumerate(self.enclosure_list): + logger.info(f"Building Enclosure Cell: {j + 1}") + cones = Conv.cellDef( + m, + self.Surfaces, + self.geometry_bounding_box, + self.options, + self.tolerances, + self.numeric_format, + ) + if cones: + coneInfo[m.__id__] = cones + if j in warningEnclosureList: + warnEnclosures.append(m) + + tempTime1 = datetime.now() + + # void generation phase + meta_void = [] + if self.settings.voidGen: + logger.info("Build Void") + logger.info(self.settings.voidExclude) + if not self.settings.voidExclude: + meta_reduced = self.meta_list + else: + meta_reduced = exclude_cells(self.meta_list, self.settings.voidExclude) + + if self.meta_list: + init = self.meta_list[-1].__id__ - len(self.enclosure_list) + else: + init = 0 + meta_void = void.void_generation( + meta_reduced, + self.enclosure_list, + self.Surfaces, + self.geometry_bounding_box, + self.settings, + init, + self.options, + self.tolerances, + self.numeric_format, + ) + + # if self.settings.simplify == 'full' and not self.options.forceNoOverlap: + if self.settings.simplify == "full": + Surfs = {} + for lst in self.Surfaces.values(): + for s in lst: + Surfs[s.Index] = s + + for c in tqdm(self.meta_list, desc="Simplifying"): + if c.Definition.level == 0 or c.IsEnclosure: + continue + logger.info(f"simplify cell {c.__id__}") + Box = UF.get_box(c) + CT = build_c_table_from_solids(Box, (c.Surfaces, Surfs), option="full") + c.Definition.simplify(CT) + c.Definition.clean() + if type(c.Definition.elements) is bool: + logger.info(f"unexpected constant cell {c.__id__} :{c.Definition.elements}") + + tempTime2 = datetime.now() + logger.info(f"build Time: {tempTime2} - {tempTime1}") + + logger.info(datetime.now() - startTime) + + cellOffSet = self.settings.startCell - 1 + if self.enclosure_list and self.settings.sort_enclosure: + # sort group solid cell / void cell sequence in each for each enclosure + # if a solid belong to several enclosure, its definition will be written + # for the highest enclosure level or if same enclosure level in the first + # enclosure found + self.meta_list = sort_enclosure(self.meta_list, meta_void, cellOffSet) + else: + # remove Null Cell and apply cell numbering offset + deleted = [] + idLabel = {0: 0} + icount = cellOffSet + for i, m in enumerate(self.meta_list): + if m.NullCell or m.IsEnclosure: + deleted.append(i) + continue + + icount += 1 + m.label = icount + idLabel[m.__id__] = m.label + + for i in reversed(deleted): + del self.meta_list[i] + + lineComment = """\ +########################################################## + VOID CELLS +##########################################################""" + mc = UF.GeounedSolid(None) + mc.Comments = lineComment + self.meta_list.append(mc) + + deleted = [] + for i, m in enumerate(meta_void): + if m.NullCell: + deleted.append(i) + continue + icount += 1 + m.label = icount + update_comment(m, idLabel) + for i in reversed(deleted): + del meta_void[i] + + self.meta_list.extend(meta_void) + + print_warning_solids(warnSolids, warnEnclosures) + + # add plane definition to cone + process_cones( + self.meta_list, + coneInfo, + self.Surfaces, + self.geometry_bounding_box, + self.options, + self.tolerances, + self.numeric_format, + ) + + logger.info("Process finished") + logger.info(datetime.now() - startTime) + + logger.info(f"Translation time of solid cells {tempTime1} - {tempTime0}") + logger.info(f"Translation time of void cells {tempTime2} - {tempTime1}") + + def _decompose_solids(self, meta: bool): + + if meta: + meta_list = self.meta_list + description = "Decomposing solids" + else: + meta_list = self.enclosure_list + description = "Decomposing enclosure solids" + + totsolid = len(meta_list) + warningSolids = [] + for i, m in enumerate(tqdm(meta_list, desc=description)): + if meta and m.IsEnclosure: + continue + logger.info(f"Decomposing solid: {i + 1}/{totsolid}") + if self.settings.debug: + debug_output_folder = Path("debug") + logger.info(m.Comments) + debug_output_folder.mkdir(parents=True, exist_ok=True) + if m.IsEnclosure: + m.Solids[0].exportStep(str(debug_output_folder / f"origEnclosure_{i}.stp")) + else: + m.Solids[0].exportStep(str(debug_output_folder / f"origSolid_{i}.stp")) + + comsolid, err = Decom.SplitSolid( + Part.makeCompound(m.Solids), + self.geometry_bounding_box, + self.options, + self.tolerances, + self.numeric_format, + ) + + if err != 0: + sus_output_folder = Path("suspicious_solids") + sus_output_folder.mkdir(parents=True, exist_ok=True) + if m.IsEnclosure: + Part.CompSolid(m.Solids).exportStep(str(sus_output_folder / f"Enclosure_original_{i}.stp")) + comsolid.exportStep(str(sus_output_folder / f"Enclosure_split_{i}.stp")) + else: + Part.CompSolid(m.Solids).exportStep(str(sus_output_folder / f"Solid_original_{i}.stp")) + comsolid.exportStep(str(sus_output_folder / f"Solid_split_{i}.stp")) + + warningSolids.append(i) + + if self.settings.debug: + if m.IsEnclosure: + comsolid.exportStep(str(debug_output_folder / f"compEnclosure_{i}.stp")) + else: + comsolid.exportStep(str(debug_output_folder / f"compSolid_{i}.stp")) + self.Surfaces.extend( + Decom.extract_surfaces( + comsolid, + "All", + self.geometry_bounding_box, + self.options, + self.tolerances, + self.numeric_format, + MakeObj=True, + ), + self.options, + self.tolerances, + self.numeric_format, + ) + m.set_cad_solid() + m.update_solids(comsolid.Solids) + + return warningSolids
+ + + +def update_comment(meta, idLabel): + if meta.__commentInfo__ is None: + return + if meta.__commentInfo__[1] is None: + return + newLabel = (idLabel[i] for i in meta.__commentInfo__[1]) + meta.set_comments(void.void_comment_line((meta.__commentInfo__[0], newLabel))) + + +def process_cones(MetaList, coneInfo, Surfaces, UniverseBox, options, tolerances, numeric_format): + cellId = tuple(coneInfo.keys()) + for m in MetaList: + if m.__id__ not in cellId and not m.Void: + continue + + if m.Void and m.__commentInfo__ is not None: + if m.__commentInfo__[1] is None: + continue + cones = set() + for Id in m.__commentInfo__[1]: + if Id in cellId: + cones.update(-x for x in coneInfo[Id]) + Conv.add_cone_plane( + m.Definition, + cones, + Surfaces, + UniverseBox, + options, + tolerances, + numeric_format, + ) + elif not m.Void: + Conv.add_cone_plane( + m.Definition, + coneInfo[m.__id__], + Surfaces, + UniverseBox, + options, + tolerances, + numeric_format, + ) + + +def print_warning_solids(warnSolids, warnEnclosures): + + solids_logger = logging.getLogger("solids_logger") + + if warnSolids or warnEnclosures: + pass + else: + return + + if warnSolids: + lines = "Solids :\n" + for sol in warnSolids: + lines += "\n" + lines += f"{sol.label}\n" + lines += f"{sol.Comments}\n" + lines += f"{write_mcnp_cell_def(sol.Definition)}\n" + solids_logger.info(lines) + + if warnEnclosures: + lines = "Enclosures :\n" + for sol in warnEnclosures: + lines += "\n" + lines += f"{sol.label}\n" + lines += f"{sol.Comments}\n" + lines += f"{write_mcnp_cell_def(sol.Definition)}\n" + + solids_logger.info(lines) + + +def join_meta_lists(MList) -> typing.List[UF.GeounedSolid]: + + newMetaList = MList[0] + if MList[0]: + for M in MList[1:]: + lastID = newMetaList[-1].__id__ + 1 + for i, meta in enumerate(M): + meta.__id__ = lastID + i + newMetaList.append(meta) + + return newMetaList + + +def exclude_cells(MetaList, labelList): + voidMeta = [] + for m in MetaList: + if m.IsEnclosure: + continue + found = False + for label in labelList: + if label in m.Comments: + found = True + break + if not found: + voidMeta.append(m) + + return voidMeta + + +def sort_enclosure(MetaList, meta_void, offSet=0): + + newList = {} + for m in meta_void: + if m.EnclosureID in newList.keys(): + newList[m.EnclosureID].append(m) + else: + newList[m.EnclosureID] = [m] + + icount = offSet + idLabel = {0: 0} + newMeta = [] + for m in MetaList: + if m.NullCell: + continue + if m.IsEnclosure: + lineComment = f"""########################################################## + ENCLOSURE {m.EnclosureID} +##########################################################""" + mc = UF.GeounedSolid(None) + mc.Comments = lineComment + newMeta.append(mc) + for e in newList[m.EnclosureID]: + if e.NullCell: + continue + icount += 1 + e.label = icount + idLabel[e.__id__] = e.label + newMeta.append(e) + lineComment = f"""########################################################## + END ENCLOSURE {m.EnclosureID} +##########################################################""" + mc = UF.GeounedSolid(None) + mc.Comments = lineComment + newMeta.append(mc) + + else: + icount += 1 + m.label = icount + idLabel[m.__id__] = m.label + newMeta.append(m) + + lineComment = """\ +########################################################## + VOID CELLS +##########################################################""" + mc = UF.GeounedSolid(None) + mc.Comments = lineComment + newMeta.append(mc) + + for v in newList[0]: + if v.NullCell: + continue + icount += 1 + v.label = icount + idLabel[v.__id__] = v.label + newMeta.append(v) + + for m in newMeta: + if not m.Void: + continue + if m.IsEnclosure: + continue + update_comment(m, idLabel) + + return newMeta +
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/_modules/geouned/GEOUNED/utils/data_classes.html b/_modules/geouned/GEOUNED/utils/data_classes.html new file mode 100644 index 00000000..a489f6f0 --- /dev/null +++ b/_modules/geouned/GEOUNED/utils/data_classes.html @@ -0,0 +1,956 @@ + + + + + + geouned.GEOUNED.utils.data_classes — GEOUNED 1.0.1 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Source code for geouned.GEOUNED.utils.data_classes

+import typing
+from numbers import Real
+
+
+
+[docs] +class Options: + """A class for containing conversion options + + Args: + forceCylinder (bool, optional): Use cylinder (instead of cones) as + ancillary surface where unclosed torus surfaces are involved in + the solid definition. Defaults to False. + newSplitPlane (bool, optional): New method to consider plane as + cutting surface during the decomposition process. Former method + split first planes perpendicular to X,Y,Z axis and then the + other planes involved in the solid definition. New method group + all parallel planes independently whether their normal are + along X,Y,Z axes, and start the decomposition process cutting + first with the group having the highest number of parallel + planes. Defaults to True. + delLastNumber (bool, optional): Deleting the last word in the + comment if it is a number. Defaults to False. + enlargeBox (Real, optional): Enlarge box boundary when evaluating + the constraint table during the simplification of the void cell + definition. (unit is millimeter). Defaults to 2. + nPlaneReverse (int, optional): Threshold value to determine whether + cut with parallel planes should be carried out first. Defaults + to 0. + splitTolerance (Real, optional): Fuzzy tolerance value used in the + FreeCAD function “BOPTools.SplitAPI.slice”. This function is + used during the solid decomposition process. Defaults to 0. + scaleUp (bool, optional): Scale up Fuzzy tolerance once get below + 1e-12. Defaults to True. + quadricPY (bool, optional): In openMC python script format, the + cones or cylinders no aligned with the X,Y, or Z axis can be + defined using the openmc.Cone or open.Cylinder methods but can + also be defined with their quadric parameter. If “quadricPY” is + 11 True then all cones and cylinders will be defined in the + openMC python script format under their quadric form. Defaults + to False. + Facets (bool, optional): use alternative conversion module when + geometry is defined by cells compound by only triangular plane + faces. Defaults to False. + prnt3PPlane (bool, optional): print 3 point plane definition in + output as 3 points coordinates. Defaults to False. + forceNoOverlap (bool, optional): force no overlaping cell + definition. Adjacent cell definition are rested from current + cell definition. Defaults to False. + """ + + def __init__( + self, + forceCylinder: bool = False, + newSplitPlane: bool = True, + delLastNumber: bool = False, + enlargeBox: Real = 2.0, + nPlaneReverse: int = 0, + splitTolerance: Real = 0.0, + scaleUp: bool = True, + quadricPY: bool = False, + Facets: bool = False, + prnt3PPlane: bool = False, + forceNoOverlap: bool = False, + ): + + self.forceCylinder = forceCylinder + self.newSplitPlane = newSplitPlane + self.delLastNumber = delLastNumber + self.enlargeBox = enlargeBox + self.nPlaneReverse = nPlaneReverse + self.splitTolerance = splitTolerance + self.scaleUp = scaleUp + self.quadricPY = quadricPY + self.Facets = Facets + self.prnt3PPlane = prnt3PPlane + self.forceNoOverlap = forceNoOverlap + + @property + def forceCylinder(self): + return self._forceCylinder + + @forceCylinder.setter + def forceCylinder(self, value: bool): + if not isinstance(value, bool): + raise TypeError(f"geouned.Options.forceCylinder should be a bool, not a {type(value)}") + self._forceCylinder = value + + @property + def newSplitPlane(self): + return self._newSplitPlane + + @newSplitPlane.setter + def newSplitPlane(self, value: bool): + if not isinstance(value, bool): + raise TypeError(f"geouned.Options.newSplitPlane should be a bool, not a {type(value)}") + self._newSplitPlane = value + + @property + def delLastNumber(self): + return self._delLastNumber + + @delLastNumber.setter + def delLastNumber(self, value: bool): + if not isinstance(value, bool): + raise TypeError(f"geouned.Options.delLastNumber should be a bool, not a {type(value)}") + self._delLastNumber = value + + @property + def enlargeBox(self): + return self._enlargeBox + + @enlargeBox.setter + def enlargeBox(self, value: Real): + if not isinstance(value, Real): + raise TypeError(f"geouned.Options.enlargeBox should be a Real, not a {type(value)}") + if value < 0: + raise ValueError(f"geouned.Options.enlargeBox should be above 0, not {value}") + self._enlargeBox = value + + @property + def nPlaneReverse(self): + return self._nPlaneReverse + + @nPlaneReverse.setter + def nPlaneReverse(self, value: int): + if not isinstance(value, int): + raise TypeError(f"geouned.Options.nPlaneReverse should be a int, not a {type(value)}") + self._nPlaneReverse = value + + @property + def splitTolerance(self): + return self._splitTolerance + + @splitTolerance.setter + def splitTolerance(self, value: Real): + if not isinstance(value, Real): + raise TypeError(f"geouned.Options.splitTolerance should be a Real, not a {type(value)}") + if value < 0: + raise ValueError(f"geouned.Options.splitTolerance should be above 0, not {value}") + self._splitTolerance = value + + @property + def scaleUp(self): + return self._scaleUp + + @scaleUp.setter + def scaleUp(self, value: bool): + if not isinstance(value, bool): + raise TypeError(f"geouned.Options.scaleUp should be a bool, not a {type(value)}") + self._scaleUp = value + + @property + def quadricPY(self): + return self._quadricPY + + @quadricPY.setter + def quadricPY(self, value: bool): + if not isinstance(value, bool): + raise TypeError(f"geouned.Options.quadricPY should be a bool, not a {type(value)}") + self._quadricPY = value + + @property + def Facets(self): + return self._Facets + + @Facets.setter + def Facets(self, value: bool): + if not isinstance(value, bool): + raise TypeError(f"geouned.Options.Facets should be a bool, not a {type(value)}") + self._Facets = value + + @property + def prnt3PPlane(self): + return self._prnt3PPlane + + @prnt3PPlane.setter + def prnt3PPlane(self, value: bool): + if not isinstance(value, bool): + raise TypeError(f"geouned.Options.prnt3PPlane should be a bool, not a {type(value)}") + self._prnt3PPlane = value + + @property + def forceNoOverlap(self): + return self._forceNoOverlap + + @forceNoOverlap.setter + def forceNoOverlap(self, value: bool): + if not isinstance(value, bool): + raise TypeError(f"geouned.Options.forceNoOverlap should be a bool, not a {type(value)}") + self._forceNoOverlap = value
+ + + +
+[docs] +class Tolerances: + """A class for containing tolerances values + + Args: + relativeTol (bool, optional): _description_. Defaults to False. + relativePrecision (float, optional): relative precision. Defaults to 1.0e-6. + value (float, optional): Tolerance in single value comparison. Defaults to 1.0e-6. + distance (float, optional): General Distance Tolerance. Defaults to 1.0e-4. + angle (float, optional): General Angle Tolerance. Defaults to 1.0e-4. + pln_distance (float, optional): distance between planes equal planes if distance between parallel planes < 1e-4 cm. Defaults to 1.0e-4. + pln_angle (float, optional): angle between axis. 1e-4 : planes separate each other 0.1mm each 1m. Defaults to 1.0e-4. + cyl_distance (float, optional): distance between radius/center. Defaults to 1.0e-4. + cyl_angle (float, optional): angle between axis. Defaults to 1.0e-4. + sph_distance (float, optional): distance between radius/center. Defaults to 1.0e-4. + kne_distance (float, optional): distance between apex. Defaults to 1.0e-4. + kne_angle (float, optional): angle between semiangles/axis. Defaults to 1.0e-4. + tor_distance (float, optional): distance between Major/Minor radii/center. Defaults to 1.0e-4. + tor_angle (float, optional): angle between axis. Defaults to 1.0e-4. + min_area (float, optional): minimum face area to consider in cell definition. Defaults to 1.0e-2. + """ + + def __init__( + self, + relativeTol: bool = False, + relativePrecision: float = 1.0e-6, + value: float = 1.0e-6, + distance: float = 1.0e-4, + angle: float = 1.0e-4, + pln_distance: float = 1.0e-4, + pln_angle: float = 1.0e-4, + cyl_distance: float = 1.0e-4, + cyl_angle: float = 1.0e-4, + sph_distance: float = 1.0e-4, + kne_distance: float = 1.0e-4, + kne_angle: float = 1.0e-4, + tor_distance: float = 1.0e-4, + tor_angle: float = 1.0e-4, + min_area: float = 1.0e-2, + ): + + self.relativeTol = relativeTol + self.relativePrecision = relativePrecision + self.value = value + self.distance = distance + self.angle = angle + self.pln_distance = pln_distance + self.pln_angle = pln_angle + self.cyl_distance = cyl_distance + self.cyl_angle = cyl_angle + self.sph_distance = sph_distance + self.kne_distance = kne_distance + self.kne_angle = kne_angle + self.tor_distance = tor_distance + self.tor_angle = tor_angle + self.min_area = min_area + + @property + def relativeTol(self): + return self._relativeTol + + @relativeTol.setter + def relativeTol(self, value: bool): + if not isinstance(value, bool): + raise TypeError(f"geouned.Tolerances.relativeTol should be a bool, not a {type(value)}") + self._relativeTol = value + + @property + def relativePrecision(self): + return self._relativePrecision + + @relativePrecision.setter + def relativePrecision(self, value: float): + if not isinstance(value, float): + raise TypeError(f"geouned.Tolerances.relativePrecision should be a float, not a {type(value)}") + self._relativePrecision = value + + @property + def value(self): + return self._value + + @value.setter + def value(self, value: float): + if not isinstance(value, float): + raise TypeError(f"geouned.Tolerances.value should be a float, not a {type(value)}") + self._value = value + + @property + def distance(self): + return self._distance + + @distance.setter + def distance(self, distance: float): + if not isinstance(distance, float): + raise TypeError(f"geouned.Tolerances.distance should be a float, not a {type(distance)}") + self._distance = distance + + @property + def angle(self): + return self._angle + + @angle.setter + def angle(self, angle: float): + if not isinstance(angle, float): + raise TypeError(f"geouned.Tolerances.angle should be a float, not a {type(angle)}") + self._angle = angle + + @property + def pln_distance(self): + return self._pln_distance + + @pln_distance.setter + def pln_distance(self, pln_distance: float): + if not isinstance(pln_distance, float): + raise TypeError(f"geouned.Tolerances.pln_distance should be a float, not a {type(pln_distance)}") + self._pln_distance = pln_distance + + @property + def cyl_distance(self): + return self._cyl_distance + + @cyl_distance.setter + def cyl_distance(self, cyl_distance: float): + if not isinstance(cyl_distance, float): + raise TypeError(f"geouned.Tolerances.cyl_distance should be a float, not a {type(cyl_distance)}") + self._cyl_distance = cyl_distance + + @property + def cyl_angle(self): + return self._cyl_angle + + @cyl_angle.setter + def cyl_angle(self, cyl_angle: float): + if not isinstance(cyl_angle, float): + raise TypeError(f"geouned.Tolerances.cyl_angle should be a float, not a {type(cyl_angle)}") + self._cyl_angle = cyl_angle + + @property + def sph_distance(self): + return self._sph_distance + + @sph_distance.setter + def sph_distance(self, sph_distance: float): + if not isinstance(sph_distance, float): + raise TypeError(f"geouned.Tolerances.sph_distance should be a float, not a {type(sph_distance)}") + self._sph_distance = sph_distance + + @property + def pln_angle(self): + return self._pln_angle + + @pln_angle.setter + def pln_angle(self, pln_angle: float): + if not isinstance(pln_angle, float): + raise TypeError(f"geouned.Tolerances.pln_angle should be a float, not a {type(pln_angle)}") + self._pln_angle = pln_angle + + @property + def kne_distance(self): + return self._kne_distance + + @kne_distance.setter + def kne_distance(self, kne_distance: float): + if not isinstance(kne_distance, float): + raise TypeError(f"geouned.Tolerances.kne_distance should be a float, not a {type(kne_distance)}") + self._kne_distance = kne_distance + + @property + def kne_angle(self): + return self._kne_angle + + @kne_angle.setter + def kne_angle(self, kne_angle: float): + if not isinstance(kne_angle, float): + raise TypeError(f"geouned.Tolerances.kne_angle should be a float, not a {type(kne_angle)}") + self._kne_angle = kne_angle + + @property + def tor_distance(self): + return self._tor_distance + + @tor_distance.setter + def tor_distance(self, tor_distance: float): + if not isinstance(tor_distance, float): + raise TypeError(f"geouned.Tolerances.tor_distance should be a float, not a {type(tor_distance)}") + self._tor_distance = tor_distance + + @property + def tor_angle(self): + return self._tor_angle + + @tor_angle.setter + def tor_angle(self, tor_angle: float): + if not isinstance(tor_angle, float): + raise TypeError(f"geouned.Tolerances.tor_angle should be a float, not a {type(tor_angle)}") + self._tor_angle = tor_angle + + @property + def min_area(self): + return self._min_area + + @min_area.setter + def min_area(self, min_area: float): + if not isinstance(min_area, float): + raise TypeError(f"geouned.Tolerances.min_area should be a float, not a {type(min_area)}") + self._min_area = min_area
+ + + +
+[docs] +class NumericFormat: + """Numerical format options for each of the surface types. + + Args: + P_abc (str, optional): Plane general a,b,c params. Defaults to "14.7e". + P_d (str, optional): Plane general d params. Defaults to "14.7e". + P_xyz (str, optional): PX/PY/PZ params. Defaults to "14.7e". + S_r (str, optional): SO/SX/SY/SZ/S radius. Defaults to "14.7e". + S_xyz (str, optional): SO/SX/SY/SZ/S center. Defaults to "14.7e". + C_r (str, optional): Cylinder radius. Defaults to "12f". + C_xyz (str, optional): Cylinder center. Defaults to "12f". + K_xyz (str, optional): Cone apex. Defaults to "13.6e". + K_tan2 (str, optional): Cone tan^2 value. Defaults to "12f". + T_r (str, optional): Torus radii. Defaults to "14.7e". + T_xyz (str, optional): Torus center. Defaults to "14.7e". + GQ_1to6 (str, optional): GQ 1 to 6 coefficients (order 2 x2,y2,z2,xy,...). Defaults to "18.15f". + GQ_7to9 (str, optional): GQ 7 to 9 coefficients (order 1 x,y,z). Defaults to "18.15f". + GQ_10 (str, optional): GQ 10 coefficient. Defaults to "18.15f". + """ + + def __init__( + self, + P_abc: str = "14.7e", + P_d: str = "14.7e", + P_xyz: str = "14.7e", + S_r: str = "14.7e", + S_xyz: str = "14.7e", + C_r: str = "12f", + C_xyz: str = "12f", + K_xyz: str = "13.6e", + K_tan2: str = "12f", + T_r: str = "14.7e", + T_xyz: str = "14.7e", + GQ_1to6: str = "18.15f", + GQ_7to9: str = "18.15f", + GQ_10: str = "18.15f", + ): + + self.P_abc = P_abc + self.P_d = P_d + self.P_xyz = P_xyz + self.S_r = S_r + self.S_xyz = S_xyz + self.C_r = C_r + self.C_xyz = C_xyz + self.K_xyz = K_xyz + self.K_tan2 = K_tan2 + self.T_r = T_r + self.T_xyz = T_xyz + self.GQ_1to6 = GQ_1to6 + self.GQ_7to9 = GQ_7to9 + self.GQ_10 = GQ_10 + + @property + def P_abc(self): + return self._P_abc + + @P_abc.setter + def P_abc(self, P_abc: str): + if not isinstance(P_abc, str): + raise TypeError(f"geouned.Tolerances.P_abc should be a str, not a {type(P_abc)}") + self._P_abc = P_abc + + @property + def P_d(self): + return self._P_d + + @P_d.setter + def P_d(self, P_d: str): + if not isinstance(P_d, str): + raise TypeError(f"geouned.Tolerances.P_d should be a str, not a {type(P_d)}") + self._P_d = P_d + + @property + def P_xyz(self): + return self._P_xyz + + @P_xyz.setter + def P_xyz(self, P_xyz: str): + if not isinstance(P_xyz, str): + raise TypeError(f"geouned.Tolerances.P_xyz should be a str, not a {type(P_xyz)}") + self._P_xyz = P_xyz + + @property + def S_r(self): + return self._S_r + + @S_r.setter + def S_r(self, S_r: str): + if not isinstance(S_r, str): + raise TypeError(f"geouned.Tolerances.S_r should be a str, not a {type(S_r)}") + self._S_r = S_r + + @property + def S_xyz(self): + return self._S_xyz + + @S_xyz.setter + def S_xyz(self, S_xyz: str): + if not isinstance(S_xyz, str): + raise TypeError(f"geouned.Tolerances.S_xyz should be a str, not a {type(S_xyz)}") + self._S_xyz = S_xyz + + @property + def C_r(self): + return self._C_r + + @C_r.setter + def C_r(self, C_r: str): + if not isinstance(C_r, str): + raise TypeError(f"geouned.Tolerances.C_r should be a str, not a {type(C_r)}") + self._C_r = C_r + + @property + def C_xyz(self): + return self._C_xyz + + @C_xyz.setter + def C_xyz(self, C_xyz: str): + if not isinstance(C_xyz, str): + raise TypeError(f"geouned.Tolerances.C_xyz should be a str, not a {type(C_xyz)}") + self._C_xyz = C_xyz + + @property + def K_xyz(self): + return self._K_xyz + + @K_xyz.setter + def K_xyz(self, K_xyz: str): + if not isinstance(K_xyz, str): + raise TypeError(f"geouned.Tolerances.K_xyz should be a str, not a {type(K_xyz)}") + self._K_xyz = K_xyz + + @property + def K_tan2(self): + return self._K_tan2 + + @K_tan2.setter + def K_tan2(self, K_tan2: str): + if not isinstance(K_tan2, str): + raise TypeError(f"geouned.Tolerances.K_tan2 should be a str, not a {type(K_tan2)}") + self._K_tan2 = K_tan2 + + @property + def T_r(self): + return self._T_r + + @T_r.setter + def T_r(self, T_r: str): + if not isinstance(T_r, str): + raise TypeError(f"geouned.Tolerances.T_r should be a str, not a {type(T_r)}") + self._T_r = T_r + + @property + def T_xyz(self): + return self._T_xyz + + @T_xyz.setter + def T_xyz(self, T_xyz: str): + if not isinstance(T_xyz, str): + raise TypeError(f"geouned.Tolerances.T_xyz should be a str, not a {type(T_xyz)}") + self._T_xyz = T_xyz + + @property + def GQ_1to6(self): + return self._GQ_1to6 + + @GQ_1to6.setter + def GQ_1to6(self, GQ_1to6: str): + if not isinstance(GQ_1to6, str): + raise TypeError(f"geouned.Tolerances.GQ_1to6 should be a str, not a {type(GQ_1to6)}") + self._GQ_1to6 = GQ_1to6 + + @property + def GQ_7to9(self): + return self._GQ_7to9 + + @GQ_7to9.setter + def GQ_7to9(self, GQ_7to9: str): + if not isinstance(GQ_7to9, str): + raise TypeError(f"geouned.Tolerances.GQ_7to9 should be a str, not a {type(GQ_7to9)}") + self._GQ_7to9 = GQ_7to9 + + @property + def GQ_10(self): + return self._GQ_10 + + @GQ_10.setter + def GQ_10(self, GQ_10: str): + if not isinstance(GQ_10, str): + raise TypeError(f"geouned.Tolerances.GQ_10 should be a str, not a {type(GQ_10)}") + self._GQ_10 = GQ_10
+ + + +
+[docs] +class Settings: + """Settings for changing the way the CAD to CSG conversion is done + + Args: + stepFile (str, optional): Name of the CAD file (in STEP format) to + be converted. Defaults to "". + matFile (str, optional): _description_. Defaults to "". + voidGen (bool, optional): Generate voids of the geometry. Defaults + to True. + debug (bool, optional): Write step files of original and decomposed + solids, for each solid in the STEP file. Defaults to False. + compSolids (bool, optional): Join subsolids of STEP file as a single + compound solid. Step files generated with SpaceClaim have not + exactly the same level of solids as FreeCAD. It may a happened + that solids defined has separated solids are read by FreeCAD + as a single compound solid (and will produce only one MCNP + cell). In this case compSolids should be set to False. Defaults + to True. + simplify (str, optional): Simplify the cell definition considering + relative surfaces position and using Boolean logics. Available + options are: "no" no optimization, "void" only void cells are + simplified. Algorithm is faster but the simplification is not + optimal. "voidfull" : only void cells are simplified with the + most optimal algorithm. The time of the conversion can be + multiplied by 5 or more. "full" : all the cells (solids and + voids) are simplified. Defaults to "No". + cellRange (list, optional): Range of cell to be converted (only one + range is allowed, e.g [100,220]). Default all solids are + converted. Defaults to []. + exportSolids (str, optional): Export CAD solid after reading. + The execution is stopped after export, the translation is not + carried out. Defaults to "". + minVoidSize (float, optional): Minimum size of the edges of the + void cell. Units are in mm. Defaults to 200.0. + maxSurf (int, optional): #TODO + maxBracket (int, optional): Maximum number of brackets (solid + complementary) allowed in void cell definition. Defaults to 30. + voidMat (list, optional): Assign a material defined by the user + instead of void for cells without material definition and the + cells generated in the automatic void generation. The format + is a 3 valued tuple (mat_label, mat_density, mat_description). + Example (100,1e-3,'Air assigned to Void'). Defaults to []. + voidExclude (list, optional): #TODO see issue 87. Defaults to []. + startCell (int, optional): Starting cell numbering label. Defaults to 1. + startSurf (int, optional): Starting surface numbering label. Defaults to 1. + sort_enclosure (bool, optional): If enclosures are defined in the + CAD models, the voids cells of the enclosure will be located in + the output file in the same location where the enclosure solid + is located in the CAD solid tree.. Defaults to False. + """ + + def __init__( + self, + matFile: str = "", + voidGen: bool = True, + debug: bool = False, + compSolids: bool = True, + simplify: str = "no", + cellRange: list = [], + exportSolids: typing.Optional[str] = None, + minVoidSize: float = 200.0, # units mm + maxSurf: int = 50, + maxBracket: int = 30, + voidMat: list = [], + voidExclude: list = [], + startCell: int = 1, + startSurf: int = 1, + sort_enclosure: bool = False, + ): + + self.matFile = matFile + self.voidGen = voidGen + self.debug = debug + self.compSolids = compSolids + self.simplify = simplify + self.cellRange = cellRange + self.exportSolids = exportSolids + self.minVoidSize = minVoidSize + self.maxSurf = maxSurf + self.maxBracket = maxBracket + self.voidMat = voidMat + self.voidExclude = voidExclude + self.startCell = startCell + self.startSurf = startSurf + self.sort_enclosure = sort_enclosure + + @property + def matFile(self): + return self._matFile + + @matFile.setter + def matFile(self, matFile: str): + if not isinstance(matFile, str): + raise TypeError(f"geouned.Tolerances.matFile should be a str, not a {type(matFile)}") + self._matFile = matFile + + @property + def voidGen(self): + return self._voidGen + + @voidGen.setter + def voidGen(self, voidGen: bool): + if not isinstance(voidGen, bool): + raise TypeError(f"geouned.Tolerances.voidGen should be a bool, not a {type(voidGen)}") + self._voidGen = voidGen + + @property + def debug(self): + return self._debug + + @debug.setter + def debug(self, debug: bool): + if not isinstance(debug, bool): + raise TypeError(f"geouned.Tolerances.debug should be a bool, not a {type(debug)}") + self._debug = debug + + @property + def compSolids(self): + return self._compSolids + + @compSolids.setter + def compSolids(self, compSolids: bool): + if not isinstance(compSolids, bool): + raise TypeError(f"geouned.Tolerances.compSolids should be a bool, not a {type(compSolids)}") + self._compSolids = compSolids + + @property + def simplify(self): + return self._simplify + + @simplify.setter + def simplify(self, simplify: str): + if not isinstance(simplify, str): + raise TypeError(f"geouned.Tolerances.simplify should be a str, not a {type(simplify)}") + self._simplify = simplify + + @property + def cellRange(self): + return self._cellRange + + @cellRange.setter + def cellRange(self, cellRange: list): + if not isinstance(cellRange, list): + raise TypeError(f"geouned.Tolerances.cellRange should be a list, not a {type(cellRange)}") + for entry in cellRange: + if not isinstance(entry, int): + raise TypeError(f"geouned.Tolerances.cellRange should be a list of ints, not a {type(entry)}") + self._cellRange = cellRange + + @property + def exportSolids(self): + return self._exportSolids + + @exportSolids.setter + def exportSolids(self, exportSolids: str): + if exportSolids == None: + pass + elif not isinstance(exportSolids, str): + raise TypeError(f"geouned.Tolerances.exportSolids should be a str, not a {type(exportSolids)}") + self._exportSolids = exportSolids + + @property + def minVoidSize(self): + return self._minVoidSize + + @minVoidSize.setter + def minVoidSize(self, minVoidSize: float): + if not isinstance(minVoidSize, float): + raise TypeError(f"geouned.Tolerances.minVoidSize should be a float, not a {type(minVoidSize)}") + self._minVoidSize = minVoidSize + + @property + def maxSurf(self): + return self._maxSurf + + @maxSurf.setter + def maxSurf(self, maxSurf: int): + if not isinstance(maxSurf, int): + raise TypeError(f"geouned.Tolerances.maxSurf should be a int, not a {type(maxSurf)}") + self._maxSurf = maxSurf + + @property + def maxBracket(self): + return self._maxBracket + + @maxBracket.setter + def maxBracket(self, maxBracket: int): + if not isinstance(maxBracket, int): + raise TypeError(f"geouned.Tolerances.maxBracket should be a int, not a {type(maxBracket)}") + self._maxBracket = maxBracket + + @property + def voidMat(self): + return self._voidMat + + @voidMat.setter + def voidMat(self, voidMat: list): + if not isinstance(voidMat, list): + raise TypeError(f"geouned.Tolerances.voidMat should be a list, not a {type(voidMat)}") + for entry in voidMat: + if not isinstance(entry, int): + raise TypeError(f"geouned.Tolerances.voidMat should be a list of ints, not a {type(entry)}") + self._voidMat = voidMat + + @property + def voidExclude(self): + return self._voidExclude + + @voidExclude.setter + def voidExclude(self, voidExclude: list): + if not isinstance(voidExclude, list): + raise TypeError(f"geouned.Tolerances.voidExclude should be a list, not a {type(voidExclude)}") + for entry in voidExclude: + if not isinstance(entry, int): + raise TypeError(f"geouned.Tolerances.voidExclude should be a list of ints, not a {type(entry)}") + self._voidExclude = voidExclude + + @property + def startCell(self): + return self._startCell + + @startCell.setter + def startCell(self, startCell: int): + if not isinstance(startCell, int): + raise TypeError(f"geouned.Tolerances.startCell should be a int, not a {type(startCell)}") + self._startCell = startCell + + @property + def startSurf(self): + return self._startSurf + + @startSurf.setter + def startSurf(self, startSurf: int): + if not isinstance(startSurf, int): + raise TypeError(f"geouned.Tolerances.startSurf should be a int, not a {type(startSurf)}") + self._startSurf = startSurf + + @property + def sort_enclosure(self): + return self._sort_enclosure + + @sort_enclosure.setter + def sort_enclosure(self, sort_enclosure: bool): + if not isinstance(sort_enclosure, bool): + raise TypeError(f"geouned.Tolerances.sort_enclosure should be a bool, not a {type(sort_enclosure)}") + self._sort_enclosure = sort_enclosure
+ +
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/_modules/index.html b/_modules/index.html new file mode 100644 index 00000000..04ba5a95 --- /dev/null +++ b/_modules/index.html @@ -0,0 +1,107 @@ + + + + + + Overview: module code — GEOUNED 1.0.1 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ +

All modules for which code is available

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

Developer guide

+

TOOD

+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/genindex.html b/genindex.html new file mode 100644 index 00000000..8546036d --- /dev/null +++ b/genindex.html @@ -0,0 +1,174 @@ + + + + + + Index — GEOUNED 1.0.1 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ + +

Index

+ +
+ C + | E + | F + | N + | O + | S + | T + +
+

C

+ + +
+ +

E

+ + +
+ +

F

+ + +
+ +

N

+ + +
+ +

O

+ + +
+ +

S

+ + +
+ +

T

+ + +
+ + + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/index.html b/index.html new file mode 100644 index 00000000..71d9a877 --- /dev/null +++ b/index.html @@ -0,0 +1,152 @@ + + + + + + + GEOUNED — GEOUNED 1.0.1 documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

GEOUNED

+

GEOUNED converts CAD to Constructive Solid Geometry (CSG) formats for use in +Monte Carlo transport codes. +Supported codes include OpenMC, PHITS, Serpent and MCNP.

+ +
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/install/index.html b/install/index.html new file mode 100644 index 00000000..a737aa05 --- /dev/null +++ b/install/index.html @@ -0,0 +1,131 @@ + + + + + + + Install — GEOUNED 1.0.1 documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Install

+

There are several options for installing GEOUNED package. +The installation selected has implications for how you run GEOUNED Python scripts. +Currently the Mamba / Conda install is the recommended method. +The main complication when installing GEOUNED is integration between the main dependency (FreeCAD) and the users system Python. +Mamba / Conda provides a connection between the FreeCAD Python library and your system Python. +Users have also had success installing FreeCAD and making use of the Python version inbuilt into FreeCAD and the freecad.cmd however the integration ofr FrreCAD with the system Python is more challenging when installing in this manner. +.. TODO as well so these installation methods are listed for completeness.

+ +
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/install/install_linux.html b/install/install_linux.html new file mode 100644 index 00000000..a138399c --- /dev/null +++ b/install/install_linux.html @@ -0,0 +1,262 @@ + + + + + + + 1. Linux — GEOUNED 1.0.1 documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Linux

+ +
+

1.2. User install with Conda

+

First we need to install a Conda distribution. There are a few options but we here we opt for MiniConda3 as it downloads quicker than the fuller AnaConda.

+

You can follow the install instructions for MiniConda3 or follow the commands below. +Download.

+
mkdir -p ~/miniconda3
+wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh -O ~/miniconda3/miniconda.sh
+
+
+

Install MiniConda3

+
bash ~/miniconda3/miniconda.sh -b -u -p ~/miniconda3
+
+
+

Activate the base environment in your current terminal

+
~/miniconda3/bin/conda init bash
+
+
+

It is recommended to create a new environment

+
conda create --name new_env python=3.11
+
+
+

Activate the new environment

+
conda activate new_env
+
+
+

Install GEOUNED from conda-forge

+
conda install -c conda-forge geouned
+
+
+

Then you will be able to run import GEOUNED from within Python

+
import geouned
+
+
+

You will also be able to use the GEOUNED command line tool

+
geouned_cadtocsg --help
+
+
+
+
+

1.3. Developer install with Mamba

+

First we need to install a Mamba distribution. There are a few options but here we opt for Miniforge3 as it includes Mamba.

+

You can follow the install instructions for Miniforge3 here or follows the commands below. +Download

+
curl -L -O "https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-$(uname)-$(uname -m).sh"
+bash Miniforge3-$(uname)-$(uname -m).sh
+
+
+

Install Miniforge3

+
bash Miniforge3-Linux-x86_64.sh
+
+
+

Activate the base environment in your current terminal

+
mamba activate
+
+
+

It is recommended to create a new environment

+
mamba create --name new_env python=3.11
+
+
+

Activate the new environment

+
mamba activate new_env
+
+
+

We have aspirations to create a conda-forge package which will combine these final two steps, but for now FreeCAD and GEOUNED can be installed in two commands. +Install FreeCAD which is the main dependency

+
mamba install -c conda-forge freecad
+
+
+

Fork the GEOUNED-org/GEOUNED repository by clicking this link, unchecking the Copy the main branch only check box and clicking create fork

+

https://github.com/GEOUNED-org/GEOUNED/fork

+

Assuming that you have setup and added SSH keys then we can clone your forked GEOUNED repository. +Replace <USER> with your own github username

+
git clone git@github.com:<USER>/GEOUNED.git
+
+
+

Then change directory into the repository root like this

+
cd GEOUNED
+
+
+

Install GEOUNED with pip, we also prefix this with “python -m” to ensure that pip install uses the correct Python interpreter. +We are also adding the -e to get an editable install so that when you make local changes to the repo these are picked up in your Python scripts straight away (without needing to reinstall). +We also include all the optional dependencies so that we can run tests locally and build the docs locally.

+
python -m pip install -e .[tests,docs]
+
+
+

Then you will be able to run import GEOUNED from within Python

+
import geouned
+
+
+

You will also be able to use the GEOUNED command line tool

+
geouned_cadtocsg --help
+
+
+

Checkout feature branches from dev and make local changes on you own branch

+
git checkout dev
+git checkout -b 'my_new_feature'
+
+
+

Pull requests are welcome

+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/install/install_windows.html b/install/install_windows.html new file mode 100644 index 00000000..0f6db922 --- /dev/null +++ b/install/install_windows.html @@ -0,0 +1,182 @@ + + + + + + + 2. Windows — GEOUNED 1.0.1 documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Windows

+ +
+

2.2. User install with Conda

+

First we need to install a Conda distribution. There are a few options but we here we opt for MiniConda3 as it downloads quicker than the fuller AnaConda.

+

You can follow the install instructions for MiniConda3

+

Download and execute the Miniforge3 Windows installer

+

You can get it from the Miniforge3 GitHub repository here or from the link below

+

https://repo.anaconda.com/miniconda/Miniconda3-latest-Windows-x86_64.exe

+

Open “Anaconda Prompt (miniconda3)” which will now be available on your start menu.

+

It is recommended to create a new environment

+
conda create --name new_env python=3.11
+
+
+

Activate the new environment

+
conda activate new_env
+
+
+

Install GEOUNED from conda-forge

+
conda install -c conda-forge geouned
+
+
+

Then you will be able to run import GEOUNED from within Python

+
import geouned
+
+
+

You will also be able to use the GEOUNED command line tool

+
geouned_cadtocsg --help
+
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/methodology.html b/methodology.html new file mode 100644 index 00000000..4c8aae8e --- /dev/null +++ b/methodology.html @@ -0,0 +1,119 @@ + + + + + + + Methodology — GEOUNED 1.0.1 documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Methodology

+

There are several documents on the methodology of GEOUNED

+

Publication

+

User_Guide_GEOUNED_v2.0.pdf

+

Training_on_GEOUNED_tool

+

TODO convert various data sources to rst format for these docs

+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/objects.inv b/objects.inv new file mode 100644 index 00000000..ce70ab48 --- /dev/null +++ b/objects.inv @@ -0,0 +1,6 @@ +# Sphinx inventory version 2 +# Project: GEOUNED +# Version: +# The remainder of this file is compressed using zlib. +xڍQo0$۫,{mQlJfkOVz-S¨wX4#l3yJ:|.2!9&$H{N9*PfP"̗+̒o}[w<`ɐ1+ :bĐ 2b/ "p˾zo.S?(");poo~0nk` sPIZp6lʐVSj&% N5( +mYVǠ5YQц4ukr7\WXG`=ޫXVH˧oguV M4B@3I'{MFKP)@=\ִ1 ml>&).E:atH+. K*Y+ HVmM \ No newline at end of file diff --git a/python_api.html b/python_api.html new file mode 100644 index 00000000..505cb571 --- /dev/null +++ b/python_api.html @@ -0,0 +1,381 @@ + + + + + + + Python API reference — GEOUNED 1.0.1 documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Python API reference

+
+
+class geouned.CadToCsg(stepFile='', options=<geouned.GEOUNED.utils.data_classes.Options object>, tolerances=<geouned.GEOUNED.utils.data_classes.Tolerances object>, numeric_format=<geouned.GEOUNED.utils.data_classes.NumericFormat object>, settings=<geouned.GEOUNED.utils.data_classes.Settings object>)[source]
+

Bases: object

+

Base class for the conversion of CAD to CSG models

+
+
Parameters:
+
    +
  • stepFile (str, optional) – Name of the CAD file (in STEP format) to +be converted. Defaults to “”.

  • +
  • options (geouned.Options, optional) – An instance of a geouned.Options +class with the attributes set for the desired conversion. Defaults +to a geouned.Options with default attributes values.

  • +
  • tolerances (geouned.Tolerances, optional) – An instance of a +geouned.Tolerances class with the attributes set for the desired +conversion. Defaults to a geouned.Tolerances with default +attributes values.

  • +
  • numeric_format (geouned.NumericFormat, optional) – An instance of a +geouned.NumericFormat class with the attributes set for the desired +conversion. Defaults to a geouned.NumericFormat with default +attributes values.

  • +
  • settings (geouned.Settings, optional) – An instance of a +geouned.Settings class with the attributes set for the desired +conversion. Defaults to a geouned.Settings with default +attributes values.

  • +
+
+
+
+
+export_csg(title='Converted with GEOUNED', geometryName='csg', outFormat=('openmc_xml', 'openmc_py', 'serpent', 'phits', 'mcnp'), volSDEF=False, volCARD=True, UCARD=101, dummyMat=False, cellCommentFile=False, cellSummaryFile=True)[source]
+

Writes out a CSG file in the requested Monte Carlo code format.

+
+
Parameters:
+
    +
  • title (str, optional) – Title of the model written at the top of the +output file. Defaults to “Geouned conversion”.

  • +
  • geometryName (str, optional) – the file stem of the output file(s). +Defaults to “converted_with_geouned”.

  • +
  • outFormat (Tuple[str], optional) – Format for the output +geometry. Available format are: “mcnp”, “openmc_xml”, +“openmc_py”, “phits” and “serpent”. Several output format can +be written in the same method call. Defaults to output all codes.

  • +
  • volSDEF (bool, optional) – Write SDEF definition and tally of solid +cell for stochastic volume checking. Defaults to False.

  • +
  • volCARD (bool, optional) – Write the CAD calculated volume in the +cell definition using the VOL card. Defaults to True.

  • +
  • UCARD (int, optional) – Write universe card in the cell definition +with the specified universe number (if value = 0 Universe card +is not written). Defaults to None.

  • +
  • dummyMat (bool, optional) – Write dummy material definition card in +the MCNP output file for all material labels present in the +model. Dummy material definition is “MX 1001 1”. Defaults to False.

  • +
  • cellCommentFile (bool, optional) – Write an additional file with +comment associated to each CAD cell in the MCNP output file. +Defaults to False.

  • +
  • cellSummaryFile (bool, optional) – Write an additional file with +information on the CAD cell translated. Defaults to True.

  • +
+
+
+
+ +
+
+classmethod from_json(filename)[source]
+

Creates a CadToCsg instance and returns the instance. Populating the +Options, Tolerance, Settings and NumericFormat attributes from matching +key names in the JSON. If export_to_csg key is present then this method +also runs .start() and .export_to_csg() on the instance.

+
+
Parameters:
+

str (filename) – The filename of the config file. Defaults to “config.json”.

+
+
Raises:
+
    +
  • FileNotFoundError – If the config file is not found

  • +
  • ValueError – If the config JSON file is found to contain an invalid key

  • +
+
+
Returns:
+

returns a geouned CadToCsg class instance.

+
+
Return type:
+

geouned.CadToCsg

+
+
+
+ +
+ +
+
+class geouned.NumericFormat(P_abc='14.7e', P_d='14.7e', P_xyz='14.7e', S_r='14.7e', S_xyz='14.7e', C_r='12f', C_xyz='12f', K_xyz='13.6e', K_tan2='12f', T_r='14.7e', T_xyz='14.7e', GQ_1to6='18.15f', GQ_7to9='18.15f', GQ_10='18.15f')[source]
+

Bases: object

+

Numerical format options for each of the surface types.

+
+
Parameters:
+
    +
  • P_abc (str, optional) – Plane general a,b,c params. Defaults to “14.7e”.

  • +
  • P_d (str, optional) – Plane general d params. Defaults to “14.7e”.

  • +
  • P_xyz (str, optional) – PX/PY/PZ params. Defaults to “14.7e”.

  • +
  • S_r (str, optional) – SO/SX/SY/SZ/S radius. Defaults to “14.7e”.

  • +
  • S_xyz (str, optional) – SO/SX/SY/SZ/S center. Defaults to “14.7e”.

  • +
  • C_r (str, optional) – Cylinder radius. Defaults to “12f”.

  • +
  • C_xyz (str, optional) – Cylinder center. Defaults to “12f”.

  • +
  • K_xyz (str, optional) – Cone apex. Defaults to “13.6e”.

  • +
  • K_tan2 (str, optional) – Cone tan^2 value. Defaults to “12f”.

  • +
  • T_r (str, optional) – Torus radii. Defaults to “14.7e”.

  • +
  • T_xyz (str, optional) – Torus center. Defaults to “14.7e”.

  • +
  • GQ_1to6 (str, optional) – GQ 1 to 6 coefficients (order 2 x2,y2,z2,xy,…). Defaults to “18.15f”.

  • +
  • GQ_7to9 (str, optional) – GQ 7 to 9 coefficients (order 1 x,y,z). Defaults to “18.15f”.

  • +
  • GQ_10 (str, optional) – GQ 10 coefficient. Defaults to “18.15f”.

  • +
+
+
+
+ +
+
+class geouned.Options(forceCylinder=False, newSplitPlane=True, delLastNumber=False, enlargeBox=2.0, nPlaneReverse=0, splitTolerance=0.0, scaleUp=True, quadricPY=False, Facets=False, prnt3PPlane=False, forceNoOverlap=False)[source]
+

Bases: object

+

A class for containing conversion options

+
+
Parameters:
+
    +
  • forceCylinder (bool, optional) – Use cylinder (instead of cones) as +ancillary surface where unclosed torus surfaces are involved in +the solid definition. Defaults to False.

  • +
  • newSplitPlane (bool, optional) – New method to consider plane as +cutting surface during the decomposition process. Former method +split first planes perpendicular to X,Y,Z axis and then the +other planes involved in the solid definition. New method group +all parallel planes independently whether their normal are +along X,Y,Z axes, and start the decomposition process cutting +first with the group having the highest number of parallel +planes. Defaults to True.

  • +
  • delLastNumber (bool, optional) – Deleting the last word in the +comment if it is a number. Defaults to False.

  • +
  • enlargeBox (Real, optional) – Enlarge box boundary when evaluating +the constraint table during the simplification of the void cell +definition. (unit is millimeter). Defaults to 2.

  • +
  • nPlaneReverse (int, optional) – Threshold value to determine whether +cut with parallel planes should be carried out first. Defaults +to 0.

  • +
  • splitTolerance (Real, optional) – Fuzzy tolerance value used in the +FreeCAD function “BOPTools.SplitAPI.slice”. This function is +used during the solid decomposition process. Defaults to 0.

  • +
  • scaleUp (bool, optional) – Scale up Fuzzy tolerance once get below +1e-12. Defaults to True.

  • +
  • quadricPY (bool, optional) – In openMC python script format, the +cones or cylinders no aligned with the X,Y, or Z axis can be +defined using the openmc.Cone or open.Cylinder methods but can +also be defined with their quadric parameter. If “quadricPY” is +11 True then all cones and cylinders will be defined in the +openMC python script format under their quadric form. Defaults +to False.

  • +
  • Facets (bool, optional) – use alternative conversion module when +geometry is defined by cells compound by only triangular plane +faces. Defaults to False.

  • +
  • prnt3PPlane (bool, optional) – print 3 point plane definition in +output as 3 points coordinates. Defaults to False.

  • +
  • forceNoOverlap (bool, optional) – force no overlaping cell +definition. Adjacent cell definition are rested from current +cell definition. Defaults to False.

  • +
+
+
+
+ +
+
+class geouned.Settings(matFile='', voidGen=True, debug=False, compSolids=True, simplify='no', cellRange=[], exportSolids=None, minVoidSize=200.0, maxSurf=50, maxBracket=30, voidMat=[], voidExclude=[], startCell=1, startSurf=1, sort_enclosure=False)[source]
+

Bases: object

+

Settings for changing the way the CAD to CSG conversion is done

+
+
Parameters:
+
    +
  • stepFile (str, optional) – Name of the CAD file (in STEP format) to +be converted. Defaults to “”.

  • +
  • matFile (str, optional) – _description_. Defaults to “”.

  • +
  • voidGen (bool, optional) – Generate voids of the geometry. Defaults +to True.

  • +
  • debug (bool, optional) – Write step files of original and decomposed +solids, for each solid in the STEP file. Defaults to False.

  • +
  • compSolids (bool, optional) – Join subsolids of STEP file as a single +compound solid. Step files generated with SpaceClaim have not +exactly the same level of solids as FreeCAD. It may a happened +that solids defined has separated solids are read by FreeCAD +as a single compound solid (and will produce only one MCNP +cell). In this case compSolids should be set to False. Defaults +to True.

  • +
  • simplify (str, optional) – Simplify the cell definition considering +relative surfaces position and using Boolean logics. Available +options are: “no” no optimization, “void” only void cells are +simplified. Algorithm is faster but the simplification is not +optimal. “voidfull” : only void cells are simplified with the +most optimal algorithm. The time of the conversion can be +multiplied by 5 or more. “full” : all the cells (solids and +voids) are simplified. Defaults to “No”.

  • +
  • cellRange (list, optional) – Range of cell to be converted (only one +range is allowed, e.g [100,220]). Default all solids are +converted. Defaults to [].

  • +
  • exportSolids (str, optional) – Export CAD solid after reading. +The execution is stopped after export, the translation is not +carried out. Defaults to “”.

  • +
  • minVoidSize (float, optional) – Minimum size of the edges of the +void cell. Units are in mm. Defaults to 200.0.

  • +
  • maxSurf (int, optional) – #TODO

  • +
  • maxBracket (int, optional) – Maximum number of brackets (solid +complementary) allowed in void cell definition. Defaults to 30.

  • +
  • voidMat (list, optional) – Assign a material defined by the user +instead of void for cells without material definition and the +cells generated in the automatic void generation. The format +is a 3 valued tuple (mat_label, mat_density, mat_description). +Example (100,1e-3,’Air assigned to Void’). Defaults to [].

  • +
  • voidExclude (list, optional) – #TODO see issue 87. Defaults to [].

  • +
  • startCell (int, optional) – Starting cell numbering label. Defaults to 1.

  • +
  • startSurf (int, optional) – Starting surface numbering label. Defaults to 1.

  • +
  • sort_enclosure (bool, optional) – If enclosures are defined in the +CAD models, the voids cells of the enclosure will be located in +the output file in the same location where the enclosure solid +is located in the CAD solid tree.. Defaults to False.

  • +
+
+
+
+ +
+
+class geouned.Tolerances(relativeTol=False, relativePrecision=1e-06, value=1e-06, distance=0.0001, angle=0.0001, pln_distance=0.0001, pln_angle=0.0001, cyl_distance=0.0001, cyl_angle=0.0001, sph_distance=0.0001, kne_distance=0.0001, kne_angle=0.0001, tor_distance=0.0001, tor_angle=0.0001, min_area=0.01)[source]
+

Bases: object

+

A class for containing tolerances values

+
+
Parameters:
+
    +
  • relativeTol (bool, optional) – _description_. Defaults to False.

  • +
  • relativePrecision (float, optional) – relative precision. Defaults to 1.0e-6.

  • +
  • value (float, optional) – Tolerance in single value comparison. Defaults to 1.0e-6.

  • +
  • distance (float, optional) – General Distance Tolerance. Defaults to 1.0e-4.

  • +
  • angle (float, optional) – General Angle Tolerance. Defaults to 1.0e-4.

  • +
  • pln_distance (float, optional) – distance between planes equal planes if distance between parallel planes < 1e-4 cm. Defaults to 1.0e-4.

  • +
  • pln_angle (float, optional) – angle between axis. 1e-4 : planes separate each other 0.1mm each 1m. Defaults to 1.0e-4.

  • +
  • cyl_distance (float, optional) – distance between radius/center. Defaults to 1.0e-4.

  • +
  • cyl_angle (float, optional) – angle between axis. Defaults to 1.0e-4.

  • +
  • sph_distance (float, optional) – distance between radius/center. Defaults to 1.0e-4.

  • +
  • kne_distance (float, optional) – distance between apex. Defaults to 1.0e-4.

  • +
  • kne_angle (float, optional) – angle between semiangles/axis. Defaults to 1.0e-4.

  • +
  • tor_distance (float, optional) – distance between Major/Minor radii/center. Defaults to 1.0e-4.

  • +
  • tor_angle (float, optional) – angle between axis. Defaults to 1.0e-4.

  • +
  • min_area (float, optional) – minimum face area to consider in cell definition. Defaults to 1.0e-2.

  • +
+
+
+
+ +
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/search.html b/search.html new file mode 100644 index 00000000..bcdf09b5 --- /dev/null +++ b/search.html @@ -0,0 +1,125 @@ + + + + + + Search — GEOUNED 1.0.1 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + + + +
+ +
+ +
+
+ +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/searchindex.js b/searchindex.js new file mode 100644 index 00000000..41826da9 --- /dev/null +++ b/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"alltitles": {"Command Line Tool Usage": [[9, "command-line-tool-usage"]], "Developer guide": [[0, "developer-guide"]], "Developer install with Mamba": [[3, "developer-install-with-mamba"]], "GEOUNED": [[1, "geouned"]], "Install": [[2, "install"]], "Linux": [[3, "linux"]], "Methodology": [[5, "methodology"]], "Python API reference": [[6, "python-api-reference"]], "Python Package Usage": [[8, "python-package-usage"]], "Usage": [[7, "usage"]], "User install with Conda": [[3, "user-install-with-conda"], [4, "user-install-with-conda"]], "User install with Mamba (recommended)": [[3, "user-install-with-mamba-recommended"], [4, "user-install-with-mamba-recommended"]], "Windows": [[4, "windows"]]}, "docnames": ["developer_guide", "index", "install/index", "install/install_linux", "install/install_windows", "methodology", "python_api", "usage/index", "usage/python_api_usage", "usage/python_cli_usage"], "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": ["developer_guide.rst", "index.rst", "install/index.rst", "install/install_linux.rst", "install/install_windows.rst", "methodology.rst", "python_api.rst", "usage/index.rst", "usage/python_api_usage.rst", "usage/python_cli_usage.rst"], "indexentries": {"cadtocsg (class in geouned)": [[6, "geouned.CadToCsg", false]], "export_csg() (geouned.cadtocsg method)": [[6, "geouned.CadToCsg.export_csg", false]], "from_json() (geouned.cadtocsg class method)": [[6, "geouned.CadToCsg.from_json", false]], "numericformat (class in geouned)": [[6, "geouned.NumericFormat", false]], "options (class in geouned)": [[6, "geouned.Options", false]], "settings (class in geouned)": [[6, "geouned.Settings", false]], "tolerances (class in geouned)": [[6, "geouned.Tolerances", false]]}, "objects": {"geouned": [[6, 0, 1, "", "CadToCsg"], [6, 0, 1, "", "NumericFormat"], [6, 0, 1, "", "Options"], [6, 0, 1, "", "Settings"], [6, 0, 1, "", "Tolerances"]], "geouned.CadToCsg": [[6, 1, 1, "", "export_csg"], [6, 1, 1, "", "from_json"]]}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "method", "Python method"]}, "objtypes": {"0": "py:class", "1": "py:method"}, "terms": {"": 6, "0": [5, 6, 8, 9], "000001": 8, "0001": [6, 8, 9], "01": [6, 8, 9], "06": [6, 9], "0e": 6, "1": [6, 8, 9], "10": 6, "100": 6, "1001": 6, "101": 6, "11": [3, 4, 6], "12": 6, "12f": [6, 8, 9], "13": [6, 8, 9], "14": [6, 8, 9], "15f": [6, 8, 9], "18": [6, 8, 9], "1e": [6, 9], "1m": 6, "1mm": 6, "2": [6, 8, 9], "200": [6, 8, 9], "220": 6, "3": [3, 4, 6], "30": [6, 8, 9], "4": 6, "5": 6, "50": [6, 8, 9], "6": 6, "6e": [6, 8, 9], "7": 6, "7e": [6, 8, 9], "87": 6, "9": 6, "A": 6, "For": [8, 9], "If": [6, 8], "In": 6, "It": [3, 4, 6], "No": 6, "The": [2, 6, 8, 9], "Then": [3, 4, 9], "There": [2, 3, 4, 5, 8], "These": 9, "_description_": 6, "abl": [3, 4], "activ": [3, 4], "ad": 3, "addit": 6, "adjac": 6, "after": 6, "air": 6, "algorithm": 6, "align": 6, "all": [3, 6], "allow": 6, "along": 6, "also": [2, 3, 4, 6, 8], "altern": 6, "an": [3, 6], "anaconda": [3, 4], "ancillari": 6, "angl": [6, 8, 9], "apex": 6, "api": [1, 7, 8, 9], "ar": [2, 3, 4, 5, 6, 8], "area": 6, "argument": [8, 9], "aspir": 3, "assign": 6, "associ": 6, "assum": [3, 8, 9], "attribut": [6, 8, 9], "automat": 6, "avail": [4, 6], "awai": 3, "ax": 6, "axi": 6, "b": [3, 6], "base": [3, 6], "bash": 3, "being": [8, 9], "below": [3, 4, 6, 8, 9], "between": [2, 6], "bin": 3, "bool": 6, "boolean": 6, "boptool": 6, "boundari": 6, "box": [3, 6], "bracket": 6, "branch": 3, "build": 3, "c": [3, 4, 6], "c_r": [6, 8, 9], "c_xyz": [6, 8, 9], "cad": [1, 6, 8, 9], "cadtocsg": [1, 6, 8], "calcul": 6, "call": [6, 8, 9], "can": [3, 4, 6, 7, 8, 9], "card": 6, "carlo": [1, 6], "carri": 6, "case": [6, 8, 9], "cd": 3, "cell": 6, "cellcommentfil": [6, 8, 9], "cellrang": [6, 8, 9], "cellsummaryfil": [6, 8, 9], "center": 6, "challeng": 2, "chang": [3, 6, 8], "check": [3, 6], "checkout": 3, "class": [6, 8, 9], "classmethod": 6, "cli": 7, "click": 3, "clone": 3, "close": 9, "cm": 6, "cmd": 2, "code": [1, 6], "coeffici": 6, "com": [3, 4], "combin": 3, "command": [1, 3, 4, 7, 8], "comment": 6, "comparison": 6, "complementari": 6, "complet": [2, 4, 8, 9], "complic": 2, "compound": 6, "compsolid": [6, 8, 9], "conda": [1, 2], "cone": 6, "config": [6, 8, 9], "configur": [8, 9], "connect": 2, "consid": 6, "constraint": 6, "construct": [1, 8], "contain": [6, 9], "content": 9, "convers": [6, 8], "convert": [1, 5, 6, 8, 9], "converted_with_geoun": 6, "coordin": 6, "copi": 3, "correct": 3, "creat": [3, 4, 6, 9], "csg": [1, 6, 8, 9], "cuboid": [8, 9], "curl": 3, "current": [2, 3, 6, 9], "cut": 6, "cyl_angl": [6, 8, 9], "cyl_dist": [6, 8, 9], "cylind": 6, "d": 6, "data": 5, "data_class": 6, "debug": [6, 8, 9], "decompos": 6, "decomposit": 6, "default": [6, 8, 9], "defin": 6, "definit": 6, "delet": 6, "dellastnumb": [6, 8, 9], "depend": [2, 3], "descript": 9, "desir": [6, 8], "determin": 6, "dev": 3, "develop": 1, "directori": [3, 8, 9], "distanc": [6, 8, 9], "distribut": [3, 4], "doc": [3, 5], "document": [5, 8, 9], "done": 6, "download": [3, 4], "dummi": 6, "dummymat": [6, 8, 9], "dure": 6, "e": [3, 6], "each": [6, 9], "edg": 6, "edit": 3, "enclosur": 6, "enlarg": 6, "enlargebox": [6, 8, 9], "ensur": 3, "environ": [3, 4], "equal": 6, "evalu": 6, "everi": [8, 9], "ex": 4, "exactli": 6, "exampl": [6, 8, 9], "execut": [4, 6, 9], "export": 6, "export_csg": [1, 6, 8, 9], "export_to_csg": 6, "exportsolid": [6, 8, 9], "face": 6, "facet": [6, 8, 9], "fals": [6, 8, 9], "faster": 6, "featur": 3, "few": [3, 4], "file": [6, 8, 9], "filenam": 6, "filenotfounderror": 6, "final": 3, "first": [3, 4, 6, 9], "float": 6, "follow": [3, 4, 8, 9], "forc": 6, "forcecylind": [6, 8, 9], "forcenooverlap": [6, 8, 9], "forg": [3, 4], "fork": 3, "form": 6, "format": [1, 5, 6, 8], "former": 6, "found": 6, "freecad": [2, 3, 6, 8], "from": [3, 4, 6, 8], "from_json": [1, 6, 8], "frrecad": 2, "full": [6, 9], "fuller": [3, 4], "function": 6, "fuzzi": 6, "g": 6, "gener": 6, "geo": 8, "geometri": [1, 6, 8], "geometrynam": [6, 8, 9], "geoun": [2, 3, 4, 5, 6, 7, 8, 9], "geouned_cadtocsg": [3, 4, 9], "get": [3, 4, 6], "git": 3, "github": [3, 4], "gq": 6, "gq_10": [6, 8, 9], "gq_1to6": [6, 8, 9], "gq_7to9": [6, 8, 9], "group": 6, "guid": 1, "ha": [2, 6], "had": 2, "happen": 6, "have": [2, 3, 6, 8, 9], "help": [3, 4], "here": [3, 4, 9], "highest": 6, "how": 2, "howev": 2, "http": [3, 4], "i": [2, 3, 4, 6, 8, 9], "implic": 2, "import": [3, 4, 8], "inbuilt": 2, "includ": [1, 3, 4], "independ": 6, "inform": 6, "init": 3, "instal": [1, 8], "instanc": 6, "instead": 6, "instruct": [3, 4], "int": 6, "integr": 2, "interfac": [8, 9], "interpret": 3, "invalid": 6, "involv": 6, "issu": 6, "join": 6, "json": [6, 8, 9], "k_tan2": [6, 8, 9], "k_xyz": [6, 8, 9], "kei": [3, 6], "keyword": 9, "kne_angl": [6, 8, 9], "kne_dist": [6, 8, 9], "l": 3, "label": 6, "last": 6, "latest": [3, 4], "level": 6, "librari": 2, "like": 3, "line": [1, 3, 4, 7, 8], "link": [3, 4], "linux": [1, 2], "list": [2, 6], "load": 8, "local": 3, "locat": 6, "logic": 6, "m": 3, "mai": 6, "main": [2, 3, 8], "major": 6, "make": [2, 3, 8], "mamba": [1, 2], "mani": 8, "manner": 2, "mat_dens": 6, "mat_descript": 6, "mat_label": 6, "match": [6, 9], "materi": 6, "matfil": [6, 8, 9], "maxbracket": [6, 8, 9], "maximum": 6, "maxsurf": [6, 8, 9], "mcnp": [1, 6, 8, 9], "menu": 4, "method": [2, 6, 9], "methodologi": 1, "millimet": 6, "min_area": [6, 8, 9], "miniconda": [3, 4], "miniconda3": [3, 4], "miniforg": [3, 4], "miniforge3": [3, 4], "minim": [8, 9], "minimum": 6, "minor": 6, "minvoids": [6, 8, 9], "mkdir": 3, "mm": 6, "model": 6, "modul": 6, "mont": [1, 6], "more": [2, 6, 8], "most": [6, 8, 9], "multipli": 6, "mx": 6, "my_new_featur": 3, "my_numeric_format": 8, "my_opt": 8, "my_set": 8, "my_toler": 8, "name": [3, 4, 6], "need": [3, 4], "new": [3, 4, 6], "new_env": [3, 4], "newsplitplan": [6, 8, 9], "none": [6, 8], "normal": 6, "now": [3, 4], "nplanerevers": [6, 8, 9], "number": 6, "numer": 6, "numeric_format": [6, 8], "numericformat": [1, 6, 8, 9], "o": 3, "object": 6, "ofr": 2, "onc": 6, "one": 6, "onli": [3, 6], "open": [4, 6], "openmc": [1, 6], "openmc_pi": [6, 8, 9], "openmc_xml": [6, 8, 9], "opt": [3, 4], "optim": 6, "option": [1, 2, 3, 4, 6, 8, 9], "order": 6, "org": 3, "origin": 6, "other": 6, "out": 6, "outformat": [6, 8, 9], "output": 6, "overlap": 6, "own": 3, "p": 3, "p_abc": [6, 8, 9], "p_d": [6, 8, 9], "p_xyz": [6, 8, 9], "packag": [1, 2, 3, 7, 9], "parallel": 6, "param": 6, "paramet": 6, "pass": 8, "pdf": 5, "perpendicular": 6, "phit": [1, 6, 8, 9], "pick": 3, "pip": 3, "plane": 6, "pln_angl": [6, 8, 9], "pln_distanc": [6, 8, 9], "point": 6, "popul": 6, "posit": 6, "precis": 6, "prefix": 3, "present": 6, "print": 6, "prnt3pplane": [6, 8, 9], "process": [4, 6], "produc": 6, "prompt": 4, "provid": 2, "public": 5, "pull": 3, "px": 6, "py": [6, 8], "python": [1, 2, 3, 4, 7, 9], "pz": 6, "quadric": 6, "quadricpi": [6, 8, 9], "quicker": [3, 4], "radii": 6, "radiu": 6, "rais": 6, "rang": 6, "read": 6, "real": 6, "recommend": [1, 2], "refer": [1, 8, 9], "reinstal": 3, "rel": 6, "relativeprecis": [6, 8, 9], "relativetol": [6, 8, 9], "releas": [3, 4], "replac": 3, "repo": [3, 4], "repositori": [3, 4], "request": [3, 6], "rest": 6, "return": 6, "root": 3, "rst": 5, "run": [2, 3, 4, 6, 8], "s_r": [6, 8, 9], "s_xyz": [6, 8, 9], "same": [6, 8, 9], "scale": 6, "scaleup": [6, 8, 9], "script": [2, 3, 6, 8], "sdef": 6, "section": [8, 9], "see": [6, 9], "select": 2, "semiangl": 6, "separ": 6, "serpent": [1, 6, 8, 9], "set": [1, 6, 8, 9], "setup": 3, "sever": [2, 5, 6], "sh": 3, "should": 6, "show": [8, 9], "simpli": 8, "simplif": 6, "simplifi": [6, 8, 9], "singl": 6, "size": 6, "slice": 6, "so": [2, 3, 6], "solid": [1, 6, 8], "sort_enclosur": [6, 8, 9], "sourc": [5, 6], "spaceclaim": 6, "specif": 9, "specifi": [6, 8, 9], "sph_distanc": [6, 8, 9], "split": 6, "splitapi": 6, "splittoler": [6, 8, 9], "ssh": 3, "start": [4, 6, 8], "startcel": [6, 8, 9], "startsurf": [6, 8, 9], "stem": 6, "step": [3, 6, 8, 9], "stepfil": [6, 8, 9], "stochast": 6, "stop": 6, "stp": [8, 9], "str": 6, "straight": 3, "subsolid": 6, "success": 2, "suit": 8, "support": 1, "surfac": 6, "sx": 6, "sy": 6, "system": [2, 8], "sz": 6, "t_r": [6, 8, 9], "t_xyz": [6, 8, 9], "tabl": 6, "talli": 6, "tan": 6, "termin": [3, 9], "test": 3, "than": [3, 4], "thi": [2, 3, 6, 8, 9], "threshold": 6, "time": 6, "titl": [6, 8, 9], "todo": [2, 5, 6], "toler": [1, 6, 8, 9], "tood": 0, "tool": [1, 3, 4, 7], "top": 6, "tor_angl": [6, 8, 9], "tor_dist": [6, 8, 9], "toru": 6, "training_on_geouned_tool": 5, "translat": 6, "transport": 1, "tree": 6, "triangular": 6, "true": [6, 8, 9], "tupl": 6, "two": 3, "type": 6, "u": 3, "ucard": [6, 8], "unam": 3, "uncheck": 3, "unclos": 6, "under": 6, "unit": 6, "univers": 6, "up": [3, 6, 8], "us": [1, 2, 3, 4, 6, 7, 8, 9], "usabl": 8, "usag": 1, "user": [1, 2, 6, 8], "user_guide_geouned_v2": 5, "usernam": 3, "util": 6, "valu": [6, 8, 9], "valueerror": 6, "vaniti": 8, "variou": 5, "version": 2, "void": 6, "voidexclud": [6, 8, 9], "voidful": 6, "voidgen": [6, 8, 9], "voidmat": [6, 8, 9], "vol": 6, "volcard": [6, 8, 9], "volsdef": [6, 8, 9], "volum": 6, "wai": [6, 9], "we": [3, 4, 8], "welcom": 3, "well": 2, "wget": 3, "when": [2, 3, 6, 9], "where": 6, "whether": 6, "which": [3, 4, 8], "window": [1, 2], "within": [3, 4], "without": [3, 6], "word": 6, "work": 9, "write": 6, "written": 6, "x": 6, "x2": 6, "x86_64": [3, 4], "xy": 6, "y": 6, "y2": 6, "you": [2, 3, 4, 8, 9], "your": [2, 3, 4, 8, 9], "z": 6, "z2": 6}, "titles": ["Developer guide", "GEOUNED", "Install", "1. Linux", "2. Windows", "Methodology", "Python API reference", "Usage", "1. Python Package Usage", "2. Command Line Tool Usage"], "titleterms": {"api": 6, "command": 9, "conda": [3, 4], "develop": [0, 3], "geoun": 1, "guid": 0, "instal": [2, 3, 4], "line": 9, "linux": 3, "mamba": [3, 4], "methodologi": 5, "packag": 8, "python": [6, 8], "recommend": [3, 4], "refer": 6, "tool": 9, "usag": [7, 8, 9], "user": [3, 4], "window": 4}}) \ No newline at end of file diff --git a/usage/index.html b/usage/index.html new file mode 100644 index 00000000..d4d45324 --- /dev/null +++ b/usage/index.html @@ -0,0 +1,125 @@ + + + + + + + Usage — GEOUNED 1.0.1 documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Usage

+

GEOUNED can be used as a Python package with the API or as a command line tool with the CLI.

+ +
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/usage/python_api_usage.html b/usage/python_api_usage.html new file mode 100644 index 00000000..6cd6d177 --- /dev/null +++ b/usage/python_api_usage.html @@ -0,0 +1,239 @@ + + + + + + + 1. Python Package Usage — GEOUNED 1.0.1 documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Python Package Usage

+

The main class is CadToCsg() which converts CAD geometry to Constructive Solid Geometry (CSG). +There are many arguments that can be passed into the CadToCsg() class which are documented in the Python API reference section of the documentation.

+

If you have install GEOUNED and FreeCAD into your system Python then you can simply run a .py script with Python. +The most minimal use case below shows GEOUNED being imported and the CadToCsg being used to convert a STEP CAD file called ‘cuboid.stp’ into a vanity of CSG format. +The example makes use of default attributes.

+
import geouned
+geo = geouned.CadToCsg(stepFile='cuboid.stp')
+geo.start()
+geo.export_csg()
+
+
+

Users can change geouned.Options(), geouned.Settings(), geouned.Tolerances() and geouned.NumericFormat() to suit the conversion desired. +The following example shows a usage with every attributes specified.

+
import geouned
+
+my_options = geouned.Options(
+    forceCylinder=False,
+    newSplitPlane=True,
+    delLastNumber=False,
+    enlargeBox=2,
+    nPlaneReverse=0,
+    splitTolerance=0,
+    scaleUp=True,
+    quadricPY=False,
+    Facets=False,
+    prnt3PPlane=False,
+    forceNoOverlap=False,
+)
+
+my_settings = geouned.Settings(
+    matFile="",
+    voidGen=True,
+    debug=False,
+    compSolids=True,
+    simplify="no",
+    cellRange=[],
+    exportSolids="",
+    minVoidSize=200.0,
+    maxSurf=50,
+    maxBracket=30,
+    voidMat=[],
+    voidExclude=[],
+    startCell=1,
+    startSurf=1,
+    sort_enclosure=False,
+)
+
+my_tolerances = geouned.Tolerances(
+    relativeTol=False,
+    relativePrecision=0.000001,
+    value=0.000001,
+    distance=0.0001,
+    angle=0.0001,
+    pln_distance=0.0001,
+    pln_angle=0.0001,
+    cyl_distance=0.0001,
+    cyl_angle=0.0001,
+    sph_distance=0.0001,
+    kne_distance=0.0001,
+    kne_angle=0.0001,
+    tor_distance=0.0001,
+    tor_angle=0.0001,
+    min_area=0.01,
+)
+my_numeric_format = geouned.NumericFormat(
+    P_abc="14.7e",
+    P_d="14.7e",
+    P_xyz="14.7e",
+    S_r="14.7e",
+    S_xyz="14.7e",
+    C_r="12f",
+    C_xyz="12f",
+    K_xyz="13.6e",
+    K_tan2="12f",
+    T_r="14.7e",
+    T_xyz="14.7e",
+    GQ_1to6="18.15f",
+    GQ_7to9="18.15f",
+    GQ_10="18.15f",
+)
+
+geo = geouned.CadToCsg(
+    stepFile="cuboid.stp,
+    options=my_options,
+    settings=my_settings,
+    tolerances=my_tolerances,
+    numeric_format=my_numeric_format,
+)
+
+geo.start()
+
+geo.export_csg(
+    title="Converted with GEOUNED",
+    geometryName="csg",
+    outFormat=(
+        "openmc_xml",
+        "openmc_py",
+        "serpent",
+        "phits",
+        "mcnp",
+    ),
+    volSDEF=True,
+    volCARD=False,
+    UCARD=None,
+    dummyMat=True,
+    cellCommentFile=False,
+    cellSummaryFile=False,
+)
+
+
+

You can also load up JSON configuration files from the API. +The JSON file format is also usable with the Geouned Command Line Interface and there are more complete examples of JSON files on that section of the documentation. +For this example we assume you have a JSON file called ‘config.json’ in the same directory as the script.

+
import geouned
+
+geo = geouned.CadToCsg.from_json("config.json")
+geo.start()
+geo.export_csg()
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/usage/python_cli_usage.html b/usage/python_cli_usage.html new file mode 100644 index 00000000..d4175da4 --- /dev/null +++ b/usage/python_cli_usage.html @@ -0,0 +1,218 @@ + + + + + + + 2. Command Line Tool Usage — GEOUNED 1.0.1 documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Command Line Tool Usage

+

GEOUNED can be used in the command line.

+

These examples assumes you have a CAD STEP file in the current working directory of the terminal called “cuboid.stp”

+

The most minimal use case below shows a minimal config.json file being used.

+

First create a JSON file called “config.json” containing the following.

+
{
+    "stepFile": "cuboid.stp"
+}
+
+
+

Then execute the command line interface tool to convert your STEP file to CSG files with the default configuration.

+
geouned_cadtocsg -i config.json
+
+
+

The following example shows a usage with every attributes specified in the config.json file.

+

The contents of the JSON file closely matches the Class arguments and method arguments when using the Python package.

+

For a full description of each keyword see the Python API reference section of the documentation.

+

Here is a complete JSON file specification

+
{
+    "stepFile": "cuboid.stp",
+    "Options": {
+        "forceCylinder": false,
+        "newSplitPlane": true,
+        "delLastNumber": false,
+        "enlargeBox": 2.0,
+        "nPlaneReverse": 0,
+        "splitTolerance": 0.0,
+        "scaleUp": true,
+        "quadricPY": false,
+        "Facets": false,
+        "prnt3PPlane": false,
+        "forceNoOverlap": false
+    },
+    "Tolerances": {
+        "relativeTol": false,
+        "relativePrecision": 1e-06,
+        "value": 1e-06,
+        "distance": 0.0001,
+        "angle": 0.0001,
+        "pln_distance": 0.0001,
+        "pln_angle": 0.0001,
+        "cyl_distance": 0.0001,
+        "cyl_angle": 0.0001,
+        "sph_distance": 0.0001,
+        "kne_distance": 0.0001,
+        "kne_angle": 0.0001,
+        "tor_distance": 0.0001,
+        "tor_angle": 0.0001,
+        "min_area": 0.01
+    },
+    "NumericFormat": {
+        "P_abc": "14.7e",
+        "P_d": "14.7e",
+        "P_xyz": "14.7e",
+        "S_r": "14.7e",
+        "S_xyz": "14.7e",
+        "C_r": "12f",
+        "C_xyz": "12f",
+        "K_xyz": "13.6e",
+        "K_tan2": "12f",
+        "T_r": "14.7e",
+        "T_xyz": "14.7e",
+        "GQ_1to6": "18.15f",
+        "GQ_7to9": "18.15f",
+        "GQ_10": "18.15f"
+    },
+    "Settings": {
+        "matFile": "",
+        "voidGen": true,
+        "debug": false,
+        "compSolids": true,
+        "simplify": "no",
+        "cellRange": [],
+        "exportSolids": "",
+        "minVoidSize": 200.0,
+        "maxSurf": 50,
+        "maxBracket": 30,
+        "voidMat": [],
+        "voidExclude": [],
+        "startCell": 1,
+        "startSurf": 1,
+        "sort_enclosure": false
+    },
+    "export_csg":{
+        "title": "Converted with GEOUNED",
+        "geometryName": "csg",
+        "outFormat": ["openmc_xml", "openmc_py", "serpent", "phits", "mcnp"],
+        "volSDEF": false,
+        "volCARD": true,
+        "dummyMat": false,
+        "cellCommentFile": false,
+        "cellSummaryFile": true
+    }
+}
+
+
+

This is converted in the same way as the minimal JSON config file

+
geouned_cadtocsg -i config.json
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file