Revise documentation of configuration parameters #182

dzhoshkun · 2018-07-30T08:20:36Z

This is a sub-task of #166

The configuration file parameters are documented on RTD.

Once all the sub-tasks of Support for flexible configuration #166 have been addressed,
these should be revised

dzhoshkun · 2019-06-03T09:32:21Z

As discussed with @ericspod via email, I'm a bit tied up at the moment, so will unfortunately not be able to undertake this issue. On a related note, this is a sub-task of #166 - possibly one of the last sub-tasks in that ticket, so probably best to address it after all the others.

…tion file

…y adding default config file options

… and after each test in global config test suite

…be able to easily switch file types if needed

…anded path in global config tests

…n global config test instead of os.path.join'ed value

…on-existing config file created

…efault config opts dict

… file

…configuration options

…onfig file

…alConfig class

…ists, and creates if not

…ew file creation

…g home dir entry read from config file

…ng created home dir in tests

…ked up in tests

…oading

…en trying to load global config file

…ctions and keys in global config file for clarity

docstring

hard-coded strings

…ion in __load_or_create method for clarity

… existing

…ig test suite

…onfiguration' into 'dev' Resolve "Add NiftyNet user directory to global application configuration" Closes NifTK#182 See merge request !99

dzhoshkun mentioned this issue Jul 30, 2018

Support for flexible configuration #166

Open

5 tasks

ericspod assigned dzhoshkun May 28, 2019

ericspod added the documentation label May 28, 2019

dzhoshkun removed their assignment Jun 3, 2019

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: added test method stubs for testing global configura…

e380fb6

…tion file

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: implemented setUpClass of global config test class b…

7fea50a

…y adding default config file options

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: implemented removal of created filepath items before…

fc725ef

… and after each test in global config test suite

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: implemented non-existing config file created test

4c436dc

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: using a file type setting in global config tests to …

a475c60

…be able to easily switch file types if needed

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: implemented incorrect config file backed up test

07fa49a

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: implemented existing config file loaded test

a21d176

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: default config opts use tilda literal instead of exp…

26acaf6

…anded path in global config tests

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: switched tests to using INI format instead of YML

1faae3c

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: using literal path for default niftynet home value i…

f735716

…n global config test instead of os.path.join'ed value

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: added false assertion for config file when testing n…

0bdab79

…on-existing config file created

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: using 'home' as key insteand of 'niftynet_home' in d…

bdb372e

…efault config opts dict

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: simplified imports in niftynet_global_config.py file

e11ee92

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: global config file now set to ~/.niftynet/config.ini

8e909fc

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: added __load_or_create method stub for global config…

fb87e8a

… file

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: added section to config/README.md for custom global …

3dd797a

…configuration options

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: linked from main README to global configuration options

32de13e

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: corrected NiftyNet home dir tag expected in global c…

29a9bef

…onfig file

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: global config tests now write a [global] header as well

a7d27ab

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: corrected method indentation problem in NiftyNetGlob…

9491baa

…alConfig class

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: __load_or_create back to non-static method

48f8d07

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: calling __load_or_create in constructor

8e1522a

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: __load_or_create checking whether config home dir ex…

7a9a248

…ists, and creates if not

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: implemented __load_or_create except for backup and n…

ce0f343

…ew file creation

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: using expanduser instead of abspath when absolutisin…

cb598e5

…g home dir entry read from config file

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: corrected output of global config file in tests

aabbf3f

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: using expanduser instead of path literal when removi…

1513f99

…ng created home dir in tests

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: fixed comparison asserting incorrect config file bac…

1f9b8af

…ked up in tests

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: fixed removal of created backup file in tests

a8962b1

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: added check for 'home' tag in loaded global config file

008c168

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: implemented incorrect file backup in global config l…

5ddc809

…oading

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: removed unnecessary new file creation flag checks wh…

637b5d8

…en trying to load global config file

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: added additional comments to __load_or_create function

c7e34b5

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: revised code that checks availability of required se…

1a57f86

…ctions and keys in global config file for clarity

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: added default values for the global config section keys

0946f49

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: more clarification added to __load_or_create method

8015d3e

docstring

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: removed enumeration from test method names

9e52a0a

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: removed test class docstring about ordering of tests

3eb9339

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: using env vars to run global config tests separately

a5865f8

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: using class vars for section and key names instead of

20b8ba5

hard-coded strings

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: reshuffled config file path and filename check locat…

4c30f3a

…ion in __load_or_create method for clarity

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: creating NiftyNet home dir if doesn't already exist

00b0fb8

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: added test checking NiftyNet home dir created if not…

1d92ced

… existing

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: removed unneeded tearDownClass method of global conf…

4b95e7d

…ig test suite

elitap pushed a commit to elitap/NiftyNet that referenced this issue Feb 16, 2021

Issue NifTK#182: documented global config file minimal version

f57dd55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Revise documentation of configuration parameters #182

Revise documentation of configuration parameters #182

dzhoshkun commented Jul 30, 2018

dzhoshkun commented Jun 3, 2019

Revise documentation of configuration parameters #182

Revise documentation of configuration parameters #182

Comments

dzhoshkun commented Jul 30, 2018

dzhoshkun commented Jun 3, 2019