Changes between Initial Version and Version 1 of 2015-11-30


Ignore:
Timestamp:
Nov 30, 2015, 3:11:47 PM (10 years ago)
Author:
Conrad Huang
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • 2015-11-30

    v1 v1  
     1= Attendees =
     2
     3  Elaine, Eric, Greg, TomG, TomF, Conrad
     4
     5= Agenda =
     6 * Commands (what's next, syntax, etc)
     7 * Revisit '''colordef''' vs '''color define'''
     8 * Review Andreas' list
     9 * Updates [All]
     10
     11= Discussion =
     12 * Documentation needs to be split into two types:
     13   - User documentation by Elaine, who tests the commands in addition to documenting them.  These are also intended for consumption by users and therefore should not include experimental, incomplete commands (e.g., saving sessions without molecular data support).
     14   - Programmer documentation by Eric, TomG, Greg and Conrad.  New commands should have their intended functionality and syntax included in their doc strings so that Sphinx picks it up.  We can then discuss what the written proposal instead of having only verbal descriptions (sometimes several different versions).
     15 * "usage" output for commands with enumerated values
     16   - "usage style" currently yields "style atom_spec atom_style", which is not very useful if you do not know the legal values for atom_style.  Enumerated values should be listed on the next line, e.g.,
     17 {{{
     18 style atom_spec atom_style
     19 atom_style: one of sphere, stick, ball
     20 }}}
     21   - Enumerations should be listed even if the registered argument is Or(empty, enumeration)
     22   - "lighting" should be fixed to use enumerated "preset" options instead of using independent keywords.  This would make usage work as expected and make specifying multiple presets an error.
     23 * "format" argument in "save" command uses format '''name''' ("session", "jpeg", "png") and not suffix ("cxs", "jpg", "png").  Suffixes are explicitly not included as aliases to minimize cluttering up the command help/usage.
     24 * "position" and "setModelPosition" keywords to "view" command are split out into their own command
     25   - Two proposals were made:
     26     - Five commands: view, clip, position, camera, cofr
     27     - One command with subcommands: view, view clip, view position, view camera, view cofr
     28   - Five-comand version was selected
     29   - "view" command will eventually be extended to include options to use only some components from a view, e.g., just the camera and clipping planes, or just model positions but not camera, etc.
     30   - New command "position" will be:
     31     * '''position <no arguments>''' = list all current position information for camera and models
     32     * '''position camera <12 numbers>''' = set camera position
     33     * '''position models <model_spec,12 numbers>[,<model_spec,12 numbers>]*''' = set model positions
     34     * '''position initial <model_spec>''' = reset model position to initial orientation
     35   - "view initial model_spec" will be removed
     36   - "view orient" will be kept (reset '''camera''' orientation)
     37 * ''Meeting adjourned''
     38 * Revisit '''colordef''' vs '''color define'''
     39 * Review Andreas' list
     40 * Updates [All]
     41
     42= Action Items =
     43 * Tom's list:
     44   - Split view command
     45   - Fix lighting command
     46 * Greg's list:
     47   - Make "view list" and "view delete" subcommands