This is needed for the test script, where setuptools_scm doesn't work

Version support

Closes #59

See merge request !99

using setuptools_scm

Quantum noise sub-budgets

Closes #20

See merge request !94

Kevin Kuns authored 4 years ago and Jameson Rollins committed 4 years ago

Quantum noise now broken up into:
* AS Port Vacuum
* Arm Loss
* SRC Loss
* Filter Cavity Loss
* Injection Loss
* Readout Loss

CTN: drop amplitude noise and fix docstring

See merge request !108

Brownian amplitude noise is generally quite negligible, so the
CoatingBrownian budget item no longer considers it.  The calculation
remains available in coating_brownian().

Update FC parameter optimization

See merge request !104

Kevin Kuns authored 4 years ago and Jameson Rollins committed 4 years ago

- Updated the filter cavity optimization to work with the recent precomp changes
- Removed a redundant argument in computeFCParams

default frequency array for load_budget()

See merge request !106

This specifies a default frequency array for load_budget and the CLI, and makes it easier to provide alternative arrays with a frequency "specification string" (e.g. '5:1000:3000').

noises.py: clean up helper functions

See merge request !107

- merge coating_thickness into mirror_struct
- merge precomp_mirror into mirror_struct
- merge precomp_power into ifo_power
- merge precomp_cavity into arm_cavity

precomp is no longer used for these helpers, but they're sufficiently
trivial that it doesn't matter whether they are cached.

closes #56

fixes bug where overall budget name was used instead.

This fixes a bug whereby references traces were being included in the sum
total.

This prevents buggy behavior if an ifo is not provided.

This function is useful, so no reason to hide it.

closes #72

cache precomp data between runs

See merge request !103

those variables will be considered internal.

This prevents the precomp data from being re-calculated if the ifo
hasn't changed.

introduce Mirror struct for mirror thermal calculations

See merge request !102

precomp decorator support

See merge request !95

This struct is created by the precomp_mirror function, and is essentially
the union of the Material and Optic structs, holding all relevant
properties for a given optic for thermal noise calculations.  It can be
used in place of either the Material or Optic structs.

Coating thermal noise functions are modified to accept this struct.

This is some cleanup and simplification of Lee's mapped precomp
series.

cache the load status

Add a Struct.hash() method to return a unique hash over attributes.

Modify Noise.run() method to check for changes to the ifo and only run
the update method if the ifo has changed or other kwargs are supplied.

nb.precomp decorator can be used to wrap BudgetItem.calc methods with
functions that only need to be called once per budget run.

    nb.precomp(precomp_foo)
    def calc(self):
        ...

Precomp functions are all executed by the update() method (after attribute
update), and execution state is cached at the Budget level, to prevent
re-calculating the same functions multiple times per update.

The BudgetItem.update() method is no longer expected to be overloaded by
the user.

This provides a speed-up of about 50% for the Aplus model, but much less
for the CE models which are limited by other noise calculations.

API change: Budget/Noise calculations return BudgetTrace object

Closes #59

See merge request !98

This new object holds the PSD and frequency arrays, as well as the
list of all budget sub-noises, accessible via a dictionary interface
and attribute access.

All interfaces and tests are updated to process the new BudgetTrace
object.

A new HDF5 schemata (version 2) is also introduced that stores trace
data in a way that mirrors the BudgetTrace.  The io functions
(save_hdf5/load_hdf5) are updated to write/read this format.  The
load_hdf5 functions continues to support the version 1 SCHEMA.

Closes #59

remove reference to unused BeamRadius parameter in ifo.yamls

Closes #3

See merge request !101

We don't want to advertise these parameters yet, since they will
likely be changed to support different loss functions.

Adding Hong et al. calculations for Coating Brownian Noise

See merge request !52

Anchal Gupta authored 4 years ago and Jameson Rollins committed 4 years ago

Modified getCoatBrownian() to accept different Bulk and Shear Loss
Angles and calculate brownian noise using Hong et a. PRD 87, 082001
(2013).

New Function description:
This function calculates Coating ThermoOptic noise using
Hong et al . PRD 87, 082001 (2013).
All references to 'the paper', 'Eq' adn 'Sec' are to this paper.

***Important Note***
Inside this function phi is used for denoting the phase shift suffered
by light in one way propagation through a layer. This is in conflict
with present nomenclature everywhere else where it is used as loss
angle.

The layers are assumed to be alernating low-n high-n layers, with
low-n first.
Inputs:
         f = frequency vector in Hz
       ifo = parameter struct from IFOmodel.m
     wBeam = beam radius (at 1 / e^2 power)
      dOpt = the optical thickness, normalized by lambda, of each
             coating layer.
New required arguments:
       mTi = Mirror Transmittance
        Ic = Circulating Laser Power falling on the Mirror (W)
The following new arguments should be made available in the Materials
object and lines 108-110 and 116-118 should be uncommented:
 lossBlown = Coating Bulk Loss Angle of Low Refractive Index layer
 lossSlown = Coating Shear Loss Angle of Low Refractive Index layer
lossBhighn = Coating Bulk Loss Angle of High Refractive Index layer
lossShighn = Coating Shear Loss Angle of High Refractive Index layer
   PETlown = Relevant component of Photoelastic Tensor of High n layer*
  PEThighn = Relevant component of Photoelastic Tensor of Low n layer*
Returns:
SbrZ = Brownian noise spectra for one mirror in m^2 / Hz

*
Default values of PETlown and PEThighn are chosen from sec. A.1. to get
the longitudnal coefficent of photoelasticity as -0.5 as been asserted
by the paper there for Tantala and -0.27 for Silica.
These values also need to be added in Materials object.