README.md 1.9 KB
Newer Older
1
![Aeva](./doc/userguide/figures/logo.png)
David Thompson's avatar
David Thompson committed
2

David Thompson's avatar
David Thompson committed
3 4 5 6 7 8 9 10 11 12 13
# Introduction

The [Annotation and Exchange of Virtual Anatomy (aeva)](https://aeva.readthedocs.io/) suite
consists of two applications: aevaCMB (this repository)
and [aeva/Slicer](https://gitlab.kitware.com/aeva/aevaslicer).
The aevaCMB application is an open-source, multi-platform annotation and simulation workflow framework
based on [Computational Model Builder (CMB)](https://www.computationalmodelbuilder.org),
[ParaView](https://www.paraview.org),
the [Visualization Toolkit (VTK)](http://www.vtk.org) and [Qt](https://www.qt.io).
You will find binary packages at
the [aeva downloads](https://data.kitware.com/#collection/5e387f9caf2e2eed3562242e) site.
David Thompson's avatar
David Thompson committed
14

David Thompson's avatar
David Thompson committed
15
The project has grown through collaborative efforts between
David Thompson's avatar
David Thompson committed
16 17
the [Cleveland Clinic](https://www.lerner.ccf.org/bme/), [Kitware Inc.](https://www.kitware.com/),
and various other government and commercial institutions, and acedemic partners.
David Thompson's avatar
David Thompson committed
18 19 20 21

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

22
As aeva is developed, we will post more information on using and developing with it.
David Thompson's avatar
David Thompson committed
23 24 25 26 27 28 29 30

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

If you have found a bug:

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

31
2. Otherwise, please join a discussion on our [discourse site][] and ask
David Thompson's avatar
David Thompson committed
32 33 34 35
   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
36
   an entry in the [aeva issue tracker][].
David Thompson's avatar
David Thompson committed
37

David Thompson's avatar
David Thompson committed
38
[discourse site]: https://discourse.kitware.com/c/smtk
39
[aeva issue tracker]: https://gitlab.kitware.com/aeva/aeva/issues
David Thompson's avatar
David Thompson committed
40 41 42 43 44 45 46 47

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

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

[CONTRIBUTING.md]: CONTRIBUTING.md

David Thompson's avatar
David Thompson committed
48 49
Latest Release Notes
====================
David Thompson's avatar
David Thompson committed
50
Can be found [here](doc/release/aeva-2.0.md).
David Thompson's avatar
David Thompson committed
51

David Thompson's avatar
David Thompson committed
52 53 54
License
=======

55
Aeva is distributed under the OSI-approved BSD 3-clause License.
David Thompson's avatar
David Thompson committed
56 57 58
See [License.txt][] for details.

[License.txt]: LICENSE.txt