This repository contains scripts developed to find the optimal parameters for a chosen non-linear crystal and optical cavity geometry. Please note that this repository does not include the literature review or theoretical background; it is solely focused on the practical aspect of parameter optimization.
Required python >= 3.8
and pip
pip install -r requirements.txt
If you are using Pycharm follow these simple steps:
- On GitHub, click the button <> Code and copy the link
- On Pycharm, go to
Git > Clone
- Paste the url of the GitHub repository you just copied and click clone.
- You can now access the files. The GUI should automatically ask you if you want to download the requirements
Tutorial was found at this link.
You need to open a system terminal, go to the directory you want to clone and do git clone your-repo-here.git
, then you
can open Spyder and either create a new project in the directory where you cloned your repository, or just open in the
files pane the directory where you cloned the repository
To sync your folder you need to use git commands, https://education.github.com/git-cheat-sheet-education.pdf, normally you will have two most use cases that are syncing with your remote repo and publishing your changes to the remote repo. This has to be done in a system terminal as well.
- Exploring changes:
git fetch
- Sync remote changes to local repository:
git pull
- To publish changes, first create a commit with a description and then publish them:
git add -A
git commit -m "Description of the changes"
git push
cavity\
: Contains calculations from ray-optics/gaussian beam. The goal is to find the waist for a given cavity geometry;squeezing\
: Contains scripts related to the prediction of squeezing generated by an Optical Parametric Oscillator(OPO);utils\
: Various utility functions for plot, settings, logger, etc.
All the settings and grouped up in a single file called settings.yaml
. If this file is missing, create one at the
root of the repository. Below is an example:
# Plot parameter
number_points: 2000
waist_vs: 'dc'
cmap_name: 'gray'
alpha: 0.8
plot_bandwidth: False
plot_waist: True
plot_pump_power: False
squeezing_wavelength: False
plot_threshold: False
plug_value: False
# Wavelength
wavelength: 780e-9
# Cavity parameters
fixed_length: 500e-3
fixed_d_curved: 190e-3
min_L: 200e-3
max_L: 900e-3
cavity_loss: 0.03
d_curved_min: 50e-3
d_curved_max: 200e-3
# Transmission coefficients
min_T: 0.
max_T: 0.3
R: 50e-3
# Bandwidth
central_freq: 10.0e6
range_freq: 0.1
# Crystal parameters
crystal_length: 10e-3
crystal_index: 1.84 # PPKTP refraction index
# Squeezing parameters
omega_c: 10000000.0 # bandwidth of the cavity
threshold: 1.0
To run any scripts related to cavity optimization, make sure you set at least one parameter among:
plot_bandwidth
plot_waist
plot_pump_power
squeezing_wavelength
plot_threshold
is set to True
. Then simply execute run.py
.
In Pycharm, make sure in the configuration
that the project directory is set to the root of the repository, otherwise utils\settings.py
will not be able to load
the yaml
file containing new settings and will return an empty settings object. Uncomment the debugging line in
utils\settings.py
to check if the settings file is correctly loaded. Sometimes, when importing the settings in a script,
but running in the wrong directory, the parameters will be set to default as the yaml
file was not found.