franc.evaluation.newtonian_noise_simulation

Created on Tue Jan 27 12:45:15 2026

@author: schillings

Attributes

`total_start_time`
`pi`
`G`

Classes

`ReadData`	Imports an output file from the Newtonian noise simulation and stores it as a dictionary
`NewtonianNoiseDataGenerator`	Manages and generates Newtonian noise event- and dataSets.

Module Contents

franc.evaluation.newtonian_noise_simulation.total_start_time

franc.evaluation.newtonian_noise_simulation.pi

franc.evaluation.newtonian_noise_simulation.G

class franc.evaluation.newtonian_noise_simulation.ReadData(tag, folder, fileType='settingFile')

Imports an output file from the Newtonian noise simulation and stores it as a dictionary: The output file is typically named folder + “/” + fileType + tag + “.txt”

Parameters:

tag – the tag used for generating the eventSet or dataSet
folder – the path where the file is
fileType – identifier of the file

tag = ''

folder = ''

fileType = ''

dictionary: dict

class franc.evaluation.newtonian_noise_simulation.NewtonianNoiseDataGenerator(ID=5, tag='X', folder='testset/dataset', saveas='testset/resultFile', useGPU=False, randomSeed=1, isMonochromatic=False, NoR=10, M=211, rho=3000, c_p=6000, L=6000, Nx=200, xmax=6000, tmax=None, Nt=200, depth=6000, cavity_r=5, mirror_positions=None, mirror_directions=None, point_source_positions=None, Awavemin=1e-11, Awavemax=1e-11, fmin=1, fmax=10, fmono=1, sigmafmin=0.5, sigmafmax=1, anisotropy='none', state=None, NoS=4, freq=10, SNR=10000000000.0, p=1, c_ratio=2 / 3, NoW=10, NoT=1, NoE=1, time_window_multiplier=1, twindow=None, randomlyPlaced=False)

Manages and generates Newtonian noise event- and dataSets. A dataSet is an abitrary combination of the bare eventSet. It generates 3D displacement witness channels and a Newtonian-noise force target channel.

# ~~~~~~~~~~~~~~Save management~~~~~~~~~~~~~~# :param ID=5: int(argv[1]) :param tag=”X”: dataSet identifier :param folder=”testset/dataset”: dataSet path :param saveas=”testset/resultFile”: Identifier for all savefiles produced # ~~~~~~~~~~~~~~General~~~~~~~~~~~~~~# :param useGPU=False: Set True if you have and want to use GPU-resources :param randomSeed=1: If None, use no seed :param isMonochromatic=False: Toggles between monochromatic and Gaussian plane wave packets :param NoR=10: Number of runs/realizations/wave events # ~~~~~~~~~~~~~~Constants~~~~~~~~~~~~~~# :param M=211: Mirror mass of LF-ET in kg :param rho=3000: Density of rock in kg/m³ :param c_p=6000: Sound velocity of rock #6000 m/s # ~~~~~~~~~~~~~~Domain~~~~~~~~~~~~~~# :param L=6000: Length of simulation box in m :param Nx=200: Number of spatial steps for force calculation, choose even number :param xmax=6000: Distance of wave starting point from 0 :param tmax=None: Time of simulation in s :param Nt=200: Number of time steps # ~~~~~~~~~~~~~~Experiment config~~~~~~~~~~~~~~# :param depth=6000: Upper domain cutoff (=L for full space) :param cavity_r=5: Radius of spherical cavern in m :param mirror_positions=[[0, 0, 0]]: Array of mirror position [x,y,z] in m :param mirror_directions=[[1, 0, 0]]: Array of mirror free moving axis unit vectors :param point_source_positions=[[-1000, -1000, 0]]: Array of point source position [x,y,z] in m # ~~~~~~~~~~~~~~Event parameters~~~~~~~~~~~~~~# :param Awavemin=1e-11: Minimum amplitude of delta_rho/rho :param Awavemax=1e-11: Maximum amplitude of delta_rho/rho :param fmin=1: Minimum frequency of seismic wave in Hz :param fmax=10: Maximum frequency of seismic wave in Hz :param fmono=1: The frequency of all monochromatic plane waves in Hz :param sigmafmin=0.5: Minimum width of frequency of Gaussian wave-packet in Hz :param sigmafmax=1: Maximum width of frequency of Gaussian wave-packet in Hz :param anisotropy=”none”: “none” for isotropy,

