From 1109bf63ae72746001da0148ce1625df80fcb2b8 Mon Sep 17 00:00:00 2001 From: David Hendriks <davidhendriks93@gmail.com> Date: Mon, 1 Feb 2021 19:47:36 +0000 Subject: [PATCH] updated docs --- .gitignore | 3 ++- docs/source/binary_c_parameters.rst | 2 +- docs/source/grid_options_descriptions.rst | 2 ++ 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index e1d23a1d5..22b07a770 100644 --- a/.gitignore +++ b/.gitignore @@ -8,11 +8,12 @@ tests/json* lib/ bin/ obj/ + # Standard template *.org~ *.so *.pyc -build/* +/build/* binary_c_python_api.o output/* *.nfs* diff --git a/docs/source/binary_c_parameters.rst b/docs/source/binary_c_parameters.rst index 144e916ab..56de8181e 100644 --- a/docs/source/binary_c_parameters.rst +++ b/docs/source/binary_c_parameters.rst @@ -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 diff --git a/docs/source/grid_options_descriptions.rst b/docs/source/grid_options_descriptions.rst index 46455660b..0f948ea04 100644 --- a/docs/source/grid_options_descriptions.rst +++ b/docs/source/grid_options_descriptions.rst @@ -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 -- GitLab