gf

gf is the command line tool for gdsfactory. It helps you work with GDS files.

gf [OPTIONS] COMMAND [ARGS]...

Options

--version

Show the version number.

gds

Commands for dealing with GDS files.

gf gds [OPTIONS] COMMAND [ARGS]...

diff

Show boolean difference between two GDS files.

gf gds diff [OPTIONS] GDSPATH1 GDSPATH2

Options

-x, --xor

include xor

Arguments

GDSPATH1

Required argument

GDSPATH2

Required argument

layermap_to_dataclass

Converts klayout LYP to a dataclass

gf gds layermap_to_dataclass [OPTIONS] FILEPATH

Options

-f, --force

Force deletion

Arguments

FILEPATH

Required argument

merge_gds_from_directory

Merges GDS cells from a directory into a single GDS.

gf gds merge_gds_from_directory [OPTIONS] [DIRPATH] [GDSPATH]

Arguments

DIRPATH

Optional argument

GDSPATH

Optional argument

show

Show a GDS file using klive

gf gds show [OPTIONS] FILENAME

Arguments

FILENAME

Required argument

write_cells

Write each all level cells into separate GDS files.

gf gds write_cells [OPTIONS] GDSPATH

Arguments

GDSPATH

Required argument

mask

Commands for building masks

gf mask [OPTIONS] COMMAND [ARGS]...

build_devices

Build all devices described in devices/

gf mask build_devices [OPTIONS] [REGEX]

Arguments

REGEX

Optional argument

build_does

Build does defined in doe.yml

gf mask build_does [OPTIONS] YAMLPATH

Arguments

YAMLPATH

Required argument

clean

Deletes the build folder and contents

gf mask clean [OPTIONS]

Options

-f, --force

Force deletion

write_labels

Find test and measurement labels.

gf mask write_labels [OPTIONS] GDSPATH [LABEL_LAYER]...

Arguments

GDSPATH

Required argument

LABEL_LAYER

Optional argument(s)

write_metadata

merge JSON/Markdown from build/devices into build/mask

gf mask write_metadata [OPTIONS] [LABEL_LAYER]...

Arguments

LABEL_LAYER

Optional argument(s)

tool

Commands working with gdsfactory tool

gf tool [OPTIONS] COMMAND [ARGS]...

config

Shows key values from CONFIG

gf tool config [OPTIONS] [KEY]

Arguments

KEY

Optional argument

install

Install Klive and generic tech layermap.

gf tool install [OPTIONS]

test

Run tests using pytest. You can also just run pytest directly.

gf tool test [OPTIONS]