“quad” for more waves from above, “left” for only waves from -x, “p000”-“p100” for 0%-100% point source contribution

# ~~~~~~~~~~~~~~Dataset Parameters~~~~~~~~~~~~~~# :param state=[

[400, 350, 0], [-250, 250, 0], [200, -250, 0], [-100, -100, 0],

]: Seismometer positions :param NoS=4: Number of Seismometers :param freq=10: Frequency of the Wiener filter in Hz :param SNR=1e10: SNR as defined in earlier optimization attempts :param p=1: Ratio of P- and S-waves :param c_ratio=2/3: Ratio c_s/c_p # ~~~~~~~~~~~~~~Window Parameters~~~~~~~~~~~~~~# :param NoW=10: Number of total time windows :param NoT=1: Number of runs without update of WF (test) :param NoE=1: Number of wave events per time window :param time_window_multiplier=1: Time length of a time window to be evaluated in units of t_max :param twindow=None: Overwrites window length in seconds :param randomlyPlaced=False: Toggles if events are randomly shifted in time inside the window

single_mirror_position = [[0, 0, 0]]

single_mirror_direction = [[1, 0, 0]]

four_mirror_corner_position

four_mirror_corner_direction

default_ID = 5

default_tag = 'X'

default_folder = 'testset/dataset'

default_saveas = 'testset/resultFile'

default_useGPU = False

default_randomSeed = 1

default_isMonochromatic = False

default_NoR = 10

default_M = 211

default_rho = 3000

default_c_p = 6000

default_L = 6000

default_Nx = 200

default_dx = 60.0

default_xmax = 6000

default_tmax = 2.0

default_Nt = 200

default_dt = 0.01

default_depth = 6000

default_cavity_r = 5

default_mirror_count

default_source_count

default_Awavemin = 1e-11

default_Awavemax = 1e-11

default_fmin = 1

default_fmax = 10

default_fmono = 1

default_sigmafmin = 0.5

default_sigmafmax = 1

default_anisotropy = 'none'

default_state = None

default_NoS

default_freq = 10

default_SNR = 10000000000.0

default_p = 1

default_c_ratio = 0.6666666666666666

default_NoW = 10

default_NoT = 1

default_NoE = 1

default_time_window_multiplier = 1

default_twindow = None

default_randomlyPlaced = False

generateEventSet(tag, NoR=None, ID=None, folder=None, useGPU=None, randomSeed=None, isMonochromatic=None, M=None, rho=None, c_p=None, L=None, Nx=None, xmax=None, tmax=None, Nt=None, depth=None, cavity_r=None, mirror_positions=None, mirror_directions=None, point_source_positions=None, Awavemin=None, Awavemax=None, fmin=None, fmax=None, fmono=None, sigmafmin=None, sigmafmax=None, anisotropy=None)

generates an eventSet. events are a set of wave parameters and time series of bulk Newtonian noise force given an experimental setup. They are saved to quickly access and generate different datasets from an eventSet.

# ~~~~~~~~~~~~~~Save management~~~~~~~~~~~~~~#

Parameters:

tag – eventSet identifier
ID – (optional) running number
tag – (optional) eventSet identifier
folder – (optional) eventSet path

