Integration of LPdiag tool #704
Commits on Nov 24, 2023
-
Please find the original repo at https://github.com/marek-iiasa/MCA/tree/master Note that e.g. the reading material has not yet been included here
-
Counter of coeffs having different magnitudes was added. Order and wordings of printouts was improved. Comments added to the code, including modified TODO comments.
-
Move lp_diag files to better locations
* Move README.textile to doc/tools/lp_diag_README.textile for now * This needs to be converted to rst later on
-
[lp_diag] Add several features
Counters of outliers added. Order of printouts improved, wording in printouts improved, comments in the core improved, including updated TODOs, which summarize possible further enhancements.
-
to reflect the new location of the tool
-
-
The doc/tools/lp_diag_README.textile contains a brief description of the tool.
-
-
-
-
-
Avoid overwriting cli args passed to the script
Set some rather arbitrary defaults for the args, please change them as necessary. Uncomment later lines (~80) to retain old behaviour.
-
-
-
-
-
-
-
to refrain from committing working dirs and *.swp files
-
Processing of each MPS section organized into the corresponding functions. Thus the, previously large and complex rd_mps() is now compact and much simpler.
-
-
[lp_diag] Reduce complexity to satisfy flake8
lpdiag.py modified substantially in order to conform to the complexity limit of flake8. The new version was checked with flake8 and run through black
-
main.py modified to ease running it locally (without message_ix env) and fast testing. The committed version is prepared for running in message_ix env.
-
[lp_diag] Satisfy mypy per fn_out, f_out
main.py: corrected the defaults for fn_out, f_out (inconsistency of types detected by mypy) lpdiag.py: removed duplicated defs of sections[]
-
[lp_diag] Satisfy mypy & pycharm in main.py
in main.py, only to satisfy diagnostics of both mypy and pycharm
-
[lp_diag] Add initial draft of docs
Far from worth to read, committed as a back-up only.
-
[lp_diag] Diverse improvements
This is an intermediate working version. Please wait with comments until a stable version will be committed.
-
[lp_diag] Change location of test-mps files
The new location simplifies the access.
-
[lp_diag] Refactor and improveme
The file names changed in order to provide a clearer use. CL options changed also to improve usage. Info on actual working directory added, as well as check of readability of the required MPS file. The default run (i.e., without the CL params) uses one of small test MPS. Moreover, a number of improvements in comments, including removal of redundant comments.
-
Comments shorten to conform to the line-length limit
-
[lp_diag] Sort import statements
To please the (really picky) isort test of lint.
-
[lp_diag] Improve work-dir diagnostics
Diagnostics of possible problems with wrong working directory improved, as well as the corresponding tip on dealing with the problem.
-
[lp_diag] Add to message_ix/cli.py
I 've added two lines (10 and 158) trying to make it possible to run lpdiag from the CL. Note: lpdiag.py is the main function of lpdiag. This does not work; therefore both lines are commented in order to not cause possible problems.
-
[lp_diag] Modify message_ix/cli.py
Uncomment import message_ix.tools.lp_diag.lpdiag and added: main.add_command(message_ix.tools.lp_diag.lpdiag)
-
[lp_diag] Comment pieces of message_ix/cli.py
The commented pieces were attempts to make lpdiag callable in message-ix env, from any place. These don't work with the current set-up of lpdiag.
-
Correct typos in output generation
Several typos in the text generated during the execution were corrected.
-
[lp_diag] First complete version of the doc embedded in the message-i…
…x doc Posted as the Readme.rst located in message-ix/message-ix/tools/lp_diag directory, and linked to the message-ix/doc/tools/lp_diag.rst; thus it is embedded in the message-ix doc.
-
[lp_diag] Correct spelling in doc
Spelling corrected in Readme.rst.
-
Corrected in the text of diagnostics message..
-
[lp_diag] Reformat to satisfy black
To conform to the black test, which failed after adding a single space.
-
Just to please the new version (thus more picky) version of flake8; no changes in the functionality.
-
-
-
-
-
-
-
* Add test coverage * Add some type hints * Clarify function names * Remove some outdated comments
-
Satisfy mypy by renaming variables
Re-enable pre-commit mypy hook.
-
-
-
-
-
-
Consolidate LPdiag .gitignore at top level
* Remove the markers: * message_ix/tools/lp_diag/data/mps/of_* * message_ix/tools/lp_diag/Bak/ * message_ix/tools/lp_diag/doc/ * message_ix/tools/lp_diag/sph/ * Use .git/info/exclude for such personal markers!
-
-
-
Update lp_diag.py to correctly identify columns
* Changing `"col":self.mat_row` to `"col":self.mat_col` when generating self.mat DataFrame to allow the tool to correctly identify columns with bad coefficients * Thanks, @ywpratama
-
-
-
-
-
-
Convert lp_diag.cli.main to a click.Command
- Integrate with top-level CLI as "message-ix lp-diag". - Use click option processing; remove read_args(). - Use click.Path and pathlib for checks. - Reflow comments and code for readability.
-
Apply numpydoc style to docstrings in .lp_diag
- Fix typos in some string literals.
-
Add § "API reference" to doc/tools/lp_diag
- Use heading order (*, =, -) consistent with other docs. - Correct a malformed reference. - Add a `.. contents::` directive.
-
Un-hard-wrap lines in doc/tools/lp_diag.rst
Also: - Replace "python lp_diag.py" with "message-ix lp-diag". - use :program: role to document CLI options; use lower case to match the actual option names. - use :file: role where appropriate - Remove comments in cli.py that duplicated docs text.
-
-
-
