Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Rename manage_case to query_config #1155

Closed
rljacob opened this issue Feb 16, 2017 · 10 comments
Closed

Rename manage_case to query_config #1155

rljacob opened this issue Feb 16, 2017 · 10 comments
Assignees
@erichlf
Labels
tp: user interface

Comments

@rljacob
Copy link
Member

rljacob commented Feb 16, 2017

"manage" is for scripts that can edit xml files. "query" just reads them.

"manage_case" in its current version only reads xml files so we should change its name to "query_case".
@gold2718
Copy link

Perhaps this should be merged with xmlquery into case.query (to match all the other case tools).
Then, case.change would be the tool for making case changes.

@jedwards4b
Copy link
Contributor

We had a meeting on 1/30 with some of the scientists to explore requirements for the manage_case tool, I agree that it may be misnamed. It is not a case tool but rather one you would use before creating a case.

@jedwards4b
Copy link
Contributor

Renaming xmlquery and xmlchange would require extensive changes to external components, I'm not sure that's a good idea right now.

@gold2718
Copy link

Can you list which 'external components' are affected?
We could always make case.query and case.change and then deprecate xmlquery and xmlchange. The xml versions would print a warning and then call the new routine.
I think the time to put in place (and document) a consistent UI is before the release.
Leaving the (deprecated) xmlchange and xmlquery routines in place for a while will help users transition.

@rljacob
Copy link
Member Author

rljacob commented Feb 16, 2017

@gold2718 please stop hijacking issues. :)

manage_case is available in cime/scripts. xmlchange/xmlquery are only available to users after making a case. I think we definitely want a config file query tool available to users before a case is built.

Since the difference is one works with config.xml files while the other works with env.xml files maybe xmlchange/xmlquery should be envchange/envquery.

@gold2718
Copy link

Sorry, I guess this shows that all the tools are just a jumble in my head (more a property of my head than anything related to CIME).
I guess what I wanted is a discussion of the CIME UI in a unified context so we don't have to continually explain the weird command names and syntax (well, yeah that was --machine but this is --mach).
I would love to have a better tale to tell at this year's CESM tutorial.

@jedwards4b
Copy link
Contributor

There is no longer a --mach option anyplace.

@rljacob rljacob assigned jgfouca and unassigned jgfouca Feb 28, 2017
@rljacob rljacob mentioned this issue Feb 28, 2017
Closed
@rljacob
Copy link
Member Author

rljacob commented Feb 28, 2017

I changed my mind. This program should be called "query_config". That's what its really querying.

