opics 0.3.3

Installing from pypi

The easiest way to install OPICS is using pip pypi:

pip install opics

Installing from source

Download the OPICS source code.

git clone https://github.com/jaspreetj/opics

Install the OPICS package using pip.

pip install -e ./opics

Once the package is installed, it can be imported using:

import opics as op

Listing available libraries

The package does not come with any component libraries pre-installed. You can select and download available libraries from the library catalogue.

library_catalogue = op.libraries.library_catalogue

print(f"Available Libraries: {[_ for _ in library_catalogue.keys()]} ")

Downloading libraries

The OPICS libraries are downloaded by passing in library_name, library_url, and library_path to the libraries.download_library module. The module returns True if the library is downloaded successfully.

import os
installation_path = os.path.join(os.path.join(os.environ['USERPROFILE']), 'Desktop\\delete')

op.libraries.download_library("ebeam",  installation_path)

# reload libraries
import importlib
importlib.reload(op.libraries)

List installed libraries

op.libraries.installed_libraries

List library components

op.libraries.ebeam.components_list

Remove libraries

Any of the installed libraries can be removed using the libraries.remove_library module.

op.libraries.remove_library("ebeam")

importlib.reload(op.libraries)

print(op.libraries.installed_libraries)

#reinstall ebeam library
op.libraries.download_library(
    library_name="ebeam",
    library_path=installation_path,
)

importlib.reload(op.libraries)

print(op.libraries.installed_libraries)

Library components

Let’s take a look at the library components.

ebeam_lib = op.libraries.ebeam

Listing library components

ebeam_lib.components_list

Let’s take a look inside a component for more information on its parameters and layout, such as port locations.

ebeam_lib.BDC?