This repository may be downloaded by using a command line interface:
1. installing osfclient
- `conda install osfclient`
- or `pip install osfclient`
2. cloning `osf -p v5kzn clone`
All data analysis and representation was accomplished using `Python 3.5` with a single script `figures.py`. Simulations are also preformed using this script. We use a library called `WrightTools` to aid in data import and representation. In order to execute `figures.py`, `WrightTools` should be installed. This can be accomplished with `conda` or `pip`.
- `conda install WrightTools=2.13.9`
- `pip install WrightTools==2.13.9`
in which the version of `WrightTools` that was used in the workup is installed (newer versions are available).
## Description of data files
There are 3 `.data` files needed to generate the figures in the main text. The `.data` format is the raw format used by our instrumentation software. These files are
* `[w2, w1].data`
* `[w1, w2]_0nm.data`
* `[w1, wm].data`
There are 6 `.data` and 2 `.coset` files used to generate SI figures.
* `Powercurve [w1].data`
* `Powercurve [w2].data`
* `Tunetest [w1].data`
* `Tunetest [w2].data`
* `SDC [w1].data`
* `SDC [w2].data`
* `w1_d2 - 2017-02-23 73369.coset`
* `w2_d1 - 2017-02-23 73337.coset`
`.data` and `.coset` files are plain-text files with headers.
The file `sapphire.csv` contains the refractive index of Sapphire [as referenced in the text] and is required to calculate the phase and group velocities of our electric fields.
## Instructions for figure generation
In order to run our figure generation script, the following ought to be accomplished:
0. Obtain [`Python 3.5`](www.python.org) or later. (see Note 1 at bottom)
1. Obtain the [SciPy software stack](www.scipy.org/install.html). (see Note 1 at bottom)
2. Obtain `WrightTools`. The easiest ways to get the current stable version is to use pip or conda from your command line. `pip install wrighttools` or `conda install wrighttools`. (see Note 2 at bottom)
3. Run the `figures.py` script.
## Notes
1. We find it easiest to use the excellent, free [Anaconda distribution](www.continuum.io/downloads) to get Python and the SciPy stack on our machines.
2. Alternatively, you can download from [GitHub](github.com/wright-group/WrightTools) and ensure that it is located in your PYTHONPATH. This folder should be downloaded and then the user should run `python setup.py install` while in the same directory as the WrightTools `setup.py` script.
