precomp decorator support

Precomp functions are specified with the @nb.precomp decorator to BudgetItem.calc() methods. The are supplied with the freq array and the ifo struct, their output are supplied as keyword arguments to the wrapped calc(), and their output is cached to prevent re-calculating the same functions multiple time per budget run.

added 3 commits

• a52b1d06...83625807 - 2 commits from branch gwinc:master
• 97afd5d6 - precomp support

Compare with previous version

I like this a lot. It will make the quantum noise sub-budget MR !94 (merged) simpler and the suspension thermal noise sub-budgets that I'm working on considerably simpler. It also prevents all of the current coating and substrate thermal noise calculations from calling their precomp's over each time one of them is called.

If I understand correctly, all of the precomp functions should be of the form

def precomp(f, ifo):
    ...

I think this is fine and can't think of a reason why this would be an issue.

Yes that's correct, precomp(freq, ifo), with the expectation that they modify the ifo Struct. I'm not a huge fan of passing around data this way, but it's certainly easy.

I really like this change, but I think there's a bug when using the update method of the nb.Noise class. Something to be addressed after all the API changes.

The following

class MeasuredNoise(nb.Noise):
    def update(self, fname='data.txt'):
        ff, asd = np.loadtxt(fname)
        self.data = self.interpolate(ff, asd**2)

    def calc(self):
        return self.data

class MyBudget(nb.Budget):
    noises = [
        QuantumVacuum,
        MeasuredNoise
    ]

    calibrations = [
        Strain,
    ]

works on master but gives the error

TypeError: update() got an unexpected keyword argument '_precomp'

here. It works if the data is loaded with the load method without the keyword argument instead.

added 17 commits

• 97afd5d6...94f24df2 - 13 commits from branch gwinc:master
• e6b933f6 - API change: Budget/Noise calculations return BudgetTrace object
• 066f849b - precomp decorator support
• da92dde8 - ifo hash and Noise.run() opportunistically run update()
• ac747cd4 - Noise.run() opportunistically call load()

Compare with previous version

changed title from precomp support to precomp decorator support

changed the description

added 4 commits

• 49925538 - API change: Budget/Noise calculations return BudgetTrace object
• f6226235 - precomp decorator support
• a4a07683 - ifo hash and Noise.run() opportunistically run update()
• 26abe907 - Noise.run() opportunistically call load()

Compare with previous version

approved this merge request

added 4 commits

• c99bf6b6 - API change: Budget/Noise calculations return BudgetTrace object
• a51a2f84 - precomp decorator support
• 94b05bf3 - ifo hash and Noise.run() opportunistically run update()
• 49ee02f9 - Noise.run() opportunistically call load()

Compare with previous version

added 7 commits

• 49ee02f9...6348af30 - 3 commits from branch gwinc:master
• e56766a1 - API change: Budget/Noise calculations return BudgetTrace object
• af2cd1e5 - precomp decorator support
• 97950a2a - ifo hash and Noise.run() opportunistically run update()
• f93fa168 - Noise.run() opportunistically call load()

Compare with previous version

added 4 commits

• 680e1bfb - API change: Budget/Noise calculations return BudgetTrace object
• 623c36b3 - precomp decorator support
• 07a281ec - ifo hash and Noise.run() opportunistically run update()
• 6c0e5d45 - Noise.run() opportunistically call load()

Compare with previous version

added 4 commits

• a1aeafbb - API change: Budget/Noise calculations return BudgetTrace object
• fea5b0bd - precomp decorator support
• c2b526ce - ifo hash and Noise.run() opportunistically run update()
• 72d32f32 - Noise.run() opportunistically call load()

Compare with previous version

approved this merge request

mentioned in merge request !100 (closed)

added 6 commits

• 72d32f32...4a0c13b3 - 2 commits from branch gwinc:master
• 51158ce4 - API change: Budget/Noise calculations return BudgetTrace object
• 3b24efc3 - precomp decorator support
• f5279568 - ifo hash and Noise.run() opportunistically run update()
• 1e619807 - Noise.run() opportunistically call load()

Compare with previous version

approved this merge request

added 4 commits

• 77cd32f8 - 1 commit from branch gwinc:master
• dc1d71b1 - precomp decorator support
• 73cc9a5e - ifo hash and Noise.run() opportunistically run update()
• 88db740b - Noise.run() opportunistically call load()

Compare with previous version

added 4 commits

• 864a4011 - first pass at mapping-based precompute
• f1012ee6 - added caching of non-mapped precomp
• 36f133e5 - coverted QuantumVacuum to use PWR struct precomp
• e2b5128c - cleanup mapped precomp

Compare with previous version

changed the description

With @lee-mcculler's help, this new version provides mapped output for the precomp functions so that they don't need to modify the ifo struct, which is much cleaner. I'm pretty happy with this version.

Some of the noise calculation function argument signatures did need to be modified, though, to accept extra arguments. Small price to pay it seem, though...

I think this is a very small "price" to pay and am also a fan of not modifying the ifo struct. Seems like a good solution.