From 8a4dd7d56d18edd343a40fc9dc268efeabda121f Mon Sep 17 00:00:00 2001
From: Jameson Graef Rollins <jrollins@finestructure.net>
Date: Wed, 7 Aug 2019 17:23:39 -0700
Subject: [PATCH] update README links to built-in detectors
---
README.md | 17 ++++++++++-------
1 file changed, 10 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
index adf5a057..24f7373d 100644
--- a/README.md
+++ b/README.md
@@ -35,15 +35,15 @@ $ python3 -m gwinc aLIGO
## detector description files
-`pygwinc` can load detector descriptions in different formats: the new
-YAML .yaml format, the original MATLAB gwinc .mat format, or even from
-a MATLAB .m file. `pygwinc` includes .yaml detector descriptions for
-various detectors:
+`pygwinc` can load budget descriptions in different formats: python
+package/module, .yaml YAML file, and MATLAB gwinc .mat or .m files.
-* [aLIGO.yaml](https://git.ligo.org/gwinc/pygwinc/blob/master/gwinc/ifo/aLIGO.yaml)
-* [A+.yaml](https://git.ligo.org/gwinc/pygwinc/blob/master/gwinc/ifo/A+.yaml)
-* [Voyager.yaml](https://git.ligo.org/gwinc/pygwinc/blob/master/gwinc/ifo/Voyager.yaml)
+`pygwinc` includes budgets for various canonical detectors:
+* [aLIGO](https://git.ligo.org/gwinc/pygwinc/blob/master/gwinc/ifo/aLIGO)
+* [A+](https://git.ligo.org/gwinc/pygwinc/blob/master/gwinc/ifo/Aplus)
+* [Voyager](https://git.ligo.org/gwinc/pygwinc/blob/master/gwinc/ifo/Voyager)
+* [Cosmic Explorer](https://git.ligo.org/gwinc/pygwinc/blob/master/gwinc/ifo/aLIGO)
## noise budgets
@@ -56,6 +56,7 @@ import numpy as np
from gwinc import nb
from gwinc import noise
+
class ExcessGas(nb.Noise):
"""Excess gas"""
style = dict(
@@ -67,6 +68,7 @@ class ExcessGas(nb.Noise):
def calc(self):
return noise.residualgas.gas(self.freq, self.ifo)
+
class MeasuredNoise(nb.Noise):
"""My measured noise"""
style = dict(
@@ -82,6 +84,7 @@ class MeasuredNoise(nb.Noise):
def calc(self):
return self.data
+
class MyBudget(nb.Budget):
noises = [
ExcessGas,
--
GitLab