Skip to content
Snippets Groups Projects
Commit e6700c2e authored by David Hendriks's avatar David Hendriks
Browse files

Working on docs but they are not building

parent cb401867
No related branches found
No related tags found
No related merge requests found
No preview for this file type
No preview for this file type
No preview for this file type
File deleted
No preview for this file type
This diff is collapsed.
...@@ -37,12 +37,16 @@ The following options are meant to be changed by the user. ...@@ -37,12 +37,16 @@ The following options are meant to be changed by the user.
| **log_runtime_systems**: Whether to log the runtime of the systems . Each systems run by the thread is logged to a file and is stored in the tmp_dir. (1 file per thread). Don't use this if you are planning to run alot of systems. This is mostly for debugging and finding systems that take long to run. Integer, default = 0. if value is 1 then the systems are logged | **log_runtime_systems**: Whether to log the runtime of the systems . Each systems run by the thread is logged to a file and is stored in the tmp_dir. (1 file per thread). Don't use this if you are planning to run alot of systems. This is mostly for debugging and finding systems that take long to run. Integer, default = 0. if value is 1 then the systems are logged
| **max_queue_size**: Maximum size of the queue that is used to feed the processes. Don't make this too big! Default: 1000. Input: int
| **modulo**: No description available yet | **modulo**: No description available yet
| **parse_function**: Function that the user can provide to handle the output the binary_c. This function has to take the arguments (self, output). Its best not to return anything in this function, and just store stuff in the grid_options['results'] dictionary, or just output results to a file | **parse_function**: Function that the user can provide to handle the output the binary_c. This function has to take the arguments (self, output). Its best not to return anything in this function, and just store stuff in the grid_options['results'] dictionary, or just output results to a file
| **repeat**: Factor of how many times a system should be repeated. Consider the evolution splitting binary_c argument for supernovae kick repeating. | **repeat**: Factor of how many times a system should be repeated. Consider the evolution splitting binary_c argument for supernovae kick repeating.
| **run_zero_probability_system**: Whether to run the zero probability systems. Default: True. Input: boolean
| **slurm**: Int flag whether to use a slurm type population evolution. | **slurm**: Int flag whether to use a slurm type population evolution.
| **source_file_filename**: Variable containing the source file containing lines of binary_c commandline calls. These all have to start with binary_c. | **source_file_filename**: Variable containing the source file containing lines of binary_c commandline calls. These all have to start with binary_c.
...@@ -53,9 +57,90 @@ The following options are meant to be changed by the user. ...@@ -53,9 +57,90 @@ The following options are meant to be changed by the user.
| **weight**: Weight factor for each system. The calculated probability is mulitplied by this. If the user wants each system to be repeated several times, then this variable should not be changed, rather change the _repeat variable instead, as that handles the reduction in probability per system. This is useful for systems that have a process with some random element in it. | **weight**: Weight factor for each system. The calculated probability is mulitplied by this. If the user wants each system to be repeated several times, then this variable should not be changed, rather change the _repeat variable instead, as that handles the reduction in probability per system. This is useful for systems that have a process with some random element in it.
Moe & Distefano sampler options
-------------------------------
The following options are meant to be changed by the user.
| **Mmin**: Minimum stellar mass
| **multiplicity_model**:
multiplicity model (as a function of log10M1)
You can use 'Poisson' which uses the system multiplicty
given by Moe and maps this to single/binary/triple/quad
fractions.
Alternatively, 'data' takes the fractions directly
from the data, but then triples and quadruples are
combined (and there are NO quadruples).
| **multiplicity_modulator**:
[single, binary, triple, quadruple]
e.g. [1,0,0,0] for single stars only
[0,1,0,0] for binary stars only
defaults to [1,1,0,0] i.e. singles and binaries
| **normalize_multiplicities**:
'norm': normalize so the whole population is 1.0
after implementing the appropriate fractions
S/(S+B+T+Q), B/(S+B+T+Q), T/(S+B+T+Q), Q/(S+B+T+Q)
given a mix of multiplities, you can either (noting that
here (S,B,T,Q) = appropriate modulator * model(S,B,T,Q) )
note: if you only set one multiplicity_modulator
to 1, and all the others to 0, then normalizing
will mean that you effectively have the same number
of stars as single, binary, triple or quad (whichever
is non-zero) i.e. the multiplicity fraction is ignored.
This is probably not useful except for
testing purposes or comparing to old grids.
'raw' : stick to what is predicted, i.e.
S/(S+B+T+Q), B/(S+B+T+Q), T/(S+B+T+Q), Q/(S+B+T+Q)
without normalization
(in which case the total probability < 1.0 unless
all you use single, binary, triple and quadruple)
'merge' : e.g. if you only have single and binary,
add the triples and quadruples to the binaries, so
binaries represent all multiple systems
...
*** this is canonical binary population synthesis ***
It only takes the maximum multiplicity into account,
i.e. it doesn't multiply the resulting array by the multiplicity modulator again.
This prevents the resulting array to always be 1 if only 1 multiplicity modulator element is nonzero
Note: if multiplicity_modulator == [1,1,1,1] this
option does nothing (equivalent to 'raw').
| **q_high_extrapolation_method**: Same as q_low_extrapolation_method
| **q_low_extrapolation_method**:
q extrapolation (below 0.15) method
none
flat
linear2
plaw2
nolowq
| **ranges**:
| **resolutions**:
Private options Private options
--------------- ---------------
The following options are not meant to be changed by the user, as these options are used and set internally by the object itself. The description still is provided, but just for documentation purposes. The following options are not meant to be changed by the user, as these options are used and set internally by the object itself. The description still is provided, but just for documentation purposes.
| **_actually_evolve_system**: Whether to actually evolve the systems of just act as if. for testing. used in _process_run_population_grid
| **_binary_c_config_executable**: Full path of the binary_c-config executable. This options is not used in the population object. | **_binary_c_config_executable**: Full path of the binary_c-config executable. This options is not used in the population object.
| **_binary_c_dir**: Director where binary_c is stored. This options are not really used | **_binary_c_dir**: Director where binary_c is stored. This options are not really used
...@@ -92,11 +177,19 @@ The following options are not meant to be changed by the user, as these options ...@@ -92,11 +177,19 @@ The following options are not meant to be changed by the user, as these options
| **_probtot**: Total probability of the population. | **_probtot**: Total probability of the population.
| **_set_ms_grid**: Internal flag whether the M&S grid has been loaded
| **_start_time_evolution**: Variable storing the start timestamp of the population evolution. Set by the object itself. | **_start_time_evolution**: Variable storing the start timestamp of the population evolution. Set by the object itself.
| **_store_memaddr**: Memory adress of the store object for binary_c. | **_store_memaddr**: Memory adress of the store object for binary_c.
| **_system_generator**: Function object that contains the system generator function. This can be from a grid, or a source file, or a montecarlo grid. | **_system_generator**: Function object that contains the system generator function. This can be from a grid, or a source file, or a montecarlo grid.
| **_total_mass_run**: To count the total mass that thread/process has ran
| **_total_probability_weighted_mass_run**: To count the total mass * probability for each system that thread/process has ran
| **_total_starcount**: Variable storing the total amount of systems in the generator. Used and set by the population object. | **_total_starcount**: Variable storing the total amount of systems in the generator. Used and set by the population object.
| **_zero_prob_stars_skipped**: Internal counter to track how many systems are skipped because they have 0 probability
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment