ReadMe.md 2.25 KB
Newer Older
David Thompson's avatar
David Thompson committed
1
![SMTK](doc/images/smtk_logo.png)
2 3 4

Introduction
============
David Thompson's avatar
David Thompson committed
5
The [Simulation Model Toolkit (SMTK)][SMTK] is an open-source, multi-platform toolkit for supporting simulation workflows by providing access to different modeling kernels, mesh databases, and simulation infomation (via its attribute system). SMTK is developed as part of the [Computational Model Builder (CMB)][CMB] effort and provides extensions for [ParaView][],
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
[Visualization Toolkit (VTK)][VTK] and [Qt][].

The project
has grown through collaborative efforts between [Kitware Inc.][Kitware],
 and various other
government and commercial institutions, and acedemic partners.

[CMB]: http://www.ComputationalModelBuilder.org
[SMTK]: http://www.computationalmodelbuilder.org/smtk/
[ParaView]: http://www.paraview.org
[QT]: https://www.qt.io
[VTK]: http://www.vtk.org
[Kitware]: http://www.kitware.com

Learning Resources
==================

* General information is available at the [SMTK Homepage][SMTK].

* Documentation is available [online][Documentation].

* Community discussion takes place on the [SMTK Mailing Lists][].

* Commercial [support][Kitware Support] and [training][Kitware Training]
  are available from [Kitware][].


[CMB Homepage]: http://www.ComputationalModelBuilder.org
[Documentation]: http://www.computationalmodelbuilder.org/documentation/
[SMTK Mailing Lists]: http://www.computationalmodelbuilder.org/mailinglist/
[Kitware]: http://www.kitware.com/
[Kitware Support]: http://www.kitware.com/products/support.html
[Kitware Training]: http://www.kitware.com/products/protraining.php

Reporting Bugs
==============

If you have found a bug:

1. If you have a patch, please read the [CONTRIBUTING.md][] document.

2. Otherwise, please join the one of the [SMTK Mailing Lists][] and ask
   about the expected and observed behaviors to determine if it is
   really a bug.

3. Finally, if the issue is not resolved by the above steps, open
   an entry in the [SMTK Issue Tracker][].

[SMTK Issue Tracker]: https://gitlab.kitware.com/cmb/smtk/issues

Contributing
============

See [CONTRIBUTING.md][] for instructions to contribute.

[CONTRIBUTING.md]: CONTRIBUTING.md

License
=======

CMB is distributed under the OSI-approved BSD 3-clause License.
David Thompson's avatar
David Thompson committed
67
See [License.txt][] for details.
68 69

[License.txt]: LICENSE.txt