NEW: restructure using a python module/library instead of one big file

[mscheinert]

Description

Currently, the mkReadme script is a monolith. This makes it less re-usable for other developments (or our own). A better approach would be a module/library, that can be easily imported.

Proposed Solution

Split the mkReadme script into two parts: one module and one 'executable' which imports the module. Ultimate goal: nemo-simsar can be installed via pip & co.

Relations

• mkReadme script
• Dokumentation: We could add a API Reference
• Directory structure of this project

[mscheinert]

Simultaneously, we could also remove all the global variables and replace them with arguments and return values in the functions.

[lmicallef]

Scripts are uploaded in lucienneMicallef Branch | src

Major update:

• Script has been divided into two:
  • I) storing all functions (scriptMK.py) - 'module'
  • ii) the main programme (mkReadme.py) - 'executable'
• Script should be stored in an experiment, hence all reference being made to scripts stored in the root have been removed

Other updates to scriptMK.py

• Lines 612 - 618: reverted to the original path configuration, I.e. currentDirectory. open("../../cfg.txt", "r") etc.. is not working correctly
• Line 739 did not work, I have reverted to the previous code
• Reference to input.def is changed to input.ini
• Function to generate the markdown table from input.def has been removed
• Library local.svn is removed
• Subprocess.CalledProcessError is used as exception handling for SVN
• Code commented and not being used has been removed
• Removed unused variables

Functions removed: main() chooseConfigFile() check_EXPref()