|
1 | 1 | [](http://www.eclipse.org/legal/epl-2.0)
|
2 | 2 | [](https://www.java.com/)
|
3 | 3 |
|
4 |
| -# NabLab |
| 4 | +<img src="./README_images/logo_full.png" width="20%" height="20%" align="right" /> |
| 5 | + |
| 6 | + |
| 7 | +# Presentation |
5 | 8 |
|
6 | 9 | <img src="http://www.cea.fr/PublishingImages/cea.jpg" width="20%" height="20%" align="right" />
|
7 | 10 |
|
8 | 11 | Written by CEA and Contributors
|
9 | 12 |
|
10 |
| -(C) Copyright 2020, by CEA. All rights reserved. |
| 13 | +(C) Copyright 2021, by CEA. All rights reserved. |
11 | 14 |
|
12 | 15 | All content is the property of the respective authors or their employers.
|
13 | 16 | For more information regarding authorship of content, please consult the
|
14 | 17 | listed source code repository logs.
|
15 | 18 |
|
16 |
| -## Introduction |
17 |
| - |
18 | 19 | NabLab is a full-fledged industrial environment for scientific computing and High Performance Computing based on [Eclipse](https://www.eclipse.org/).
|
19 | 20 |
|
20 |
| -This program and the accompanying materials are made available under the terms of the Eclipse Public License v. 2.0 which is available at https://www.eclipse.org/legal/epl-v20.html. |
21 |
| - |
22 |
| -SPDX-License-Identifier: EPL-2.0 |
23 |
| - |
24 |
| -Please refer to the license for details. |
25 |
| - |
26 |
| -## Getting started |
27 |
| - |
28 | 21 | The latest NabLab environment can be downloaded [here](https://github.com/cea-hpc/NabLab/releases/tag/v0.4.0). For Mac users, depending on your security configuration, you have to enter the following command to execute NabLab: `xattr -d com.apple.quarantine NabLab.app`.
|
29 | 22 |
|
30 |
| -Once the NabLab environment has been launched, the NabLab perspective should be selected. If it is not the case, just select the NabLab perspective from the *Window > Perspective > Open Perspective > Other ... > NabLab* menu. |
31 |
| - |
32 |
| -<img src="./README_images/NabLab_perspective_menu.png" alt="NabLab Perspective Menu" title="NabLab Perspective Menu" width="30%" height="30%" /> |
33 |
| - |
34 |
| -The NabLab perspective provides a set of *Views* and wizards shortcuts allowing to easily create and develop nabla models. |
35 |
| - |
36 |
| -### Create a new project |
37 |
| - |
38 |
| -From the *Model Explorer View* in the *NabLab* perspective, just right-click and select *New > Nabla Project* to create a new project: |
39 |
| - |
40 |
| -<img src="./README_images/NabLab_new_menu.png" alt="NabLab New Project" title="NabLab New Project" width="60%" height="60%" /> |
41 |
| - |
42 |
| -You can also create it from the *File > New > Nabla Project* main menu. |
43 |
| - |
44 |
| -A new wizard is launched, asking for a project name and a module name: |
45 |
| - |
46 |
| -<img src="./README_images/NabLab_new_project_wizard.png" alt="NabLab New Project Wizard" title="NabLab New Project Wizard" width="50%" height="50%" /> |
47 |
| - |
48 |
| -Just click on the *Finish* button to create the new project. The new project is available in the *Model Explorer View*: |
49 |
| - |
50 |
| -<img src="./README_images/NabLab_new_project_result.png" alt="NabLab New Project Result" title="NabLab New Project Result" width="30%" height="30%" /> |
51 |
| - |
52 |
| -It contains two models (*MyModule.nabla*, and *MyModule.nablagen*) in the *nabla.project/src/mymodule/* folder. |
53 |
| - |
54 |
| -To launch the java and kokkos source code generations corresponding to the nabla module, just right-click on the *nabla.project/src/mymodule/MyModule.nablagen* and select *Run As > Launch Generation* |
55 |
| - |
56 |
| -<img src="./README_images/NabLab_nablagen_launch_generation.png" alt="NabLab Launch Generation" title="NabLab Launch Generation" width="50%" height="50%" /> |
57 |
| - |
58 |
| -The java and kokkos source code files are generated in *src-gen-java* and *src-gen-cpp* folders respectively. |
59 |
| - |
60 |
| -<img src="./README_images/NabLab_nablagen_generated_files.png" alt="NabLab Generated Files" title="NabLab Generated Files" width="30%" height="30%" /> |
61 |
| - |
62 |
| -### Examples project |
63 |
| - |
64 |
| -From the *Model Explorer View* in the *NabLab* perspective, just right-click and select *New > Nabla Examples* to import the examples project: |
65 |
| - |
66 |
| -<img src="./README_images/NabLab_new_menu.png" alt="NabLab Examples" title="NabLab Examples" width="60%" height="60%" /> |
67 |
| - |
68 |
| -You can also import it from the *File > New > Nabla Examples* main menu. |
69 |
| - |
70 |
| -A new wizard is launched: |
71 |
| - |
72 |
| -<img src="./README_images/NabLab_nabla_examples_wizard.png" alt="NabLab Examples Wizard" title="NabLab Examples Wizard" width="50%" height="50%" /> |
73 |
| - |
74 |
| -Just click on the *Finish* button to import the examples project. The examples project is available in the *Model Explorer View*: |
75 |
| - |
76 |
| -<img src="./README_images/NabLab_nabla_examples_generated_files.png" alt="NabLab Examples Generated Files" title="NabLab Examples Generated Files" width="100%" height="100%" /> |
77 |
| - |
78 |
| -It contains a set of Nabla examples including Glace2D, HeatEquation, ImplicitHeatEquation, and ExplicitHeatEquation. |
79 |
| - |
80 |
| -### Latex View |
81 |
| - |
82 |
| -The *Latex View* is located on the bottom right corner of the NabLab environment. It allows to visualize in an elegant way the nabla formulas contained in a *nabla* model. |
83 |
| - |
84 |
| -The *Latex View* is accessible through the *Window > Show View > Other... > Nabla > Latex View* main menu. |
85 |
| - |
86 |
| -This view is automatically updated and synchronized with the selection in the current nabla model editor. |
87 |
| - |
88 |
| -<img src="./README_images/NabLab_latex_view.png" alt="NabLab Latex View" title="NabLab Latex View" width="100%" height="100%" /> |
89 |
| - |
90 |
| -### Job Graph Editor |
91 |
| - |
92 |
| -The *Job Graph Editor* can be opened from a *nablagen* model, by clicking on F2. |
93 |
| - |
94 |
| -It allows to visualize the graph of jobs computed from the *nablagen* model. |
95 |
| - |
96 |
| -<img src="./README_images/NabLab_job_graph_editor.png" alt="NabLab Job Graph Editor" title="NabLab Job Graph Editor" width="100%" height="100%" /> |
97 |
| - |
98 |
| -## Build via Maven 3.x |
99 |
| - |
100 |
| -To build the NabLab products for Windows/Linux/MacOS and the Eclipse update-site, you can run the following command from the root of the repository: |
101 |
| -`mvn clean; mvn verify`. |
102 |
| - |
103 |
| -Note the `';'` after `mvn clean`. |
104 |
| - |
105 |
| -The products resulting from the build will be accessible in */releng/fr.cea.nabla.updatesite/target/products/NabLab-1.0.0.yyyymmddHHMM-YOUR_PLATFORM.zip*. |
106 |
| - |
107 |
| -The Eclipse update-site resulting from the build will be accessible in */releng/fr.cea.nabla.updatesite/target/fr.cea.nabla.updatesite-1.0.0.yyyymmddHHMM.zip*. |
| 23 | +The NabLab documentation is available [here](https://cea-hpc.github.io/NabLab/). |
108 | 24 |
|
109 |
| -Just install this update-site in an Eclipse 2020-03 with Sirius 6.4.0 and Xtext 2.21.0 already installed to use NabLab. |
| 25 | +This program and the accompanying materials are made available under the terms of the [Eclipse Public License v. 2.0](available at https://www.eclipse.org/legal/epl-v20.html). SPDX-License-Identifier: EPL-2.0. Please refer to the license for details. |
110 | 26 |
|
111 |
| -If you want to skip tests execution, you can run the following command: |
112 |
| -`mvn clean; mvn verify -Dmaven.test.skip=true` |
113 | 27 |
|
114 |
| -## Dependencies |
| 28 | +# Dependencies |
115 | 29 |
|
116 | 30 | NabLab requires Java 11 or later to build & run.
|
117 | 31 |
|
|
0 commit comments