diff --git a/examples/example_population.py b/examples/example_population.py index 922d01056dce49fbdf2921394339b6efedf03af8..3c1dd6393563853c8095984b2eba86691d0e02c2 100644 --- a/examples/example_population.py +++ b/examples/example_population.py @@ -135,11 +135,16 @@ example_pop.add_grid_variable( # Exporting of all the settings can be done with .export_all_info() # on default it exports everything, but can be supressed by turning it off: -# population settings (bse_options, grid_options, custom_options), turn off with include_population_settings=False -# binary_c_defaults (all the commandline arguments that binary c accepts, and their defaults). turn off with include_binary_c_defaults=False -# include_binary_c_version_info (all the compilation info, and information about the compiled parameters), turn off with include_binary_c_version_info=False -# include_binary_c_help_all (all the help information for all the binary_c parameters), turn off with include_binary_c_help_all=Fase -# On default it will write this to the custom_options['data_dir'], but that can be overriden by setting use_datadir=False and providing an outfile=<> +# population settings (bse_options, grid_options, custom_options), turn off with include_population +# settings=False +# binary_c_defaults (all the commandline arguments that binary c accepts, and their defaults). +# turn off with include_binary_c_defaults=False +# include_binary_c_version_info (all the compilation info, and information about the compiled +# parameters), turn off with include_binary_c_version_info=False +# include_binary_c_help_all (all the help information for all the binary_c parameters), +# turn off with include_binary_c_help_all=Fase +# On default it will write this to the custom_options['data_dir'], but that can be overriden by +# setting use_datadir=False and providing an outfile=<> example_pop.export_all_info() # Creating a parsing function @@ -154,7 +159,8 @@ print(output) ## This uses the values generated by the grid_variables # example_pop.evolve_population_mp_chunks() # TODO: update this function call -# Wrapping up the results to an hdf5 file can be done by using the create_hdf5(<directory containing data and settings>) -# This function takes the settings file (ending in _settings.json) and the data files (ending in .dat) from the data_dir +# Wrapping up the results to an hdf5 file can be done by using the create_hdf5 +# (<directory containing data and settings>) This function takes the settings file +# (ending in _settings.json) and the data files (ending in .dat) from the data_dir # and packing them into an hdf5 file, which is then written into the same data_dir directory create_hdf5(data_dir=example_pop.custom_options["data_dir"], name="example_pop.hdf5")