.. _tutorial:



***************
Tutorials
***************

This page contains basic tutorials for constructing 3D surface and line plots using S3Dlib.  
Familiarity with using Matplotlib and Numpy libraries is assumed.  

These tutorials minimize detailed formatting of figures such as inclusion of titles, labels,
axis aspect, etc.  Instead, focus is placed on usage of the S3Dlib capabilities.
Figure layout, shown in the images, may slightly differ from those produced from the
provide scripts.  This is a reult in differences among Matplotlib versions.

For a more detailed explanation, see the user :ref:`doc_index` pages,
Also, specific usage is provided in various :ref:`example` descriptions.


.. _tut_helloworld:

.. toctree::
   :hidden:

   surface_geom/helloworld.rst

.. raw:: html

    <a href="surface_geom/helloworld.html">
    <div class="docbutton">
    <span class="tooltiptext">Creating surfaces and meshes, then placing them on a 3D axes.</span>

.. only:: html

.. image:: surface_geom/images/helloworld_2.png
   :class: docfig

Hello World

.. raw:: html

    </div></a>


.. _tut_basic_coor:


.. toctree::
   :hidden:

   surface_geom/basic_coor.rst

.. raw:: html

    <a href="surface_geom/basic_coor.html">
    <div class="docbutton">
    <span class="tooltiptext">Mapping surface geometry using different coordinate systems.</span>

.. only:: html

.. image:: surface_geom/images/hw_polar.png
   :class: docfig

Coordinates and Functions

.. raw:: html

    </div></a>






.. toctree::
   :hidden:

   surface_color/cmap_normals_tut.rst

.. raw:: html

    <a href="surface_color/cmap_normals_tut.html">
    <div class="docbutton">
    <span class="tooltiptext">Visualizing surface geometry using color mapped face normals.</span>

.. only:: html

.. image:: surface_color/images/col_norm1.png
   :class: docfig

Color Mapped Surface Normals

.. raw:: html

    </div></a>




.. toctree::
   :hidden:

   surface_color/cmap_functions_tut.rst

.. raw:: html

    <a href="surface_color/cmap_functions_tut.html">
    <div class="docbutton">
    <span class="tooltiptext">Applying user-defined functions to colorize surfaces.</span>

.. only:: html

.. image:: surface_color/images/cmap_functions_tut.png
   :class: docfig

Color Mapping Using Functions

.. raw:: html

    </div></a>






.. toctree::
   :hidden:

   line_geom/helloworld_line.rst

.. raw:: html

    <a href="line_geom/helloworld_line.html">
    <div class="docbutton">
    <span class="tooltiptext">Creating line types and placing them on a 3D axes.</span>

.. only:: html

.. image:: line_geom/images/line_param.png
   :class: docfig

Hello World, Lines

.. raw:: html

    </div></a>






.. toctree::
   :hidden:

   line_color/cmap_segment_tut.rst

.. raw:: html

    <a href="line_color/cmap_segment_tut.html">
    <div class="docbutton">
    <span class="tooltiptext">Applying color to lines and line subdivisions for smooth coloration.</span>

.. only:: html

.. image:: line_color/images/line_color.png
   :class: docfig

Color Mapped Line Segments

.. raw:: html

    </div></a>






.. toctree::
   :hidden:

   render_control/scaling.rst

.. raw:: html

    <a href="render_control/scaling.html">
    <div class="docbutton">
    <span class="tooltiptext">Controlling the scaling for rendering 3D objects.</span>

.. only:: html

.. image:: render_control/images/scaling_1.png
   :class: docfig

Scaling

.. raw:: html

    </div></a>







.. toctree::
   :hidden:

   render_control/visualization3d.rst

.. raw:: html

    <a href="render_control/visualization3d.html">
    <div class="docbutton">
    <span class="tooltiptext">Visualizing 3D objects using Matplotlib rendering.</span>

.. only:: html

.. image:: render_control/images/visualization3d.png
   :class: docfig

3D Rendering

.. raw:: html

    </div></a>







.. toctree::
   :hidden:

   render_control/lightbulb.rst

.. raw:: html

    <a href="render_control/lightbulb.html">
    <div class="docbutton">
    <span class="tooltiptext">List of considerations when constructing S3Dlib visualizations.</span>

.. only:: html

.. image:: render_control/images/lightbulb.png
   :class: docfig

Notes

.. raw:: html

    </div></a>










.. raw:: html

    <div style='clear:both'></div>