From 75758d9f7b55a1b4d3bd0b799fcc2ab5f7198777 Mon Sep 17 00:00:00 2001 From: Ardavan Oskooi Date: Wed, 2 Feb 2022 05:52:14 +0000 Subject: [PATCH] update markdown docs --- doc/docs/Python_User_Interface.md | 68 +++++++++++++++---------------- 1 file changed, 34 insertions(+), 34 deletions(-) diff --git a/doc/docs/Python_User_Interface.md b/doc/docs/Python_User_Interface.md index 69dd01938..4cc513a75 100644 --- a/doc/docs/Python_User_Interface.md +++ b/doc/docs/Python_User_Interface.md @@ -87,40 +87,40 @@ control various parameters of the Meep computation. ```python def __init__(self, - cell_size: 'Optional[Vector3Type]' = None, - resolution: 'float' = None, - geometry: 'Optional[List[GeometricObject]]' = None, - sources: 'Optional[List[Source]]' = None, - eps_averaging: 'bool' = True, - dimensions: 'int' = 3, - boundary_layers: 'Optional[List[PML]]' = None, - symmetries: 'Optional[List[Symmetry]]' = None, - force_complex_fields: 'bool' = False, - default_material: 'Medium' = Medium(), - m: 'float' = 0, - k_point: 'Union[Vector3Type, bool]' = False, - kz_2d: 'str' = 'complex', - extra_materials: 'Optional[List[Medium]]' = None, - material_function: 'Optional[Callable[[Vector3Type], Medium]]' = None, - epsilon_func: 'Optional[Callable[[Vector3Type], float]]' = None, - epsilon_input_file: 'str' = '', - progress_interval: 'float' = 4, - subpixel_tol: 'float' = 0.0001, - subpixel_maxeval: 'int' = 100000, - loop_tile_base_db: 'int' = 0, - loop_tile_base_eh: 'int' = 0, - ensure_periodicity: 'bool' = True, - num_chunks: 'int' = 0, - Courant: 'float' = 0.5, - accurate_fields_near_cylorigin: 'bool' = False, - filename_prefix: 'Optional[str]' = None, - output_volume: 'Optional[Volume]' = None, - output_single_precision: 'bool' = False, - geometry_center: 'Vector3Type' = Vector3<0.0, 0.0, 0.0>, - force_all_components: 'bool' = False, - split_chunks_evenly: 'bool' = True, - chunk_layout: 'Optional[str, Simulation, BinaryPartition]' = None, - collect_stats: 'bool' = False): + cell_size: Union[meep.geom.Vector3, Tuple[float, ...], Tuple[int, ...], NoneType] = None, + resolution: float = None, + geometry: Optional[List[meep.geom.GeometricObject]] = None, + sources: Optional[List[meep.source.Source]] = None, + eps_averaging: bool = True, + dimensions: int = 3, + boundary_layers: Optional[List[meep.simulation.PML]] = None, + symmetries: Optional[List[meep.simulation.Symmetry]] = None, + force_complex_fields: bool = False, + default_material: meep.geom.Medium = Medium(), + m: float = 0, + k_point: Union[meep.geom.Vector3, Tuple[float, ...], Tuple[int, ...], bool] = False, + kz_2d: str = 'complex', + extra_materials: Optional[List[meep.geom.Medium]] = None, + material_function: Optional[Callable[[Union[meep.geom.Vector3, Tuple[float, ...], Tuple[int, ...]]], meep.geom.Medium]] = None, + epsilon_func: Optional[Callable[[Union[meep.geom.Vector3, Tuple[float, ...], Tuple[int, ...]]], float]] = None, + epsilon_input_file: str = '', + progress_interval: float = 4, + subpixel_tol: float = 0.0001, + subpixel_maxeval: int = 100000, + loop_tile_base_db: int = 0, + loop_tile_base_eh: int = 0, + ensure_periodicity: bool = True, + num_chunks: int = 0, + Courant: float = 0.5, + accurate_fields_near_cylorigin: bool = False, + filename_prefix: Optional[str] = None, + output_volume: Optional[meep.simulation.Volume] = None, + output_single_precision: bool = False, + geometry_center: Union[meep.geom.Vector3, Tuple[float, ...], Tuple[int, ...]] = Vector3<0.0, 0.0, 0.0>, + force_all_components: bool = False, + split_chunks_evenly: bool = True, + chunk_layout=None, + collect_stats: bool = False): ```