Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Developing MOOSE Applications with ICE"
(→Forking the Stork) |
(→Adding a New Kernel) |
||
| (12 intermediate revisions by the same user not shown) | |||
| Line 6: | Line 6: | ||
=== Prerequisites === | === Prerequisites === | ||
| − | To use the MOOSE support in ICE, the user will need to have MOOSE installed on their system along with any MOOSE-based application that the user would like to run | + | To use the MOOSE support in ICE, the user will need to have MOOSE installed on their system along with any MOOSE-based application that the user would like to run. The user can simply use "moose_test" as the project name if no other application is available (the example in this tutorial uses the name "animals"). |
Please note that installing MOOSE requires the user to add several packages (prerequisites) to their system. For more information on how to install MOOSE and the prerequisites for doing so, please check out the MOOSE [http://www.mooseframework.org/getting-started Getting Started] guide. | Please note that installing MOOSE requires the user to add several packages (prerequisites) to their system. For more information on how to install MOOSE and the prerequisites for doing so, please check out the MOOSE [http://www.mooseframework.org/getting-started Getting Started] guide. | ||
For Mac OS X users, ICE developers also recommend installing the [http://brew.sh/ Homebrew package manager] to ensure all required packages and their dependencies are available to the user. | For Mac OS X users, ICE developers also recommend installing the [http://brew.sh/ Homebrew package manager] to ensure all required packages and their dependencies are available to the user. | ||
| − | |||
| − | |||
== Cloning MOOSE == | == Cloning MOOSE == | ||
| Line 21: | Line 19: | ||
[[File:Clone_moose_dev_menu_stc.png]] | [[File:Clone_moose_dev_menu_stc.png]] | ||
| − | This step will automatically connect to the MOOSE GitHub repository, create a local clone on the user's disk, and import MOOSE into the | + | This step will automatically connect to the MOOSE GitHub repository, create a local clone on the user's disk, and import MOOSE into the "Project Explorer." |
[[File:Moose_project_explorer_stc.png]] | [[File:Moose_project_explorer_stc.png]] | ||
| Line 32: | Line 30: | ||
[[File:open_git_perspective_stc_1.png]] | [[File:open_git_perspective_stc_1.png]] | ||
| − | Then select 'Git' from the list and click ''OK''. | + | Then select ''Git'' from the list and click ''OK''. |
[[File:open_git_perspective_stc_2.png]] | [[File:open_git_perspective_stc_2.png]] | ||
| Line 44: | Line 42: | ||
A wizard will prompt the user to provide information for the Git repository they are attempting to use. | A wizard will prompt the user to provide information for the Git repository they are attempting to use. | ||
| − | For MOOSE, enter <tt>https://github.com/idaholab/moose</tt> into the | + | For MOOSE, enter <tt>https://github.com/idaholab/moose</tt> into the "URI" field and select ''Next''. |
[[File:clone_wizard.png]] | [[File:clone_wizard.png]] | ||
| Line 60: | Line 58: | ||
[[File:Git_clone_progress_stc.png]] | [[File:Git_clone_progress_stc.png]] | ||
| − | After the clone completes, the user will be presented with a | + | After the clone completes, the user will be presented with a "Git Repository" view. |
| − | To import MOOSE into the ICE | + | To import MOOSE into the ICE "Project Explorer," simply right click the MOOSE repository and select ''Import Projects''. This will present the user with the import wizard. |
[[File:Import_git_projects_stc.png]] | [[File:Import_git_projects_stc.png]] | ||
| − | On the first wizard page, select ''Import using the New Project wizard'' and click ''Finish''. This will present the user with the ICE | + | On the first wizard page, select ''Import using the New Project wizard'' and click ''Finish''. This will present the user with the ICE "New Project" wizard. |
From here, open the C/C++ tree node and select ''Makefile project with Existing Code''. Provide a valid project name and toolchain and click ''Finish.'' | From here, open the C/C++ tree node and select ''Makefile project with Existing Code''. Provide a valid project name and toolchain and click ''Finish.'' | ||
| − | MOOSE should now appear in the user's | + | MOOSE should now appear in the user's "Project Explorer." |
[[File:import_git_proj.png]]--> | [[File:import_git_proj.png]]--> | ||
== Building MOOSE == | == Building MOOSE == | ||
| − | The [[#Cloning MOOSE|Cloning MOOSE]] step above also creates the two required | + | The [[#Cloning MOOSE|Cloning MOOSE]] step above also creates the two required build targets used to build Libmesh and MOOSE. Libmesh is required for MOOSE to build, so the user should start there. |
===Building Libmesh=== | ===Building Libmesh=== | ||
| − | The | + | The "Build Libmesh" build target will appear in the "Build Targets" view pane. |
| − | Double clicking the | + | Double clicking the "Build Libmesh" target will execute the <tt>sh update_and_rebuild_libmesh.sh</tt> script with the output streaming in the "Console" view pane. |
[[file:Moose_build_libmesh_stc_1.png]] | [[file:Moose_build_libmesh_stc_1.png]] | ||
| Line 89: | Line 87: | ||
===Building MOOSE=== | ===Building MOOSE=== | ||
| − | Once the Libmesh build completes, the user can then execute the | + | Once the Libmesh build completes, the user can then execute the "Build MOOSE" target and the output should stream in the "Console" view pane. |
[[file:Cmake_build_target_stc.png]] | [[file:Cmake_build_target_stc.png]] | ||
| Line 97: | Line 95: | ||
[[file:Moose_build_console_output_stc.png]] | [[file:Moose_build_console_output_stc.png]] | ||
| − | With MOOSE built, the user can start the process of creating their own MOOSE-based application. The first step, | + | With MOOSE built, the user can start the process of creating their own MOOSE-based application. The first step, "Forking the Stork," is described below. |
== Forking the Stork == | == Forking the Stork == | ||
| − | The MOOSE development team provides a GitHub repository called | + | The MOOSE development team provides a GitHub repository called "stork" (located at https://github.com/idaholab/stork) that includes the base structure needed to create a new MOOSE application. So, "Forking the Stork"—as the MOOSE team coined it—implies forking this repository, changing its name to the name of the user's new MOOSE application, and cloning the contents of the repository to the user's local disk. |
| − | ICE provides this functionality through a simple interface, allowing an ICE user to | + | ICE provides this functionality through a simple interface, allowing an ICE user to "Fork the Stork" in a few short steps. |
First, in the main ICE menu, select ''Developer'' > ''Framework'' > ''MOOSE'' > ''Fork the Stork''. | First, in the main ICE menu, select ''Developer'' > ''Framework'' > ''MOOSE'' > ''Fork the Stork''. | ||
| Line 112: | Line 110: | ||
[[File:fork_dialog.png]] | [[File:fork_dialog.png]] | ||
| − | Once the user has provided this information and clicked ''Finish'', ICE will fork the | + | Once the user has provided this information and clicked ''Finish'', ICE will fork the "stork" repository (located at https://github.com/idaholab/stork), rename it to the provided application name, clone it to <tt>~/ICEFiles</tt> on the user's local disk, and import it into ICE as a new C++ project in the C/C++ perspective's "Project Explorer" view pane. |
[[File:new_app.png]] | [[File:new_app.png]] | ||
| Line 120: | Line 118: | ||
== Adding a New Kernel == | == Adding a New Kernel == | ||
| − | + | The user can easily create custom Kernels with ICE once they have cloned, built, and "Forked the Stork" to produce a new MOOSE application. | |
| + | |||
| + | To create a new Kernel, right click on the new MOOSE-based application project and select ''New'' > ''MOOSE Object'' > ''Kernel''. | ||
[[File:new_kernel.png]] | [[File:new_kernel.png]] | ||
| − | This action will | + | This action will prompt the user for the name of the new Kernel subclass. |
| + | |||
| + | Simply enter the desired name and click ''OK''. | ||
| + | |||
| + | [[file:kernel_name_dialog.png]] | ||
| + | |||
| + | ICE will automatically generate a new include and source file in <tt>include/kernel</tt> and <tt>src/kernel</tt>, respectively. | ||
| + | |||
| + | These new files are the stubbed out, base implementation of a subclassed Kernel can be modified to fit the user's operation. | ||
[[File:kernel_source.png]] | [[File:kernel_source.png]] | ||
== Building your MOOSE App == | == Building your MOOSE App == | ||
| − | Building the newly-created MOOSE application is simple because the | + | Building the newly-created MOOSE application is simple because the "Fork the Stork" action also produced a build target (make all) for the user. |
| − | + | ||
| − | + | ||
| − | Navigate to the | + | Navigate to the "Build Target" view pane and double click on ''make all'' (the new build target). |
| − | + | [[File:make_target.png]] | |
| − | The | + | The new MOOSE application will then build, producing an application executable. Note that this will take some time. |
| − | + | [[file:animals_build_console_output.png]] | |
== Pushing Changes Back to GitHub == | == Pushing Changes Back to GitHub == | ||
| − | As the user makes modifications to their project, they will want to periodically commit or | + | As the user makes modifications to their project, they will want to periodically commit or "push" these changes to their GitHub repository. |
===Git Perspective=== | ===Git Perspective=== | ||
| − | The first step is to open the | + | The first step is to open the "Git Perspective" by clicking the ''Open Perspective'' button in the upper right hand corner of ICE. |
[[file:ICE_OpenPerspective.png]] | [[file:ICE_OpenPerspective.png]] | ||
| − | Next, select 'Git' from the resulting prompt | + | Next, select ''Git'' from the resulting prompt and click ''OK''. |
[[file:Open_git_perspective_stc_2.png]] | [[file:Open_git_perspective_stc_2.png]] | ||
| Line 158: | Line 164: | ||
[[file:Git_perspective_button_stc.png]] | [[file:Git_perspective_button_stc.png]] | ||
| − | Click the ''Git'' perspective button to bring up the Git interface pane in the main ICE window. The user should now see the repository for their MOOSE-based application in the | + | Click the ''Git'' perspective button to bring up the Git interface pane in the main ICE window. The user should now see the repository for their MOOSE-based application in the "Git Repositories" view pane (left), "animals" in this case. |
[[file:Git_repos_view_stc.png]] | [[file:Git_repos_view_stc.png]] | ||
| Line 164: | Line 170: | ||
===Push Changes=== | ===Push Changes=== | ||
| − | To push | + | To push project changes/modifications to the remote GitHub repository, switch to the Git perspective, as above, and select the desired repository in the "Git Repositories" view pane. |
| − | The | + | The "Git Repositories" view includes a new set of tabbed views. Select the ''Git Staging'' tab to pull up the "Git Staging" view pane. |
[[file:Git_commit.png]] | [[file:Git_commit.png]] | ||
| − | Drag any | + | Drag any "Unstaged Changes" to the "Staged Changes" section. |
| − | Provide a brief | + | Provide a brief message describing the nature of the commit. |
| − | Finally, click ''Commit and Push,'' enter | + | Finally, click ''Commit and Push,'' enter the GitHub credentials if/when prompted, and watch as the new files are committed to the remote repository! |
== Executing Built MOOSE Application == | == Executing Built MOOSE Application == | ||
Now that you've developed a new MOOSE application you need to develop input files for it and execute it to see your desired results. This is simple with ICE: just use the built in MOOSE Model Builder and MOOSE Launcher Items. Detailed instructions can be found at [[Using MOOSE with ICE]]. | Now that you've developed a new MOOSE application you need to develop input files for it and execute it to see your desired results. This is simple with ICE: just use the built in MOOSE Model Builder and MOOSE Launcher Items. Detailed instructions can be found at [[Using MOOSE with ICE]]. | ||
Latest revision as of 10:26, 23 November 2016
Contents
Introduction
This article is designed to guide users through a typical workflow for developing MOOSE-based applications in ICE. Since ICE is built on top of the Eclipse platform, a large variety of sophisticated tools and technologies for developing scientific software can be leveraged for developing MOOSE applications.
Version control, code editing, code completion, code building, and code generation are just a few of the technologies available to MOOSE-based application developers using ICE. Additionally, after the user develops a custom MOOSE application, the usual MOOSELauncher and MOOSEModel items—along with the ICE Visualization perspective—are still at their disposal for constructing input files, launching jobs, and visualizing results.
Prerequisites
To use the MOOSE support in ICE, the user will need to have MOOSE installed on their system along with any MOOSE-based application that the user would like to run. The user can simply use "moose_test" as the project name if no other application is available (the example in this tutorial uses the name "animals").
Please note that installing MOOSE requires the user to add several packages (prerequisites) to their system. For more information on how to install MOOSE and the prerequisites for doing so, please check out the MOOSE Getting Started guide.
For Mac OS X users, ICE developers also recommend installing the Homebrew package manager to ensure all required packages and their dependencies are available to the user.
Cloning MOOSE
The latest version of ICE makes cloning MOOSE very simple.
In the main ICE window, click Developer > Framework > MOOSE > Clone Moose.
This step will automatically connect to the MOOSE GitHub repository, create a local clone on the user's disk, and import MOOSE into the "Project Explorer."
Building MOOSE
The Cloning MOOSE step above also creates the two required build targets used to build Libmesh and MOOSE. Libmesh is required for MOOSE to build, so the user should start there.
Building Libmesh
The "Build Libmesh" build target will appear in the "Build Targets" view pane.
Double clicking the "Build Libmesh" target will execute the sh update_and_rebuild_libmesh.sh script with the output streaming in the "Console" view pane.
Note that this process will take some time.
Building MOOSE
Once the Libmesh build completes, the user can then execute the "Build MOOSE" target and the output should stream in the "Console" view pane.
Note that this process will take some time.
With MOOSE built, the user can start the process of creating their own MOOSE-based application. The first step, "Forking the Stork," is described below.
Forking the Stork
The MOOSE development team provides a GitHub repository called "stork" (located at https://github.com/idaholab/stork) that includes the base structure needed to create a new MOOSE application. So, "Forking the Stork"—as the MOOSE team coined it—implies forking this repository, changing its name to the name of the user's new MOOSE application, and cloning the contents of the repository to the user's local disk.
ICE provides this functionality through a simple interface, allowing an ICE user to "Fork the Stork" in a few short steps.
First, in the main ICE menu, select Developer > Framework > MOOSE > Fork the Stork.
The resulting dialog will prompt the user for the name of their new MOOSE application ("animals" in this case), as well as their GitHub username and password.
Once the user has provided this information and clicked Finish, ICE will fork the "stork" repository (located at https://github.com/idaholab/stork), rename it to the provided application name, clone it to ~/ICEFiles on the user's local disk, and import it into ICE as a new C++ project in the C/C++ perspective's "Project Explorer" view pane.
To look at a MOOSE class referenced in one of the new MOOSE application's source files, simply click the class name or the header file and click F3. ICE will take the user directly to the declaration for that MOOSE class so they can peruse and look up its method definitions.
Adding a New Kernel
The user can easily create custom Kernels with ICE once they have cloned, built, and "Forked the Stork" to produce a new MOOSE application.
To create a new Kernel, right click on the new MOOSE-based application project and select New > MOOSE Object > Kernel.
This action will prompt the user for the name of the new Kernel subclass.
Simply enter the desired name and click OK.
ICE will automatically generate a new include and source file in include/kernel and src/kernel, respectively.
These new files are the stubbed out, base implementation of a subclassed Kernel can be modified to fit the user's operation.
Building your MOOSE App
Building the newly-created MOOSE application is simple because the "Fork the Stork" action also produced a build target (make all) for the user.
Navigate to the "Build Target" view pane and double click on make all (the new build target).
The new MOOSE application will then build, producing an application executable. Note that this will take some time.
Pushing Changes Back to GitHub
As the user makes modifications to their project, they will want to periodically commit or "push" these changes to their GitHub repository.
Git Perspective
The first step is to open the "Git Perspective" by clicking the Open Perspective button in the upper right hand corner of ICE.
Next, select Git from the resulting prompt and click OK.
The user should now have the Git perspective button available on the ICE toolbar.
Click the Git perspective button to bring up the Git interface pane in the main ICE window. The user should now see the repository for their MOOSE-based application in the "Git Repositories" view pane (left), "animals" in this case.
Push Changes
To push project changes/modifications to the remote GitHub repository, switch to the Git perspective, as above, and select the desired repository in the "Git Repositories" view pane.
The "Git Repositories" view includes a new set of tabbed views. Select the Git Staging tab to pull up the "Git Staging" view pane.
Drag any "Unstaged Changes" to the "Staged Changes" section.
Provide a brief message describing the nature of the commit.
Finally, click Commit and Push, enter the GitHub credentials if/when prompted, and watch as the new files are committed to the remote repository!
Executing Built MOOSE Application
Now that you've developed a new MOOSE application you need to develop input files for it and execute it to see your desired results. This is simple with ICE: just use the built in MOOSE Model Builder and MOOSE Launcher Items. Detailed instructions can be found at Using MOOSE with ICE.