readme.txt
How to use the GUI to install openmc and prerequisistes under miniconda3
This tutorial is tested for ubuntu 23.04, miniconda3 and python 3.7 3.9 and 3.11
The new version of ERSN-OpenMC-Py 1.2 allows to post-process tallies created by combining up to 6 filters.
The next version of ERSN-OpenMC-Py 1.3 will allow to normalize tallies to cell volume, core power, unit lethargy and bin width

Prof. Tarek El Bardouni and Doctor Mohamed Lahdour, University Abdelmalek Essaadi, Radiatios and Nuclear System Team, Tetouan, Morocco
Emails: [email protected]    and [email protected]

A/ First make an update of your system and install the following packages if they don't exist:

	sudo apt update
	sudo apt upgrade

	sudo apt install g++ cmake libhdf5-dev libpng-dev

B/ Before running the GUI: install python3-pyqt5

	sudo apt install python3-pyqt5

or 

	sudo apt install pyqt5-dev pyqt5-dev-tools

C/ install git

	sudo apt install git

D/ extract the contents of the archive and run the application from its directory by executing :

	python3 gui.py


1. In the tab "get openmc" install miniconda3 and update its packages

2. close the gui

3. close and reopen the terminal

4. make sure the conda is activated

5. as pyqt5 is not yet installed under conda, if the GUI doesn't work, run it by executing :

	/usr/bin/python3 gui.py

insteade of : python3 gui.py

6. install prerequisites
	- Before installing prerequisites it is better to update miniconda on terminal or from the gui.
	- If the update frozes in "Solving environment" step an issue is:
		- delete the file : ~/.condarc
		- then set channel priority : conda config --set channel_priority flexible


	It's better to close the gui after prequisites installing is finished, then in a terminal activate the created openmc environment, 
         for example: conda activate openmc-py3.7
         
	If you can not run the gui because pyqt5 is not installed under conda, try the command in a terminal : 
         ==> Command : pip install pyqt5

         ==> If QtCore module cannot be loaded from PyQt5 force reinstall PyQt5 <==
         ==> Command : python3 -m pip install --upgrade --force-reinstall PyQt5 <==
            
         ==> For changes to take effect, close and re-open your current shell. <==
         

7. install openmc from the tab named "Install openmc: Inthernet connexion must be enabled

	If compiling openmc crashes repeat its installation. If the compiling still doesn't work properly because of old version of cmake, 
	reinstall cmake under conda by : 
		==> command : conda install cmake

8. download neutron data from the tab named "Get Cross Sections"

E/ runing openmc under the GUI

	Use the script bellow to lunch the gui to run openmc :

		conda activate openmc-py3.7

		export OPENMC_CROSS_SECTIONS=$HOME/Py-OpenMC-2024/data/endfb71_hdf5/cross_sections.xml      if endfb71_hdf5 has been downloaded

		python3 gui.py

	To run the two first commands automaticaly, each time the terminal is opened, add them to the .bashrc file.

	Note that the variable OPENMC_CROSS_SECTIONS must point to the correct path of downloaded cross sections data folder

F/ OpenMC could fail when installed under python 3.11
	You are using Python 3.11. The inspect (core library module) has changed since Python 3.7
	The following error could be accounterd while runing openmc under python3.11 environment:
 	File "/home/tarek/miniconda3/envs/openmc-py3.11/lib/python3.11/site-packages/uncertainties/core.py", line 583, in wrap
    	argspec = getargspec(f)
              ^^^^^^^^^^
	NameError: name 'getargspec' is not defined. Did you mean: 'argspec'?

	Prolem is resolved by replacing in file envs/openmc-py3.11/lib/python3.11/site-packages/uncertainties/core.py
	argspec = getargspec(f)
	by
	argspec = inspect.getfullargspec(f)


G/ 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.