# ~~~~~~~~~~~~~~General~~~~~~~~~~~~~~# :param useGPU: (optional) Set True if you have and want to use GPU-resources :param randomSeed: (optional) If None, use no seed :param isMonochromatic: (optional) Toggles between monochromatic and Gaussian wave packets :param NoR: (optional) Number of runs/realizations/wave events # ~~~~~~~~~~~~~~Constants~~~~~~~~~~~~~~# :param M: (optional) Mirror mass of LF-ET in kg :param rho: (optional) Density of rock in kg/m³ :param c_p: (optional) Sound velocity of rock #6000 m/s # ~~~~~~~~~~~~~~Domain~~~~~~~~~~~~~~# :param L: (optional) Length of simulation box in m :param Nx: (optional) Number of spatial steps for force calculation, choose even number :param xmax: (optional) Distance of wave starting point from 0 :param tmax: (optional) Time of simulation in s :param Nt: (optional) Number of time steps # ~~~~~~~~~~~~~~Experiment config~~~~~~~~~~~~~~# :param depth: (optional) Upper domain cutoff (=L for full space) :param cavity_r: (optional) Radius of spherical cavern in m :param mirror_positions: (optional) Array of mirror position [x,y,z] in m :param mirror_directions: (optional) Array of mirror free moving axis unit vectors :param point_source_positions: (optional) Array of point source position [x,y,z] in m # ~~~~~~~~~~~~~~Event parameters~~~~~~~~~~~~~~# :param Awavemin: (optional) Minimum amplitude of delta_rho/rho :param Awavemax: (optional) Maximum amplitude of delta_rho/rho :param fmin: (optional) Minimum frequency of seismic wave in Hz :param fmax: (optional) Maximum frequency of seismic wave in Hz :param fmono: (optional) The frequency of all monochromatic plane waves in Hz :param sigmafmin: (optional) Minimum width of frequency of Gaussian wave-packet in Hz :param sigmafmax: (optional) Maximum width of frequency of Gaussian wave-packet in Hz :param anisotropy: (optional) “none” for isotropy,

“quad” for more waves from above, “left” for only waves from -x, “p000”-“p100” for 0%-100% point source contribution

loadFromSettingFile(tag, folder='.', ID=0)

Load default parameters from an existing eventSet settingFile. The settingFile should be named folder + “/” + “settingFile” + tag + “.txt”

Parameters:

tag – the tag used for generating the eventSet
folder="." – the path where the file is
ID=0 – identifier number

generateDataset(tag=None, folder=None, ID=None, saveas=None, useGPU=None, NoR=None, state=None, NoS=None, freq=None, SNR=None, p=None, c_ratio=None, NoW=None, NoT=None, NoE=None, time_window_multiplier=None, twindow=None, randomlyPlaced=None, mirror_ID=None)

Generate a dataSet from an eventFile and a set of parameters. Returns the time series of the Newtonian noise force from one of the mirrors and the 3*NoS witness channel time series from the seismometer array.

# ~~~~~~~~~~~~~~Save management~~~~~~~~~~~~~~# :param tag=”X”: dataSet identifier :param folder=”testset/dataset”: dataSet path :param ID=5: int(argv[1]) :param saveas=”testset/resultFile”: Identifier for all savefiles produced # ~~~~~~~~~~~~~~General~~~~~~~~~~~~~~# :param useGPU=False: Set True if you have and want to use GPU-resources :param NoR=10: Number of wave events from the eventSet that will be included # ~~~~~~~~~~~~~~Dataset Parameters~~~~~~~~~~~~~~# :param state=[

[400, 350, 0], [-250, 250, 0], [200, -250, 0], [-100, -100, 0],

]: Seismometer positions :param NoS=4: Number of Seismometers :param freq=10: Frequency of the Wiener filter in Hz :param SNR=1e10: SNR as defined in earlier optimization attempts :param p=1: Ratio of P- and S-waves :param c_ratio=2/3: Ratio c_s/c_p # ~~~~~~~~~~~~~~Window Parameters~~~~~~~~~~~~~~# :param NoW=10: Number of total time windows :param NoT=1: Number of runs without update of WF (test) :param NoE=1: Number of wave events per time window :param time_window_multiplier=1: Time length of a window to be evaluated in units of t_max :param twindow=None: Overwrites window length in seconds :param randomlyPlaced=False: Toggles if events are randomly shifted in time inside a window

Returns:: time series of witness channels (3D seismometer displacement)
Returns:: time series of target channel (Newtonian-noise force of one test mass)

deleteEventSet(tag, folder=None)

Deletes an existing eventSet. Deletes all files containing the tag in the folder.

Parameters:

tag – The tag used for generating the eventSet
folder=None – The path where the files are located