summaryrefslogtreecommitdiffstats
path: root/doc/HowToBuild.html
blob: fa3893a586aa69a3cdcf1928e2bae3173b07c5f7 (plain)
1
2
3
4
5
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
    <head>
        <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
        <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
        <link href="../../style.css" rel="stylesheet" type="text/css"/>
        <link href="../../style-alt1.css" rel="alternate stylesheet" title="default sans-serif font" type="text/css"/>
        <link href="../www/style.css" rel="stylesheet" type="text/css"/>
        <link href="http://jogamp.org/SocialCoding/logo_symbol_finals/website_final_blue_favicon_symbol_16x16pel.ico" rel="shortcut icon"/>
        <title>How to build JOCL</title>
    </head>
    <body>
        <div id="container">
            <div id="header">
                <div id="slogan">How to build JOCL</div>
                <div id="logo"><a href="http://jogamp.org/"><img src="../../images/jogamp_symbols/website_final_magenta_jocl_346x70pel.png" alt="JOCL Symbol"/></a></div>
            </div>
            <div id="menu">
                <ul>
                    <li><a href="http://jogamp.org/">Home</a></li>
                    <li><a href="../../gluegen/www/">Gluegen</a></li>
                    <li><a href="../../joal/www/">JOAL</a></li>
                    <li><a href="../../jocl/www/">JOCL</a></li>
                    <li><a href="../../jogl/www/">JOGL</a></li>
                    <li><a href="../../demos/www/">Demos</a></li>
                    <li><a href="../../wiki/">Wiki</a></li>
                    <li><a href="../../blog/">Blogs</a></li>
                    <li><a href="../../forum.html">Forums</a></li>
                </ul>
            </div>
            <div id="main">
                <div id="sidebar">
                    <h3>Useful Links</h3>
                    <ul>
                        <li><a href="../../jogl/doc/HowToBuild.html">JOGL Build HowTo</a></li>
                        <li><a href="../../deployment/autobuilds/master/">Download JOCL</a></li>
                        <li><a href="../../deployment/webstart-next/javadoc/jocl/javadoc/">JOCL JavaDoc</a></li>
                        <li><a href="../../wiki/index.php/JOCL_FAQ#Getting_Started">JOCL Hello World</a></li>
                        <li><a href="http://jogamp.org/git/?p=jocl.git">Code Repository</a></li>
                        <li><a href="http://jogamp.org/git/?p=jocl-demos.git">Demos Code Repository</a></li>
                    </ul>
                    <h3>External References</h3>
                    <ul>
                        <li><a href="http://www.khronos.org/opencl/">OpenCL Home</a></li>
                        <li><a href="http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/">OpenCL 1.2 Reference Pages</a></li>
                        <li><a href="http://www.khronos.org/registry/cl/specs/opencl-1.2.pdf">OpenCL 1.2 Specification</a></li>
                        <li><a href="https://www.khronos.org/files/opencl-1-2-quick-reference-card.pdf">OpenCL 1.2 Quick Reference Card</a></li>
                    </ul>
                    <h3>External Tutorials</h3>
                    <ul>
                        <li><a href="http://developer.amd.com/partners/university-programs/">AMD OpenCL University Kit</a></li>
                        <li><a href="http://developer.amd.com/resources/documentation-articles/videos/ati-stream-opencl-technical-overview-video-series/">OpenCL Technical Overview Video Series</a></li>
                        <li><a href="http://www.macresearch.org/opencl">Mac Research OpenCL Tutorials</a></li>
                    </ul>
                    <a href="http://www.khronos.org/opencl/"><img src="http://www.khronos.org/opencl/images/opencl_100px.png" alt="OpenCL"/></a>

                </div>
                <div id="text">
                    <h2>Prerequisites</h2>
                    <hr/>
                    <p>
                        Follow all steps described in <a href="../../jogl/doc/HowToBuild.html">How to build JOGL</a>,
                        since GlueGen and JOGL are required as compile-time dependencies.
                    </p>

                    <h2>Platform and Component Requirements</h2>
                    <hr/>
                    To run the tests included with JOCL, you will have to install an OpenCL implementation on your platform.
                    <p>
                        Some vendors include OpenCL with the graphics driver or operating system.
                        So please make sure your system is up to date.
                    </p>
                    OpenCL SDKs for the desktop:
                    <ul>
                        <li> <b>NVidia GPU</b> Geforce >= 8</b>
                            <ul>
                                <li> NVidia <a href="http://developer.nvidia.com/cuda-downloads">GPU Computing SDK</a></li>
                            </ul>
                        </li>
                        <li> <b>AMD GPU or CPU</b>
                            <ul>
                                <li> AMD <a href="http://developer.amd.com/tools-and-sdks/heterogeneous-computing/amd-accelerated-parallel-processing-app-sdk/">Accelerated Parallel Processing SDK</a></li>
                            </ul>
                        </li>
                        <li> <b>Intel CPU</b>
                            <ul>
                                <li>Intel <a href="http://software.intel.com/en-us/articles/opencl-sdk/">OpenCL SDK</a></li>
                            </ul>
                        </li>
                    </ul>

                    <h2>Build Steps</h2>
                    <hr/>
                    <p>
                        Here are the steps required to build JOCL.
                    </p>

                    <ol>
                        <li><b>Check out and build Gluegen and JOGL</b> as described <a href="../../jogl/doc/HowToBuild.html">here.</a></li>
                        <li><b>Get the JOCL source code</b> from the <a href="http://jogamp.org/git/?p=jocl.git">JOCL Git repository</a>.
                            It is important that you check out the source code side by side with its dependencies:
                            <pre>
    /home/dude/projects/jogamp> git clone git://jogamp.org/srv/scm/jocl.git jocl
                            </pre>
                            Now you should have following directory structure:
                            <pre>
    /home/dude/projects/jogamp
    /home/dude/projects/jogamp/gluegen
    /home/dude/projects/jogamp/jogl
    /home/dude/projects/jogamp/jocl
                            </pre>
                        </li>

                        <li> <b>Build the source tree:</b> <br/>
                            Open a command shell in the "jocl/make" directory of the source tree and type
                            <code>"ant clean"</code>, then <code>"ant"</code>.
                        </li>
                        <li> <b>Test your build:</b> <br/> Stay in your command shell in the "jocl/make" directory of the source tree and type <code>"ant junit.run"</code>.</li>
                        <li> <b>Build Javadoc:</b> <br/> Stay in your command shell in the "jocl/make" directory of the source tree and type "<code>ant javadoc"</code>.
                            This will produce the end-user documentation for JOCL.
                        </li>
                    </ol>
                </div>
            </div>
            <div id="footer">
                <div id="footer_left">
                    <span>JogAmp.org</span>
                    by <a href="http://jogamp.org">http://jogamp.org</a>
                    is licensed under a <br/>
                    <a href="http://creativecommons.org/licenses/by/3.0/us/">Creative Commons Attribution 3.0 License</a>.
                </div>
            </div>
        </div>
    </body>
</html>