ele559-simulations

Workshop on photonic device and circuit simulation using open-source tools. Created for Princeton's Spring 2020 ELE559 : Photonic Systems class.

https://github.com/simbilod/ele559-simulations

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (13.8%) to scientific vocabulary

Last synced: 10 months ago · JSON representation ·

Repository

Workshop on photonic device and circuit simulation using open-source tools. Created for Princeton's Spring 2020 ELE559 : Photonic Systems class.

Basic Info

Host: GitHub
Owner: simbilod
License: gpl-3.0
Language: Jupyter Notebook
Default Branch: master
Size: 28.6 MB

Statistics

Stars: 39
Watchers: 4
Forks: 14
Open Issues: 0
Releases: 0

Created over 6 years ago · Last pushed almost 5 years ago

Metadata Files

Readme License Citation

ELE559-simulations

Workshop on photonic device and circuit simulation using open-source tools. Originally created for Princeton's Spring 2020 ELE559 : Photonic Systems class.

Log in to Adroit

https://myadroit.princeton.edu/ Requesting access (Princeton students) : https://researchcomputing.princeton.edu/access

Checkout environment

Navigate to the shell

checkout

Run this command :

git clone https://github.com/simbilod/ELE559-simulations clone

Start up the Jupyter server

Under "My interactive sessions", click on Jupyter for classes :

jupyterlab

Optionally, check the box for Jupyter Lab. Fill in your requested time and cores (be considerate to other users). Then click launch. When the environment is ready, launch it.

jupyterlab

Opening a Notebook

You will see an interface like this :

interface

You should see multiple Python environments when you log in (mp, pmp, layout, etc.). Make sure you select the "mp" environments when you boot the Notebooks. You can change what environment you are running on by clicking the text besides the dot on the top right :

env

Using a Notebook

Execute a cell by pressing shift+enter. The output will be displayed right underneath. The added text should provide enough context to follow!

More on Jupyter Notebooks : https://www.dataquest.io/blog/jupyter-notebook-tutorial/

Manually making an environment visible

Jupyter should auto-detect the environments, but if for some reason it does not you can manually add them.

Go to the shell (see "Checkout environment") and type

conda info --envs to list the environments. Activate the environment you want to add by typing conda activate environment_name Then link the environment "environmentname" to your Jupyter kernel with label "myenvironmentname" by running ``` python -m ipykernel install --user --name=myenvironment_name ``` You should get the following response : add_env Restart the Jupyter for Classes server and you should see the environment under the name you assigned.

Accessing KLayout GUI from the myAdroit Desktop

To see the GDS files you have designed on the server itself, you can use the preinstalled KLayout on the Desktop app.

First, (optionally) create an alias to open KLayout in your .bashrc. In the shell (see "Checkout environment") type

cd nano .bashrc and add the lines ```

ELE559 initialization script

source /home/ELE559/ELE559.bashrc Then, open the desktop app like you would a Jupyter for Classes session. Open a terminal and typeklayout``` (or full link from the alias) to open the program.

desktop_klayout

Acknowledgements

This material is based in part upon work supported by the National Science Foundation under Grant Number E2CDA-1740262. Any opinions, findings, and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the National Science Foundation.

Owner

Name: Simon Bilodeau
Login: simbilod
Kind: user

Repositories: 8
Profile: https://github.com/simbilod

PhD student @ Lightwave Lab, Princeton University // Resident @ X (formerly Google X)

Citation (CITATION.cff)

# YAML 1.2
---
abstract: " Workshop on photonic device and circuit simulation using open-source tools. Originally created for Princeton's Spring 2020 ELE559 : Photonic Systems class. "
authors: 
  -
    family-names: Bilodeau
    given-names: Simon
  -
    family-names: "Ferreira de Lima"
    given-names: Thomas
  -
    family-names: Lederman
    given-names: Josh
cff-version: "1.1.0"
date-released: 2021-03-19
license: "GPL-3.0"
message: "If you use this software, please cite it using these metadata."
repository-code: "https://github.com/simbilod/ELE559-simulations"
title: "ELE559-simulations"
version: "0.2"
...

GitHub Events

Total

Watch event: 6
Fork event: 1

Last Year

Watch event: 6
Fork event: 1

Issues and Pull Requests

Last synced: over 1 year ago

All Time

Total issues: 0
Total pull requests: 4
Average time to close issues: N/A
Average time to close pull requests: 2 minutes
Total issue authors: 0
Total pull request authors: 2
Average comments per issue: 0
Average comments per pull request: 0.0
Merged pull requests: 3
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science