``IndianCreek_Test2.ipynb``
============================

Demo IPython/Jupyter notebook #1


Usage
-------


The `Streamlines`_ workflow is invoked in an IPython/Jupyter notebook as follows::

	JSON_parameters_file = './IndianCreek_Test2'
	import streamlines
	sl = streamlines.run( parameters_file=JSON_parameters_file, \
	                     do_geodata = False, \
	                     do_preprocess = False, do_condition=True, \
	                     do_trace = False, \
	                     do_postprocess=False, do_analysis=False, \
	                     do_plot=False, do_save_state=False, \
	                     do_export=False, \
	                     do_reload_state=False )

The default workflow options (set by :doc:`defaults.json <../modules/defaults_json>`) 
are ``do_geodata``, ``do_preprocess`` along with ``do_condition``, and ``do_trace``; 
the subsequent options ``do_postprocess``, ``do_analysis``, ``do_plot``, ``do_save_state``
and  ``do_export`` are all turned off by default,
as is the ``do_reload_state`` option.
The job JSON file, in this case :doc:`IndianCreek_Test2.json <IndianCreek_Test2_json>`, 
can override these defaults.
Finally, the options set as above in the invocation ``streamlines.run()`` 
will override those set in the the JSON files.

Here the run options mirror the defaults and those set in the job JSON file, 
such that the main streamline computational steps :mod:`geodata <streamlines.geodata>`, 
:mod:`preprocess <streamlines.preprocess>` with  
:meth:`conditioning <streamlines.preprocess.Preprocess.conditioned_gradient_vector_field>`,
and :mod:`trace <streamlines.trace>` are  executed.
The workflow state and all of its functionality are then returned in the 
:obj:`sl <streamlines.streamlining.Streamlining>` object. 

Further processing can then be carried out by invoking methods provided by class instances
referenced by :obj:`sl <streamlines.streamlining.Streamlining>`, e.g.,::

	sl.postprocess.do()
	sl.analysis.do()
	
Plotting of results can be fine-tuned::

	sl.plot.do_plot_streamlines = True
	sl.plot.plot_maps()

which yields:

.. image:: ../images/IndianCreek_Test2_streamlines.png
	
Currently the set of class instances and public methods provided by 
:obj:`sl <streamlines.streamlining.Streamlining>` are::

	dir(sl)
	['analysis', 'export', 'geodata', 'inventorize', 'plot', 'postprocess', 
	 'preprocess', 'state', 'trace']



GitHub render
-------------

See: `IndianCreek_Test2.ipynb`_

.. _IndianCreek_Test2.ipynb: https://github.com/cstarkjp/slmnb/blob/master/SmallTests/IndianCreek_Test2.ipynb
.. _Streamlines: https://github.com/cstarkjp/slm