brycehenson / laser_freq_meas

measure laser frequency stability with a spectrum analyzer

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Matlab_project_template

Bryce M. Henson, other authors
A template for making a matlab project in git. Core BEC library already included as submodule. Status: Consider inducing a status comment on the top explaining how ready this code is to use in other projects/works. eg This Code is ready for use in other projects. Unit Testing is implemented for most functions. Integration/system testing is not implemented.

About this project

  • what is is trying to accomplish
  • what novel contributions does it make
  • in broad strokes how does it work?

Install

Github does not copy the submodules when you hit the make git with template button. To get arround this

  • make a repo using this template
  • clone this repo with
 git clone --recurse-submodules -j8 https://github.com/brycehenson/laser_freq_meas.git

If you need to update sumbodules at any point

git submodule update --init --recursive --remote --merge

To Do

some steps for working on the project. -[ ] unit tests -[ ] implementation tests -[ ] cool logo -[ ] some figures showing schematicaly how the code operates

Contributions

This project would not have been possible without the many open source tools that it is based on. In no particular order:

About

measure laser frequency stability with a spectrum analyzer

License:GNU General Public License v2.0


Languages

Language:MATLAB 100.0%