Build
build
CLI interface for kfactory.
Use kf --help for more info.
build
build(
build_ref: Annotated[
str,
Argument(
default=...,
help="The file|module|function to execute:\nAccepted Formats:\n- /path/to/file.py::cell_function_name\n- module.submodule::cell_function_name\n- /path/to/file.py\n- module.submodule",
),
],
func_kwargs: Annotated[
list[str] | None,
Argument(
help="Arguments used for --type function. Doesn't have any influence for other types"
),
] = None,
show: Annotated[
bool,
Option(
help="Show the file through klive in KLayout"
),
] = True,
library: Annotated[
list[str] | None,
Option(
help="Library(s) used by the main layout file. Only works for functions, not for '__main__' modules"
),
] = None,
out_dir: Annotated[
Path | None,
Option(
--out - dir,
-o,
help="Output directory for written layouts. Defaults to build/mask.",
),
] = None,
suffix: Annotated[
LayoutSuffix,
Option(help="Format of the layout files"),
] = LayoutSuffix.oas,
write_full: Annotated[
bool,
Option(
help="Write the gds with full library support. Uses libraries passed with --library. Only works in function mode not on modules"
),
] = True,
write_static: Annotated[
bool,
Option(
help="Write a layout where all cells are converted to static (non-library) cells."
),
] = False,
write_nocontext: Annotated[
bool,
Option(
help="Write the layout without any meta infos. This is useful for submitting the GDS to fabs."
),
] = False,
max_vertex_count: Annotated[
int,
Option(
help="Maximum number of vertices per polygon."
),
] = 4000,
max_cellname_length: Annotated[
int,
Option(
help="Maximum number of characters in a cell name."
),
] = 99,
) -> None
Run a python modules main or a function if specified.
Source code in kfactory/cli/build.py
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 | |
show
show(file: Path) -> None
Show a GDS or OAS file in KLayout through klive.
Source code in kfactory/cli/build.py
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 | |