agsalin pushed a commit that referenced this issue Mar 23, 2017
@rljacob
Merge branch 'rljacob/compset/update4P2' (PR #1155)
7a17edb 
Update CAM5%AV1C-L in the WCYCL and CRYO compsets
to use the 2000_cam5_av1c-04p2 CAM nml use case.

[CC]
@rljacob rljacob mentioned this issue Apr 6, 2017
Closed
@erichlf erichlf self-assigned this Apr 20, 2017
erichlf pushed a commit that referenced this issue Apr 20, 2017
Renamed manage_case to query_case
a8aed30 
Renamed manage_case to query_case as per #1155. Additionally, changed all
references to manage_case to query_case.
@erichlf erichlf mentioned this issue Apr 20, 2017
Merged
@ghost ghost added the in progress label Apr 20, 2017
@jedwards4b
Copy link
Contributor

query_case is a confusing name since you don't already have a case when you call this - I thought @rljacob's suggestion of query_config was a good one.

@rljacob rljacob changed the title Rename manage_case to query_case Rename manage_case to query_config Apr 20, 2017
erichlf pushed a commit that referenced this issue Apr 20, 2017
Switched to query_config from query_case
6fd6ec1 
The last commit mistakenly used query_case instead of query_config. This commit
fixes this issue.

Fixes #1155
@mvertens
Copy link
Contributor

mvertens commented Apr 20, 2017 via email

erichlf pushed a commit that referenced this issue May 3, 2017
Added '--skip-preview-namelist' to case.build test
429f82d 
Added '--skip-preview-namelist' to the call for case.build in the
testing suite, since building namelists during tests isn't done.

Test suite: scripts_regression_tests.py
Test baseline:
Test namelist changes:
Test status: bit for bit

Fixes #1155, #1190

User interface changes?: Added --skip-preview-namelist to case.build and
template.case.run

Code review: @billsacks, @jgfouca, @rljacob
erichlf pushed a commit that referenced this issue May 3, 2017
Added Ability to Query Single Machine
f0dc1f9 
In this commit-- added the ability to give machine name as a query.
Additionally, fixed some the argument descriptions. Also, fixed argument
descriptions to be more descriptive on choices.

Test suite: `scripts_regression_tests.py`
and
```
./query_config
./query_config --grids
./query_config --machines
./query_config --machines current
./query_config --machines redsky
./query_config --machines edison
./query_config --machines skybridge
./query_config --compsets
./query_config --compsets all
./query_config --compsets drv
./query_config --component
```
Test baseline:
Test namelist changes:
Test status: bit for bit

Fixes #1155, #1190

User interface changes?:
manage_case -> query_config
--compset -> --compsets
--machine -> --machines
added 'all' option for --compsets
added 'current' and <machine> to --machines

Code review: @billsacks, @jgfouca
erichlf pushed a commit that referenced this issue May 5, 2017
Renamed manage_case to query_case
c8551d0 
Renamed manage_case to query_case as per #1155. Additionally, changed all
references to manage_case to query_case.
erichlf pushed a commit that referenced this issue May 5, 2017
Switched to query_config from query_case
7a85eaf 
The last commit mistakenly used query_case instead of query_config. This commit
fixes this issue.

Fixes #1155
erichlf pushed a commit that referenced this issue May 5, 2017
Added Ability to Query Single Machine
20eee71 
In this commit-- added the ability to give machine name as a query.
Additionally, fixed some the argument descriptions. Also, fixed argument
descriptions to be more descriptive on choices.

Test suite: `scripts_regression_tests.py`
and
```
./query_config
./query_config --grids
./query_config --machines
./query_config --machines current
./query_config --machines redsky
./query_config --machines edison
./query_config --machines skybridge
./query_config --compsets
./query_config --compsets all
./query_config --compsets drv
./query_config --component
```
Test baseline:
Test namelist changes:
Test status: bit for bit

Fixes #1155, #1190

User interface changes?:
manage_case -> query_config
--compset -> --compsets
--machine -> --machines
added 'all' option for --compsets
added 'current' and <machine> to --machines

Code review: @billsacks, @jgfouca
erichlf pushed a commit that referenced this issue May 5, 2017
Added Changes as per @billsacks
1bd5f7b 
* added the ability to print all compsets with argument
* added the ability to print all components with and without argument
* added the ability to print a specified single machine
* many config_component.xml files didn't have a help string, which
caused --components all not to work.
* fixed some typos and gramatical errors

Test suite:`scripts_regression_tests.py`
and
```
./query_config
./query_config --grids
./query_config --machines
./query_config --machines current
./query_config --machines redsky
./query_config --machines edison
./query_config --machines skybridge
./query_config --compsets
./query_config --compsets all
./query_config --compsets drv
./query_config --component
```
Test baseline:
Test namelist changes:
Test status: bit for bit

Fixes #1155, #1190
User interface changes?:
* manage_case -> query_config
* --compset -> --compsets
* --machine -> --machines
* added 'all' option for --compsets
* added 'current' to --machines
* added <machine> to --machines
* added 'all' to --component
* default for --component and --compsets is 'all'

Code review: @billsacks, @jgfouca, @jedwards4b, @rljacob
@ghost ghost removed the in progress label May 5, 2017
rljacob added a commit that referenced this issue May 5, 2017
@rljacob
Merge pull request #1388 from ESMCI/erichlf/manage_case
68f4b5d 
Renamed manage_case to query_config. Additionally, changed all
references to manage_case to query_config. Added ability to query current machine and a single machine. Added 'all' option to --compsets. Made the help message much more useful.

Test suite: scripts_regression_tests.py
and

./query_config
./query_config --grids
./query_config --machines
./query_config --machines current
./query_config --machines redsky
./query_config --machines edison
./query_config --machines skybridge
./query_config --compsets
./query_config --compsets all
./query_config --compsets drv
./query_config --component
Test baseline:
Test namelist changes:
Test status: bit for bit

Fixes #1155
Fixes #1190

User interface changes?:
manage_case -> query_config
--compset -> --compsets
--machine -> --machines
added 'all' option for --compsets
added 'current' and to --machines

Code review: @billsacks, @jgfouca
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@erichlf erichlf

Labels
tp: user interface
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
6 participants
@rljacob @erichlf @gold2718 @jedwards4b @jgfouca @mvertens