Update documentation to reflect config files updates

[kwhitehall]

No description provided.

[cgoodale]

Hey @kwhitehall I was going to update this wiki page with the settings within the config file.

https://github.com/kwhitehall/grab-tag-graph/wiki/Using-GTG

Can you think of any other pages that might need some attention?

[kwhitehall]

Thanks @cgoodale! I had a look at the page, we might also need to update the rubric on the contents on the tar file, and include a heading on using the notebook. So headings like:

1. Download tarbar (or latest release would be better??)
   • explanation of the contents
2. Description of the config file
   • describe major vars to change verses those one leave
3. Usage of GTG
   Beginner: Juypter notebooks
   Advanced user: command line
4. Successful run

Maybe we should move out the heading "GTG workflow in weather application" to a separate page (as that is more architectural related and not user related).

Thoughts?

[kwhitehall]

also, to answer your original question, it looks we need to update the dependencies page as well.

[cgoodale]

@kwhitehall I think i have addressed items 1, 2, 3 from your list. Where is the dependencies page you speak of? The New User guide with the notebook stuff is pretty lengthy, it might also be a good candidate for a new wiki page.

[cgoodale]

I factored the notebook page out into a separate page after I saw the length with screenshots.

[kwhitehall]

+1 @cgoodale
To answer your questions (thought I think you figured it as I see updates there :)), the dependencies are listed on the home page https://github.com/kwhitehall/grab-tag-graph/wiki
You've nailed this issue. Thanks!
I'm going to do a bit of cleaning up in the mccSearchUI.py file (to include renaming it mccSearchCL.py and ensuring all the variables are ok), update the Using GTG wiki, then close this issue.

[kwhitehall]

Actually @cgoodale I'm thinking to remove that file in general as it has been replaced in essence by the notebook. There is no need for the CL interface. The advanced user actually uses the template script to start. What do you think?

[cgoodale]

I like the idea of using the Notebook to get people up and running quickly with a lot more access into the code. The challenge with a CLI that is question based is how the utility of the program is limited by the questions, and as people try to add more questions the once 'simple' CLI can become unruly (as we have seen with other projects).

I think GTG is finding it's sweet spot as we move forward with development. RIght now I think it's in a grey area between a library and an application. If we want to explore the library side of things we can start brainstorming api/syntax ideas before we even write code. We can start with designing the API we want to use, then back into how to make the API a reality.

This notion of API driven development isn't mine, I read about it a couple years back at this link:
http://www.kennethreitz.org/essays/how-i-develop-things-and-why

To answer the actual question: What do I think about dropping the CL interface? I think we should but only when we have a collection of common use cases with code showing how to solve the use case with GTG. It might be simply breaking up the CL code into documentation blocks in the wiki.