Changed License and Updated README

.github/workflows/main.yml

@@ -12,7 +12,7 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - run: sudo apt-get install python3-tk
-      - run: pip install ttkthemes
+      - run: pip install sv-ttk
       - run: pip install pandas
       - run: pip install matplotlib
       - run: pip install typing-extensions

LICENSE

@@ -1,165 +1,29 @@
-                   GNU LESSER GENERAL PUBLIC LICENSE
-                       Version 3, 29 June 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-
-  This version of the GNU Lesser General Public License incorporates
-the terms and conditions of version 3 of the GNU General Public
-License, supplemented by the additional permissions listed below.
-
-  0. Additional Definitions.
-
-  As used herein, "this License" refers to version 3 of the GNU Lesser
-General Public License, and the "GNU GPL" refers to version 3 of the GNU
-General Public License.
-
-  "The Library" refers to a covered work governed by this License,
-other than an Application or a Combined Work as defined below.
-
-  An "Application" is any work that makes use of an interface provided
-by the Library, but which is not otherwise based on the Library.
-Defining a subclass of a class defined by the Library is deemed a mode
-of using an interface provided by the Library.
-
-  A "Combined Work" is a work produced by combining or linking an
-Application with the Library.  The particular version of the Library
-with which the Combined Work was made is also called the "Linked
-Version".
-
-  The "Minimal Corresponding Source" for a Combined Work means the
-Corresponding Source for the Combined Work, excluding any source code
-for portions of the Combined Work that, considered in isolation, are
-based on the Application, and not on the Linked Version.
-
-  The "Corresponding Application Code" for a Combined Work means the
-object code and/or source code for the Application, including any data
-and utility programs needed for reproducing the Combined Work from the
-Application, but excluding the System Libraries of the Combined Work.
-
-  1. Exception to Section 3 of the GNU GPL.
-
-  You may convey a covered work under sections 3 and 4 of this License
-without being bound by section 3 of the GNU GPL.
-
-  2. Conveying Modified Versions.
-
-  If you modify a copy of the Library, and, in your modifications, a
-facility refers to a function or data to be supplied by an Application
-that uses the facility (other than as an argument passed when the
-facility is invoked), then you may convey a copy of the modified
-version:
-
-   a) under this License, provided that you make a good faith effort to
-   ensure that, in the event an Application does not supply the
-   function or data, the facility still operates, and performs
-   whatever part of its purpose remains meaningful, or
-
-   b) under the GNU GPL, with none of the additional permissions of
-   this License applicable to that copy.
-
-  3. Object Code Incorporating Material from Library Header Files.
-
-  The object code form of an Application may incorporate material from
-a header file that is part of the Library.  You may convey such object
-code under terms of your choice, provided that, if the incorporated
-material is not limited to numerical parameters, data structure
-layouts and accessors, or small macros, inline functions and templates
-(ten or fewer lines in length), you do both of the following:
-
-   a) Give prominent notice with each copy of the object code that the
-   Library is used in it and that the Library and its use are
-   covered by this License.
-
-   b) Accompany the object code with a copy of the GNU GPL and this license
-   document.
-
-  4. Combined Works.
-
-  You may convey a Combined Work under terms of your choice that,
-taken together, effectively do not restrict modification of the
-portions of the Library contained in the Combined Work and reverse
-engineering for debugging such modifications, if you also do each of
-the following:
-
-   a) Give prominent notice with each copy of the Combined Work that
-   the Library is used in it and that the Library and its use are
-   covered by this License.
-
-   b) Accompany the Combined Work with a copy of the GNU GPL and this license
-   document.
-
-   c) For a Combined Work that displays copyright notices during
-   execution, include the copyright notice for the Library among
-   these notices, as well as a reference directing the user to the
-   copies of the GNU GPL and this license document.
-
-   d) Do one of the following:
-
-       0) Convey the Minimal Corresponding Source under the terms of this
-       License, and the Corresponding Application Code in a form
-       suitable for, and under terms that permit, the user to
-       recombine or relink the Application with a modified version of
-       the Linked Version to produce a modified Combined Work, in the
-       manner specified by section 6 of the GNU GPL for conveying
-       Corresponding Source.
-
-       1) Use a suitable shared library mechanism for linking with the
-       Library.  A suitable mechanism is one that (a) uses at run time
-       a copy of the Library already present on the user's computer
-       system, and (b) will operate properly with a modified version
-       of the Library that is interface-compatible with the Linked
-       Version.
-
-   e) Provide Installation Information, but only if you would otherwise
-   be required to provide such information under section 6 of the
-   GNU GPL, and only to the extent that such information is
-   necessary to install and execute a modified version of the
-   Combined Work produced by recombining or relinking the
-   Application with a modified version of the Linked Version. (If
-   you use option 4d0, the Installation Information must accompany
-   the Minimal Corresponding Source and Corresponding Application
-   Code. If you use option 4d1, you must provide the Installation
-   Information in the manner specified by section 6 of the GNU GPL
-   for conveying Corresponding Source.)
-
-  5. Combined Libraries.
-
-  You may place library facilities that are a work based on the
-Library side by side in a single library together with other library
-facilities that are not Applications and are not covered by this
-License, and convey such a combined library under terms of your
-choice, if you do both of the following:
-
-   a) Accompany the combined library with a copy of the same work based
-   on the Library, uncombined with any other library facilities,
-   conveyed under the terms of this License.
-
-   b) Give prominent notice with the combined library that part of it
-   is a work based on the Library, and explaining where to find the
-   accompanying uncombined form of the same work.
-
-  6. Revised Versions of the GNU Lesser General Public License.
-
-  The Free Software Foundation may publish revised and/or new versions
-of the GNU Lesser General Public License from time to time. Such new
-versions will be similar in spirit to the present version, but may
-differ in detail to address new problems or concerns.
-
-  Each version is given a distinguishing version number. If the
-Library as you received it specifies that a certain numbered version
-of the GNU Lesser General Public License "or any later version"
-applies to it, you have the option of following the terms and
-conditions either of that published version or of any later version
-published by the Free Software Foundation. If the Library as you
-received it does not specify a version number of the GNU Lesser
-General Public License, you may choose any version of the GNU Lesser
-General Public License ever published by the Free Software Foundation.
-
-  If the Library as you received it specifies that a proxy can decide
-whether future versions of the GNU Lesser General Public License shall
-apply, that proxy's public statement of acceptance of any version is
-permanent authorization for you to choose that version for the
-Library.
+BSD 3-Clause License
+
+Copyright (c) 2024, newcleo S.p.A.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.rst

