LICENSE
=======

Stellar is distributed under the licensing terms detailed in the accompanying 
LICENSE file. Please contact libstellar@berkeley.edu with all licensing-related
inquiries.


INSTALLATION
============

To build, use either the provided cmake project file, or the plain 
Makefile. If you have cmake installed, simply run the following:

mkdir build
cd build
cmake ..
make

This will build three targets:
1. libstellarlib.{so,dylib} - the main mesh improvement library.
2. Stellar - an example executable using the static mesh improvement schedule.
3. Pulsar - an example executable using the dynamic mesh improvement schedule.

If you prefer to use plain make, just type 'make', which should place 
the products of the build in the main directory. There is, however, 
a much higher chance that you will need to manually edit 'Makefile' in order to
build libstellar, Stellar and Pulsar on your platform. 


USING STELLAR
=============

Stellar is intended to be used as a C/C++ library. The Stellar and Pulsar 
programs included in this distribution show an examples of how to use it, 
along with some insightful comments. A more in-depth discussion of the 
algorithms implemented in Pulsar can be found in the following papers: 

B. Klingner, J. Shewchuk: "Aggressive Tetrahedral Mesh Improvement",
In Proc. 16th International Meshing Roundtable, 2007.

M. Wicke, D. Ritchie, B. Klingner, S. Burke, J. Shewchuk, J. O'Brien: "Dynamic
Local Remeshing for Elastoplastic Simulation", In Proc. SIGGRAPH, 2010.

Please contact stellar@berkeley.edu if you have any questions.


KNOWN ISSUES
============

* Stellar currently does not work properly if built natively on 64-bit 
  platforms. 32-bit builds work.

* Stellar internally uses some global variables, and is not thread-safe.

* Some compiler optimizations break the arbitrary precision code that is used 
  for tetrahedron orientation tests. If you encounter strange behavior / 
  crashes, try disabling compiler optimizations when compiling the file 
  Star/star.c (all other files should be fine).

If you notice any other bugs, please write to libstellar@berkeley.edu. The 
probability for a satisfactory resolution of the problem increases dramatically
if you include any error messages, as well as a minimal piece of calling code 
and input files necessary to recreate the problem.

