.. _inst_index:


***************
Installation
***************

.. only:: html

    :Release: |version|


Dependency Requirements
--------------------------------

S3Dlib was built with the following dependencies:

* `Python <https://www.python.org/downloads/>`_ 3.11.7

* `NumPy <https://numpy.org/install/>`_ 1.26.3

* `SciPy <https://www.scipy.org/install.html>`_ 1.11.4

* `scikit-image <https://scikit-image.org/docs/stable/user_guide/install.html>`_ 0.20.0

* `Matplotlib <https://matplotlib.org/users/installing.html>`_ 3.8.0

* `Colorspacious <https://colorspacious.readthedocs.io/en/latest/overview.html>`_ 1.1.2

Package Installation
--------------------------------

S3Dlib can be installed using the pip installer::

    pip install s3dlib

The S3Dlib package source code is on GitHub located at::

    https://github.com/fzaverl/s3dlib

License
--------------------------------

.. literalinclude:: LICENSE.txt


Release History
--------------------------------

S3Dlib version history is on the  :ref:`release_history` page.




Developer's Notes
--------------------------------

S3Dlib is not a substitute for, but a complement to Matplotlib
for rendering 3D surfaces and lines.

The main objective of developing S3Dlib was that, given a function in native coordinates,
it should only take one code statement to create a surface or line object, one
code statement to create the geometry, and one code statement to color the object.
Finally, one code statement to add that object to a Matplotlib 3D axis.
Any further annotation would be achieved using Matplotlib.  

A secondary objective was that the function used to define the geometry
is easily comprehensible by examining the code, and not obscured in the grid
creation algorithm.  In other words, a functional relationship should look like a function
in native coordinates.
 
As shown in the various examples, these objectives have been reasonably achieved. 

Why so many examples? From experience as a student and instructor, examples provide
a major learning tool.  Examples show the application of concepts.  Examples allow
a comparison between a problem and a similar problem already solved.
Documentation describes what a method does whereas examples describe how a method is used.
Also, examples answer 'So, what is it good for?'.

Any comments regarding computational errors or code improvements, and additional capabilities
would be encouraged and appreciated.
Comments based on best practices would also be helpful, including documentation improvements
(please provide references if available).
Any examples using S3Dlib would also be welcome.  Click
`here <mailto:comments@s3dlib.org?subject=Comments-S3Dlib>`_ 
to send an email for your comments.





.. toctree::
   :hidden:

   release_history.rst