Skip to content

Commit

Permalink
update markdown docs
Browse files Browse the repository at this point in the history
  • Loading branch information
oskooi committed Feb 2, 2022
1 parent c0f4760 commit 75758d9
Showing 1 changed file with 34 additions and 34 deletions.
68 changes: 34 additions & 34 deletions doc/docs/Python_User_Interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -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):
```

<div class="method_docstring" markdown="1">
Expand Down

0 comments on commit 75758d9

Please sign in to comment.