esgf-pyclient : automating ESGF interaction
-------------------------------------------

Stephen Pascoe (Stephen.Pascoe@stfc.ac.uk)

Overview
--------

* What is esgf-pyclient?
* How to get it
* Concepts
* Demo
* Upcoming features

What is esgf-pyclient?
----------------------

* A Python client interface to ESGF services
 
  * For client scripting
  * For embedding in other tools

* Current features

  * ESGF Search interface
  * ESGF Logon interface (MyProxyLogon)

* Planned features

  * Retrieve wget scripts
  * Secured OPeNDAP integration
  * ES-DOC integration (maybe via pycim-api-client)


How to get it
-------------

* Project page: http://pypi.python.org/pypi/esgf-pyclient
* Automatic install
::

   $ easy_install esgf-pyclient
   $ pip install esgf-pyclient

* Manual install
::

   $ tar zxf esgf-pyclient-*.tar.gz
   $ cd esgf-pyclient-*.tar.gz
   $ python setup.py install

* Docs at http://esgf-pyclient.readthedocs.org/

* Follow the code: http://github.com/stephenpascoe/esgf-pyclient

  * Submit bugs
  * Fork and contribute

Concepts
--------

* Works like the web interface

  * select-facet -> select-facet -> search

* ``SearchConnection`` represents an ESGF index's search service
* ``SearchContext`` represents the current set of search constraints
* ``ResultSet`` is the set of hits from a search
* ``Result`` objects expose the json and ESGF-specific properties

Demo
----

* Goto Notebook

Upcoming features
-----------------

* Retrieve wget script
::

   >>> script_src = ctx.get_download_script()
   >>> open('mywget.sh', 'w').write(script_src)

* OPenDAP integration

  * EXPERIMENTAL
  * Automatically configure NetCDF security settings
  * Retrieve a netCDF4 Python object for an OPeNDAP endpoint