Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Onur R. Bingol committed Feb 23, 2018
1 parent 6d6c5d0 commit 0e70e46
Showing 1 changed file with 17 additions and 11 deletions.
28 changes: 17 additions & 11 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,19 +1,25 @@
NURBS-Python Example Scripts
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Examples for NURBS-Python Package
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

This repository contains API demonstration scripts for the NURBS-Python_ package.

Installing NURBS-Python
=======================

``pip install NURBS-Python``

This repository contains examples for the NURBS-Python_ package.

Directory Structure
===================

* ``curve2d/`` contains examples for ``BSpline.Curve2D`` and ``NURBS.Curve2D`` classes
* ``curve3d/`` contains examples for ``BSpline.Curve`` and ``NURBS.Curve`` classes
* ``surface/`` contains examples for ``BSpline.Surface`` and ``NURBS.Surface`` classes
* ``grid/`` contains examples for ``CPGen.Grid`` and ``CPGen.GridWeighted`` classes
* ``visualization/`` contains some visualization examples. Please see NURBS-Python_ documentation for details.
* ``bezier/`` contains examples for Bezier surfaces and 2D/3D curves generated using ``BSpline`` module
* ``shapes/`` contains examples for ``geomdl.shapes`` component
* ``exchange/`` contains examples for ``geomdl.exchange`` module
* ``curve2d/`` contains 2D curve examples
* ``curve3d/`` contains 3D curve examples
* ``surface/`` contains surface examples
* ``grid/`` contains examples for surface grid generator
* ``visualization/`` contains visualization examples. Please see NURBS-Python_ documentation for details.
* ``bezier/`` contains Bezier curve and surface examples
* ``shapes/`` contains examples demonstrating ``geomdl.shapes`` component
* ``exchange/`` contains examples demonstrating ``geomdl.exchange`` module
* ``compat/`` contains examples which utilize ``geomdl.compatibility`` module for data conversion

Input Files
Expand Down

0 comments on commit 0e70e46

Please sign in to comment.