Installation

Release:

1.3.0

Dependency Requirements

S3Dlib was built with the following dependencies:

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

MIT License

Copyright (c) 2020-24 Frank Zaverl, Jr.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Release History

S3Dlib version history is on the 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 to send an email for your comments.