Add documentation for black_hole_histories.hdf5 outputs

Also make sure our CI jobs check that it doesn't go out of sync.

Signed-off-by: Rodrigo Tobar <[email protected]>

.travis/test.sh

@@ -43,6 +43,7 @@ curl -L -o input/tree_199.0.hdf5 'https://docs.google.com/uc?export=download&id=
 run_shark() {
 	model_name=$1; shift
 	./shark ../sample.cfg \
+	    -o execution.output_bh_histories=true -o execution.snapshots_bh_histories=199 \
 	    -o simulation.redshift_file=input/redshifts.txt \
 	    -o simulation.tree_files_prefix=input/tree_199 \
 	    -o execution.name_model=$model_name $@ || fail "failure during execution of shark"
@@ -67,6 +68,7 @@ check_hdf5_doc() {
 
 check_hdf5_doc 199/0/galaxies.hdf5 galaxies.rst
 check_hdf5_doc 156/0/star_formation_histories.hdf5 star_formation_histories.rst
+check_hdf5_doc 199/0/black_hole_histories.hdf5 black_hole_histories.rst
 
 if [ -n "$PYTHON" ]; then
 

doc/hdf5_properties/black_hole_histories.rst

@@ -0,0 +1,47 @@
+.. This file has been automatically generated by the properties_as_list.sh
+   utility found under the scripts/ directory of the shark repository.
+   ======================
+   DO NOT MODIFY MANUALLY
+   ======================
+   Please see the script's help for more information on how to use it
+
+
+``cosmology``
+^^^^^^^^^^^^^
+* ``h``: normalization of hubble parameter H0 = h * 100 (km/s)/Mpc
+* ``n_s``: scalar spectral index assumed in simulation
+* ``omega_b``: omega baryon assumed in simulation
+* ``omega_l``: omega lambda assumed in simulation
+* ``omega_m``: omega matter assumed in simulation
+* ``sigma8``: fluctuation amplitude at 8 Mpc/h
+* ``delta_t``: Time interval covered between snapshots [Gyr]
+
+
+``galaxies``
+^^^^^^^^^^^^
+* ``bh_accretion_rate_hh_history``: Black hole accretion rate due to hot halo cooling [Msun/yr/h].
+* ``bh_accretion_rate_sb_history``: Black hole accretion rate due to starbursts [Msun/yr/h].
+* ``bh_spin``: Black hole spin history [dimensionless].
+* ``id_galaxy``: galaxy ID. Unique to this galaxy throughout time. If this galaxy never mergers onto a central, then its ID is always the same.
+* ``m_bh_assembly_history``: Black hole mass history coming from BH-BH mergers (cumulative) [Msun/h].
+* ``m_bh_history``: Black hole mass history (cumulative) [Msun/h].
+* ``lbt_mean``: Look back time to mean time between snapshots [Gyr]
+* ``redshifts``: Redshifts of the history outputs
+
+
+``run_info``
+^^^^^^^^^^^^
+* ``batches``: number of batches analysed
+* ``effective_volume``: effective volume of this run [(cMpc/h)^3]
+* ``lbox``: Box side size of the full simulated volume [Mpc/h]
+* ``ode_solver_precision``: accuracy applied when solving the ODE system of the physical model.
+* ``particle_mass``: dark matter particle mass of this simulation [Msun/h]
+* ``redshift``: output redshift
+* ``seed``: The seed value used in the random number engines
+* ``shark_git_has_local_changes``: whether this shark instance had uncommitted local changes
+* ``shark_git_revision``: the git revision of shark used to produce this data
+* ``shark_version``: the shark version
+* ``skip_missing_descendants``: boolean parameter that sets whether the code ignores subhalos that have no descendants.
+* ``snapshot``: output snapshot
+* ``timestamp``: time at which this shark execution started
+* ``tot_n_subvolumes``: Total number of subvolumes in which the simulated box was divided into