@@ -1,4 +1,4 @@
-TuGUI
+TUGUI
 =====
 
 .. image:: resources/icons/newcleologo_hd.png
@@ -7,23 +7,28 @@ TuGUI
 
 :Author: Davide Manzione, Elena Travaglia
 :Contributor: Daniele Tomatis, Gabriele Ottino
-:Date: 11/06/2024
+:Date: 30/08/2024
 
 Introduction
 ------------
 
-**TuGUI** is a Python-based application intended for providing the
+**TUGUI** is a Python-based application intended for providing the
 *Transuranus Fuel Performance code*
 (`TRANSURANUS <https://data.jrc.ec.europa.eu/collection/transuranus>`_) with
 a post-processing GUI.
 
-**TuGUI** allows the user to configure the plot area and select the quantities
+**TUGUI** allows the user to configure the plot area and select the quantities
 to be plotted from those available in the *TRANSURANUS* results file.
 
-*tugui* is developed by the **Codes & Methods** group of
-`newcleo <https://www.newcleo.com/>`_ in partnership with the
-`JRC-EC <https://commission.europa.eu/about-european-commission/departments-and-executive-agencies/joint-research-centre_en>`_
-and it is released under the **GNU Lesser General Public License 3**.
+**TUGUI** is developed by the **Codes & Methods** group of
+`*new*\cleo <https://www.newcleo.com/>`_ and it is released under the
+**BSD 3-Clause License**.
+
+**DISCLAIMER:** **TUGUI** project must not contain any confidential or
+proprietary content of *TRANSURANUS*. The user must address a license request
+for the **Transuranus Software Package (Version v1m1j24)** to
+`JRC-EC <https://commission.europa.eu/about-european-commission/departments-and-executive-agencies/joint-research-centre_en>`_.
+**Transuranus Software Package** is not distributed with **TUGUI**.
 
 Project Structure
 -----------------
@@ -44,17 +49,15 @@ The project is organized according to the following folder structure:
 - ``docs``: contains files for the generation of the documentation by Sphinx;
 - ``resources``: contains files that support the configuration and operation of the GUI;
 - ``tests``: contains input files needed for test purposes;
-- ``tugui``: contains all modules, classes and methods implemented in *tugui*.
-
-*The structure of the repo is currently being defined.*
+- ``tugui``: contains all modules, classes and methods implemented in **TUGUI**.
 
 Dependencies
 ------------
 
 To run the code, the following dependencies must be satisfied:
 
 - ``Python`` :math:`>= 3.11+`
-- ``TtkThemes`` :math:`>= 3.2.2`
+- ``sv-ttk`` :math:`>= 2.6.0`
 - ``Pandas`` :math:`>= 2.2.2`
 - ``MatplotLib`` :math:`>= 3.9.0`
 - ``Typing-extensions`` :math:`>= 4.12.2`
@@ -70,7 +73,7 @@ dependencies must be satisfied:
 How to Install
 --------------
 
