Install

To use Imodulator, simply install via pip:

(.venv) $ pip install imodulator

Alternatively you can close the repository and install it locally:

(.venv) $ git clone https://github.com/yourusername/imodulator.git
(.venv) $ cd imodulator
(.venv) $ pip install .

For development purposes, you can install the package in “editable” mode:

(.venv) $ git clone https://github.com/yourusername/imodulator.git
(.venv) $ cd imodulator
(.venv) $ pip install -e .

If you plan to use the ChargeSimmulatorNN or the OpticalSimulatorMODE, you must provide some more information relative to the licences and the paths to the api’s. To do so, you must go to imodulator/src/config_template.yaml and create a copy named config.yaml where you fill in the required information. Namely:

lumerical_api:
   path: "path to lumapi python package lumapi.py"

nextnano:
   nextnano++:
      exe: "path to nextnano++ executable"
      license: "path to nextnano++ license file"
      database: "path to nextnano++ database file"
      output: "path to nextnano++ output folder"