########################################################################################################################################
Description
Main README file for STROOPWAFEL publicly available data. 

Any work making use of these simulations should cite:

https://arxiv.org/abs/1905.00910
Broekgaarden et al. 2019

STROOPWAFEL: Simulating rare outcomes from astrophysical populations, 
with application to gravitational-wave sources. 
Authors: Floor S. Broekgaarden, Stephen Justham, Selma E. de Mink, Jonathan Gair, Ilya Mandel, Simon Stevenson, Jim W. Barrett, Alejandro Vigna-Gómez, Coenraad J. Neijssel

For any queries, email:

fsbroekgaarden@gmail.com
compas@star.sr.bham.ac.uk 
fbroekgaarden@g.harvard.edu


The following text below describes the contents of the file STROOPWAFEL_data_BroekgaardenEtAll.tar.gz

########################################################################################################################################



STROOPWAFEL_data_BroekgaardenEtAll.tar.gz

Contains the following 7 directories with data: 
(DCO = Double Compact Object)

Traditional                         	# data of the simulations run with sampling Monte Carlo from the birth distributions (traditional sampling) at Z = 0.001 metallicity 
ALL                  	    			# data of ALL DCOs (simulation 1) at Z = 0.001 metallicity with STROOPWAFEL sampling
BHBH                  	    			# data of BH-BH DCOs (simulation 2) at Z = 0.001 metallicity with STROOPWAFEL sampling
BHNS_Stroopwafel         	          	# data of BH-NS DCOs (simulation 3) at Z = 0.001 metallicity with STROOPWAFEL sampling
NSNS_Stroopwafel                  	    # data of NS-NS DCOs (simulation 4) at Z = 0.001 metallicity with STROOPWAFEL sampling
BHBH_50Msun_Stroopwafel     	        # data of BH-BH DCOs that have total mass <= 50 Msun (simulation 5) at Z = 0.001 metallicity with STROOPWAFEL sampling
NSNS_50Myr_Stroopwafel	                # data of NS-NS DCOs that merge within <= 50 Myrs (simulation 6) at Z = 0.001 metallicity with STROOPWAFEL sampling

which correspond with the 6 STROOPWAFEL sampled simulations + the reference "birth distribution Monte Carlo" sampled simulation ("Traditional"). These simulations are summarized in Table 2 of https://arxiv.org/pdf/1905.00910.pdf


The Traditional directory contains two files: 

allSystems.dat 								# datafile with the initial parameter values of all binaries simulated
allDoubleCompactObjects.dat 				# datafile with the parameter values of all binaries simulated that became a double compact object (DCO)			


The Stroopwafel directories (simulations 1-6) contain 2 folders:

exploration 								# data from the exploration phase of Stroopwafel
refinement									# data from the refinement phase of Stroopwafel


each of the exploration and refinement folders contain 4 files (the first 2 files are similar to the 0_Traditional.tar.gz file): 

allSystems.dat 								# datafile with the initial parameter values of all binaries simulated
allDoubleCompactObjects.dat 				# datafile with the parameter values of all binaries simulated that became a double compact object (DCO)			
allSystemsWeights.txt 						# textfile containing an array with the weights of the binaries in allSystems.dat
allDoubleCompactObjectsWeights.txt 			# textfile containing an array with the weights of the binaries in allDoubleCompactObjects.dat




STROOPWAFEL_data_BroekgaardenEtAll.tar.gz also contains 2 README files:
The data in allSystems.dat and allDoubleCompactObjects.dat is described in the README files given by README_DCOs.txt and README_systems.txt

Lastly, with the data in STROOPWAFEL_data_BroekgaardenEtAll.tar.gz there is a jupyter notebook that contains examples on how to read and use the data:
STROOPWAFEL-DEMO_PublicData.ipynb