-To install the *tugui* application, please be sure that all the dependencies
+To install the **TUGUI** application, please check that all the dependencies
 are met, and then clone the repository at
 https://github.com/newcleo-dev-team/tugui using the following command:
 
@@ -81,46 +84,40 @@ https://github.com/newcleo-dev-team/tugui using the following command:
 How to Use
 ----------
 
-To open the GUI, the following command needs to be run from the command prompt:
+To open the GUI, run the following command from the command prompt:
 
   .. code-block:: bash
 
     python tugui/main.py
 
-To generate the plots from the results of a *TRANSURANUS* simulation, **TuGUI**
+To generate the plots from the results of a *TRANSURANUS* simulation, **TUGUI**
 relies on the execution of one of the executables (``TuPlot`` or ``TuStat``,
 depending on the case) that extract the *X*-*Y* data for the curves to be
 plotted. In particular:
 
 - JRC-EC distributes the Windows-OS version of these executables in the
-  ``PostProcessors/TuOutGUI/Exe-Files`` of the *TRANSURANUS* code release;
+  ``PostProcessors/TuOutGUI/Exe-Files`` of the *Transuranus Software Package*;
   please note that such executables may limit some functionalities of
-  **TuGUI**, since *batch mode* is not activated;
+  **TUGUI**, since *batch mode* is disabled;
 
 - the FORTRAN source code of the above executables is provided as well
   in the ``PostProcessors/TuPlot`` and ``PostProcessors/TuStat`` folders,
   correspondingly. Linux users can compile the Linux-OS version of the same
   executables using the ``gfortran`` compiler (*10.+* version). Windows users
-  can do the same by using appropriate FORTRAN compiler.
-
-Please note: when compiling both *TuPlot* and *TuStat*, the *batch mode* must
-be enabled in the code on both Windows and Linux systems to make **TuGUI**
-work properly, that is:
+  can do the same by using appropriate FORTRAN compiler. We recommend
+  *Silverfrost FTN95* as FORTRAN compiler on Windows Operative Systems.
 
-- ``TuPlot``:
-   - open ``PostProcessors/TuPlot/TuPlot.f95`` file;
-   - comment line 98 ``iMode = 1``;
-   - uncomment line 102 ``iMode = 3``.
 
-- ``TuStat``:
-   - open ``PostProcessors/TuStat/tustat.f95`` file;
-   - comment line 92 ``iMode = 1``;
-   - uncomment line 98 ``iMode = 3``.
+**Please note**: when compiling both *TuPlot* and *TuStat*, the *batch mode*
+must be enabled in the code on both Windows and Linux systems to make **TUGUI**
+work properly. Please, refer to chapters **15.4** and **16.4.5**,
+respectively, of **TRANSURANUS HANDBOOK** that is distributed within the
+*Transuranus Software Package*.
 
-Once applied these modifications, the user must compile both the executables,
+Once applied these modifications, the user must compile both executables,
 call them ``tuplotgui`` and ``tustatgui`` respectively, 
 and put them into the folder ``tugui/resources/exec`` (to be created) of the
-**TuGUI** project.
+**TUGUI** project.
 
 Documentation
 -------------
@@ -145,3 +142,16 @@ How to Contribute
 For anyone wishing to contribute to the development of the project, report
 issues or problems with the software, or request support, please refer to this
 `web page <https://github.com/newcleo-dev-team/tugui/blob/master/CONTRIBUTIONS.rst>`_.
+
+Developers issuing pull requests for consideration and acceptance of their
+work into the main development branch of **TUGUI** must first verify that no
+original content of the *Transuranus Software Package* is contained in their
+own development.
+
+Acknowledgement
+---------------
+
+*new*\cleo is thankful to the *TRANSURANUS* development team of
+`JRC-EC Karlsruhe <https://commission.europa.eu/about-european-commission/departments-and-executive-agencies/joint-research-centre_en>`_
+for distributing their software to *new*\cleo and for supporting the
+development of **TUGUI**.

tugui/gui_widgets.py

@@ -67,13 +67,13 @@ class StatusBar(ttk.Frame):
   Class describing a Frame where a label is shown. This represents a status bar
   that provides useful log to the user.
   """
-  def __init__(self, container: tk.Misc, color: str = 'light gray') -> None:
+  def __init__(self, container: tk.Misc) -> None:
     # Initialize the Style object
     s: ttk.Style = ttk.Style()
     # Configure the style for the status bar frame
-    s.configure('self.TFrame', background=color, border=1, borderwidth=1, relief=tk.GROOVE)
+    s.configure('self.TFrame', border=1, borderwidth=1, relief=tk.GROOVE)
     # Configure the style for the status bar label
-    s.configure('self.TLabel', background=color)
+    s.configure('self.TLabel')
 
     # Call the superclass initializer passing the built style
     super().__init__(container, style='self.TFrame')