Commit 1109bf63 authored by David Hendriks's avatar David Hendriks
Browse files

updated docs

parent e4e92a4b

.gitignore

+2 −1
Original line number Diff line number Diff line
@@ -8,11 +8,12 @@ tests/json* 
lib/

bin/

obj/



# Standard template

*.org~

*.so

*.pyc

build/*

/build/*

binary_c_python_api.o

output/*

*.nfs*

docs/source/binary_c_parameters.rst

+1 −1
Original line number Diff line number Diff line
@@ -4,7 +4,7 @@ The following chapter contains all the parameters that the current version of bi 




This information was obtained by the following binary_c build: 

	**binary_c git branch**: branch_david	**binary_c git revision**: 5479:20210111:463f148ec	**Built on**: Jan 11 2021 17:31:47

	**binary_c git branch**: branch_david	**binary_c git revision**: 5479:20210111:463f148ec	**Built on**: Jan 28 2021 20:10:20





Section: stars

docs/source/grid_options_descriptions.rst

+2 −0
Original line number Diff line number Diff line
@@ -37,6 +37,8 @@ The following options are meant to be changed by the user. 


| **log_file**: Log file for the population object. Unused



| **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



| **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