Skip to content

Latest commit

 

History

81 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sagnac

Matlab programs for Sagnac experiment.

Requirements:

Implemented packages and classes:

  • Drivers: GPIB/visa and Serial interfaces for laboratory instruments such
    • Agilent 33220A
    • Keithley 2XXX
    • LakeShore 3XX
    • Stanford Research 8XX
    • Agilis piezo stage
    • and others...
  • Recorder: Universal data acquisition class.
  • make: helper functions for Recorder class.
  • plot: Data plotting functions.
  • util: data analysis/modification helper functions.

Applications:

  • slicer: GUI to browse 2D data such as frequency-amplitude modulation scans and plot 1D slices.


Code style convention

I'm planning to clean all code here to satisfy following styling style guide

Variables

Snake case (lowercase with underscore) is preferred.
Short and non-descriptive names are preferred over extremely long names. CamelCase is discouraged.

Good examples:

  • filename
  • num_words
  • i (dummy variable in a for loop)

Bad examples:

  • numWords
  • letter_index_in_target_words

Functions

Function have the same naming convetion as variables.
CamelCase is not used, underscores are allowed to separate words, but not required.
Namespaces (packages) are encouraged, see this.
Here is a list of MATLAB built-in functions.

Good examples:

  • combine
  • beamspotsize
  • beam_spot_size (less preferred)
  • calc.spotsize (namespace '+calc' is used)
  • seed2key

Bad examples:

  • beamSpotSize
  • Beamspotsize

Classes

Starts with capital letter, CamelCase is used for readibility.

Good examples:

  • Recorder
  • MyClass

Bad examples:

  • recorder
  • my_class
  • myClass

About

Matlab programs for Sagnac experiment

Topics

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages