real-thu / ersn-openmc

ERSN-OpenMC is a Graphical User Interface for OpenMC Monte Carlo particle transport simulation code, originally developed by Jaafar EL Bakkali & Tarek EL Bardouni, members of Radiation and Nuclear Systems Group ERSN at University Abdelmalek Essaady in Tetouan (Morocco).

ERSN-OpenMC is a Graphical User Interface for OpenMC Monte Carlo particle transport simulation code, originally developed by Jaafar EL Bakkali & Tarek EL Bardouni, membres of Radiation and Nuclear Systems Group (ERSN; Equipe Radiations et Systèmes Nucléaires) at Faculty of Sciences Tetouan (Morocco).This java-based application has been created to provide a user-friendly human-computer interface using OpenMC Monte Carlo code as a neutrons transport calculation engine. This java-based application allows the creation/edition of separate mandatory XML files describing the geometry, the materials involved and the settings of a given OpenMC simulation. The creation/edition facility allows also the creation of optional xml files such as tallies (results of given simulation), plotting and CMFD (Coarse-Mesh Finite Difference) acceleration. The ERSN-OpenMC will help the OpenMC users to avoid hardcoding full content of those XML files when creating, editing its. In order to displaying the user application xml files in a more readable way; the syntax highlighter approach has been considered where the open source java library jsyntaxpane has been used as a default highlighter for those xml files.

1 - Getting ERSN-OpenMC application
For Ubuntu machines you need the following :

1. update the OS:
$ sudo apt-get update

$ sudo apt-get upgrade

2. install java 8 (not tested with java 9):

$ sudo add-apt-repository ppa:webupd8team/java

$ sudo apt-get update

$ sudo apt-get install oracle-java8-installer


3. download the ERSN-OpenMC GUI from :

https://github.com/tarekbardouni/ERSN-OpenMC/releases

4. untar the archive and double-click on the extracted binary file to run it under java

Don't forget to change the permissions (chmod +x) of the contents of ./bin/scripts folder

5. Install the prerequisites first, then install openMC (you will be asked to enter the sudoer password)

2 - Creating new OpenMC project with ERSN-OpenMC application

This java-based application allows user to create new OpenMC project via the following form:

Once the user click on "create project" button a new OpenMC project will be created automatically.

The utility makes the download, compilation and installation of OpenMC code and related libraries, happen automatically and transparent to the user.

The user can choose an isotope from a table of nuclides and select physical quantities to be scored as we can see in the following figure:

3- Using existing installation of Openmc The ERSN-OpenMC has been created to be flexible, the users can link their own installation of OpenMC to the ERSN-OpenMC application, thereby changing the three configuration files as follow:

openmc.dir: user must indicates the full path of openmc executable

cross_sections.dir : full path to the cross_sections.xml file

utils.dir: full path to the sub-directory utils that is located into src directory of openmc

4 - Contribution

Anyone can contribute, even if they have a java programming skills.

5 - For further info

Contact: Jaafar EL Bakkali, at [email protected] or Tarek EL Bardouni, at [email protected]

6 - License

This software is free software; you can redistribute it and / or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. For the complete text of the license see the GPL-web page.