README.md 2.47 KB
Newer Older
1
![](http://aparapi.com/images/logo-text-adjacent.png)
SubaruWRC's avatar
SubaruWRC committed
2

3
[![License](http://img.shields.io/:license-apache-blue.svg?style=flat-square)](http://www.apache.org/licenses/LICENSE-2.0.html)
4
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.aparapi/aparapi-examples/badge.png?style=flat)](https://maven-badges.herokuapp.com/maven-central/com.aparapi/aparapi-examples/)
5
[![Gitter](https://badges.gitter.im/Syncleus/aparapi.svg)](https://gitter.im/Syncleus/aparapi?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
SubaruWRC's avatar
SubaruWRC committed
6

7
A framework for executing native Java code on the GPU.
SubaruWRC's avatar
SubaruWRC committed
8

9
**Licensed under the Apache Software License v2**
SubaruWRC's avatar
SubaruWRC committed
10

11
This project is a collection of examples for the Aparapi project. For more information see the Aparapi [website](http://Aparapi.com) or the [QOTO GitLab repository](https://git.qoto.org/aparapi/aparapi-examples). An up-to-date mirror of this repository is also maintained on [Github](https://github.com/Syncleus/aparapi-examples).
12

13
For detailed documentation see [Aparapi.com](http://Aparapi.com).
14

15
For support please use [Gitter](https://gitter.im/Syncleus/aparapi) or the [official Aparapi mailing list and Discourse forum](https://discourse.qoto.org/c/PROJ/APA).
16

17
Please file bugs and feature requests at [QOTO GitLab](https://git.qoto.org/aparapi/aparapi-examples); a mirror of older issues can be found at [Github](https://github.com/Syncleus/aparapi-examples/issues).
18

19
## Prerequisites
20

21
The examples should run on any system as-is. For GPU acceleration support you must have OpenCL installed and a compatible graphics card.
22

23
**Aparapi runs on all operating systems and platforms, however GPU acceleration support is currently provided for the following platforms: Windows 64bit, Windows 32bit, Mac OSX 64bit, Linux 64bit, and Linux 32bit.**
24

25
## Obtaining the Source
SubaruWRC's avatar
SubaruWRC committed
26

27
The official source repository for Aparapi Examples is located in the Syncleus Github repository and can be cloned using the
28
following command.
SubaruWRC's avatar
SubaruWRC committed
29

30
```bash
31

32
git clone https://git.qoto.org/aparapi/aparapi-examples.git
33
```
34

35
## Running
36

37 38 39 40
To run the examples simply checkout the git tag for the version you want to run and execute it through maven. Unless you
specifically want to try the latest snapshot it is important you checkout a specific git tag instead of the master
branch. To use the snapshot in the master branch you will have to manually install the core aparapi snapshot that
matches it since snapshots do not appear in maven central.
41

42
```bash
43

44
git checkout v2.0.0
45
mvn clean package exec:java
Jeffrey Phillips Freeman's avatar
Jeffrey Phillips Freeman committed
46
```