mailRe: Logical ordering of the relax command line arguments - Re: r22186 - /trunk/relax.py


Others Months | Index by Date | Thread Index
>>   [Date Prev] [Date Next] [Thread Prev] [Thread Next]

Header


Content

Posted by Edward d'Auvergne on February 14, 2014 - 14:30:
Hi,

This idea has now been implemented in r22189
(http://article.gmane.org/gmane.science.nmr.relax.scm/19954).  The
output of the help system now looks like:

[edward@localhost relax-trunk]$ ./relax -h
Usage: relax [options] [script_file]

Options:
  -h, --help            show this help message and exit

  UI options:
    -p, --prompt        launch relax in prompt mode after running any
                        optionally supplied scripts
    -g, --gui           launch the relax GUI
    -i, --info          display information about this version of relax
    -v, --version       show the version number and exit
    --licence           display the licence
    --test              run relax in test mode

  Multi-processor options:
    -m MULTIPROCESSOR, --multi=MULTIPROCESSOR
                        set multi processor method
    -n N_PROCESSORS, --processors=N_PROCESSORS
                        set number of processors (may be ignored)

  IO redirection options:
    -l LOG_FILE, --log=LOG_FILE
                        log relax output to the file LOG_FILE
    -t LOG_FILE, --tee=LOG_FILE
                        tee relax output to stdout and the file LOG_FILE

  Test suite options:
    -x, --test-suite    execute the relax test suite
    -s, --system-tests  execute the relax system/functional tests (part of the
                        test suite)
    -u, --unit-tests    execute the relax unit tests (part of the test suite)
    --gui-tests         execute the relax GUI tests (part of the test suite)
    --time              enable the timing of individual tests in the test
                        suite

  Debugging options:
    -d, --debug         enable debugging output
    -e, --escalate      escalate all warnings to errors
    --numpy-raise       convert numpy warnings to errors
[edward@localhost relax-trunk]$


This should now be much clearer for the user.  Suggestions for further
improvements or changes are welcome!

Regards,

Edward



On 14 February 2014 12:16, Edward d'Auvergne <edward@xxxxxxxxxxxxx> wrote:
Hi,

Looking at this change, I think I might look at rearranging the relax
arguments.  This is something I'll do.  But running:

$ relax --help
Usage: relax [options] [script_file]

Options:
  -h, --help            show this help message and exit
  -d, --debug           enable debugging output
  -l LOG_FILE, --log=LOG_FILE
                        log relax output to the file LOG_FILE
  --licence             display the licence
  -t LOG_FILE, --tee=LOG_FILE
                        tee relax output to stdout and the file LOG_FILE
  -g, --gui             launch the relax GUI
  -e, --escalate        escalate all warnings to errors
  -p, --prompt          launch relax in prompt mode after running any
                        optionally supplied scripts
  --test                run relax in test mode
  -x, --test-suite      execute the relax test suite
  -s, --system-tests    execute the relax system/functional tests (part of 
the
                        test suite)
  -u, --unit-tests      execute the relax unit tests (part of the test 
suite)
  --gui-tests           execute the relax GUI tests (part of the test suite)
  --time                enable the timing of individual tests in the test
                        suite
  -i, --info            display information about this version of relax
  -v, --version         show the version number and exit
  -m MULTIPROCESSOR, --multi=MULTIPROCESSOR
                        set multi processor method
  -n N_PROCESSORS, --processors=N_PROCESSORS
                        set number of processors (may be ignored)
  --numpy-raise         convert numpy warnings to errors

This displays the arguments in an almost random order!  I think I
might use the following orders and introduce the optparse.OptionGroup
concept for:

1)  The help options (-h),
2)  The UI options (-p, -g, -i, -v, --licence, --test),
3)  The multi-processor options (-m, -n),
4)  The IO redirection options (-l, -t),
5)  The test suite options (-x, -s, -u, --gui-tests, --time),
6)  The debugging options (-d, -e, --numpy-raise).

Regards,

Edward


On 14 February 2014 11:54,  <tlinnet@xxxxxxxxxxxxx> wrote:
Author: tlinnet
Date: Fri Feb 14 11:54:44 2014
New Revision: 22186

URL: http://svn.gna.org/viewcvs/relax?rev=22186&view=rev
Log:
Modified the help text to explain that -p will launch relax in prompt mode 
after running any optionally supplied scripts.

Fix for sr #3117, (https://gna.org/support/?3117) - Functionality to 
inspect interactively after running script - The equivalence to python -i

This is to allow the -p --prompt option to be given without a script. 
relax should support this so that a user doesn't get too confused when
trying to start in prompt mode with the --prompt flag and support the 
--prompt argument without a script being supplied.

Modified:
    trunk/relax.py

Modified: trunk/relax.py
URL: 
http://svn.gna.org/viewcvs/relax/trunk/relax.py?rev=22186&r1=22185&r2=22186&view=diff
==============================================================================
--- trunk/relax.py (original)
+++ trunk/relax.py Fri Feb 14 11:54:44 2014
@@ -280,7 +280,7 @@
         parser.add_option('-t', '--tee', action='store', type='string', 
dest='tee', help='tee relax output to stdout and the file LOG_FILE', 
metavar='LOG_FILE')
         parser.add_option('-g', '--gui', action='store_true', dest='gui', 
default=0, help='launch the relax GUI')
         parser.add_option('-e', '--escalate', action='store_true', 
dest='escalate', default=0, help='escalate all warnings to errors')
-        parser.add_option('-p', '--prompt', action='store_true', 
dest='prompt', default=0, help='execute the given script and continue into 
the prompt mode to allow for interactive inspection')
+        parser.add_option('-p', '--prompt', action='store_true', 
dest='prompt', default=0, help='launch relax in prompt mode after running 
any optionally supplied scripts')
         parser.add_option('--test', action='store_true', dest='test', 
default=0, help='run relax in test mode')
         parser.add_option('-x', '--test-suite', action='store_true', 
dest='test_suite', default=0, help='execute the relax test suite')
         parser.add_option('-s', '--system-tests', action='store_true', 
dest='system_tests', default=0, help='execute the relax system/functional 
tests (part of the test suite)')


_______________________________________________
relax (http://www.nmr-relax.com)

This is the relax-commits mailing list
relax-commits@xxxxxxx

To unsubscribe from this list, get a password
reminder, or change your subscription options,
visit the list information page at
https://mail.gna.org/listinfo/relax-commits



Related Messages


Powered by MHonArc, Updated Fri Feb 14 15:00:11 2014