Rachel GUI

From GOSIA

Jump to: navigation, search
(update for 1.1.2)
(Changed installation to include forking the git repo.)
 
Line 3: Line 3:
[[File:Guisnapshot.png|thumb|right|A snapshot of the alpha version GUI.]]
[[File:Guisnapshot.png|thumb|right|A snapshot of the alpha version GUI.]]
-
For a very short video demo of capabilities, refer to the "advertising video": [http://www.pas.rochester.edu/~hayes/beta_rachel/main_ad.html The Rachel advertising video]
+
For a demo of Rachel's capabilities, watch [http://youtu.be/moVVC-GODzQ The Rachel Video on Youtube], or [http://www.pas.rochester.edu/~hayes/beta_rachel/main_ad.html Download the mp4 (9MB)].
The Rachel interface facilitates [http://www.pas.rochester.edu/~hayes/beta_rachel/calculation_in_2_minutes.html fast setup of Gosia calculations] and data analysis using push-button controls with guided input and 'plain language' warnings during setup.  Rachel is written in Python 2.6 and is expected to be Python 2.7 compliant.  It runs under Linux and Unix (OS X) machines.  A Windows version is not planned.
The Rachel interface facilitates [http://www.pas.rochester.edu/~hayes/beta_rachel/calculation_in_2_minutes.html fast setup of Gosia calculations] and data analysis using push-button controls with guided input and 'plain language' warnings during setup.  Rachel is written in Python 2.6 and is expected to be Python 2.7 compliant.  It runs under Linux and Unix (OS X) machines.  A Windows version is not planned.
-
A 64-bit processor is essential, because Gosia runs fastest and most accurately on 64-bit machines.  The release-candidate version, expected in the September of 2011, will have many structural changes in the code, allowing more automation, more general particle detector options and fewer user prompts for standard operations.   
+
A 64-bit processor is essential, because Gosia runs fastest and most accurately on 64-bit machines.  Versions 1.* have many structural changes in the code, allowing more automation, more general particle detector options and fewer user prompts for standard operations.   
[[File:Typicalgosiainput.png|thumb|right|Excerpt of a typical Gosia input for a collective system.]]While gosia.20081208 incorporates the [[OP,BRIC]] command to read internal conversion data from BrIcc data files, removing the burden of entering ICC interpolation data by the user, the GUI allows the greatest possible automation by prompts for pre-defined or user-defined germanium detector crystals or arrays, calculation of Zeigler stopping power data, optimum meshpoint selection for yield calculations, transformation of rectilinear detector definition to laboratory-frame spherical-polar interpolation coordinates, etc.  For standard problems, the burden on the user is reduced to entering nuclear level and matrix data for simulations (including optional data-set simulation) and real experimental data for fitting of matrix elements.  For collective systems, where the matrix definition often includes several hundred lines of matrix elements, rotor parameters can be given to reduce the setup time for the initial guesses of matrix element values.  This also eliminates the need for the user to re-index the reduced matrix elements by hand as changes are made to the matrix or level scheme.
[[File:Typicalgosiainput.png|thumb|right|Excerpt of a typical Gosia input for a collective system.]]While gosia.20081208 incorporates the [[OP,BRIC]] command to read internal conversion data from BrIcc data files, removing the burden of entering ICC interpolation data by the user, the GUI allows the greatest possible automation by prompts for pre-defined or user-defined germanium detector crystals or arrays, calculation of Zeigler stopping power data, optimum meshpoint selection for yield calculations, transformation of rectilinear detector definition to laboratory-frame spherical-polar interpolation coordinates, etc.  For standard problems, the burden on the user is reduced to entering nuclear level and matrix data for simulations (including optional data-set simulation) and real experimental data for fitting of matrix elements.  For collective systems, where the matrix definition often includes several hundred lines of matrix elements, rotor parameters can be given to reduce the setup time for the initial guesses of matrix element values.  This also eliminates the need for the user to re-index the reduced matrix elements by hand as changes are made to the matrix or level scheme.
Line 13: Line 13:
==How to get the Rachel package==
==How to get the Rachel package==
-
Release version 1.1.2 is now available.  This version does not read beta-version files, but level schemes and matrices can be ported following the instructions in the 2012 version of the Gosia manual.  Refer to the [[gui_release_notes | release notes]] for the change in this version and known issues.
+
Get the latest release version from the [[Gosia#Downloads | Downloads section on the Main Page]].
-
[http://www.pas.rochester.edu/~hayes/rachel_1/rachel_1.1.2.tar Rachel 1.1.2 download]
+
==Version notes==
 +
 
 +
The [[Gui_release_notes | version notes page]] gives a history of Rachel updates. Known issues are given for each version, as well as the current version.
==Installation notes==
==Installation notes==
Line 21: Line 23:
===General===
===General===
-
Rachel has been installed successfully on the following systems.  You can view or submit detailed installation notes for these or other systems.  (Please link them to a separate Wiki page.)
+
A script was added by Mitch Allmond that compiles and sets up Rachel, Gosia and Elast in one step.  First, un-tar the distribution, or pull the git repo from the [[Gosia#Downloads | Downloads section on the Main Page]].  Please fork it and make pull requests if you have anything to contribute.
 +
 
 +
<pre>
 +
% tar -xvf rachel_distribution_1.3.0.tar
 +
</pre>
 +
 
 +
or similar for the correct version number.  Move into the new Rachel directory and run compile-all.sh:
 +
 
 +
<pre>
 +
% cd rachel_distribution_1.3.0
 +
% ./compile-all.sh
 +
</pre>
 +
 
 +
You will be prompted if any previous setup information needs to be overwritten.
 +
 
 +
Rachel has been installed successfully on a number of Linux and OS X systems.  Most problems are related to the level scheme graphics.  Refer to [http://matplotlib.sourceforge.net/faq/installing_faq.html#backends matplotlib backends] for remedies.  You can view or submit detailed installation notes for any particular operating system.  (Please link them to a separate Wiki page.)
If the default python environment set in the rachel.py executable is not appropriate, the following error will appear:
If the default python environment set in the rachel.py executable is not appropriate, the following error will appear:
Line 63: Line 80:
In the beta versions, the GUI preserves backward-compatibility of the saved session files, so that users can upgrade the GUI without having to rebuild the session.
In the beta versions, the GUI preserves backward-compatibility of the saved session files, so that users can upgrade the GUI without having to rebuild the session.
-
When the release candidate becomes available, users will have to rebuild their sessions, because of major changes in the internal structure that cannot be automatically upgraded.  This can be aided by the export/import tools for the level and matrix data.
+
When changing to version 1.0 or later, users will have to rebuild their sessions, because of major changes in the internal structure that cannot be automatically upgraded.  This can be aided by the export/import tools for the level and matrix data. Subsequent versions will have the automatic upgrading reinstated.
 +
 
 +
==Graphics Issues==
 +
 
 +
If you do not see a level scheme diagram after loading a level scheme or a saved session, click "Examine fig. window" once.  The level scheme should then appear.
 +
 
 +
If it does not, or if the level scheme window buttons (zoom, pan, etc.) do not work, you may need to change the graphics back-end.  The matplotlib graphics library used for the level scheme and particle detector layout comes with several choices of back-ends. 
 +
 
 +
*On OS X machines, "macosx" may work best.
 +
*On Ubuntu, GTKAgg works best, but the user must click "Examine fig. window" 'once' after loading a level scheme or saved session.
 +
 
 +
The back-end is in the matplotlibrc file in the .matplotlib directory, or will be, after you start Rachel for the first time.
 +
 
 +
<pre>
 +
hayes@Sobchak:~$ cd .matplotlib/
 +
hayes@Sobchak:~/.matplotlib$ ll
 +
total 116K
 +
drwxr-xr-x  3 hayes hayes 4.0K Nov  5 12:30 ./
 +
drwxr-xr-x 125 hayes hayes  12K Nov  5 12:53 ../
 +
-rw-r--r--  1 hayes hayes  92K Oct 27 13:13 fontList.cache
 +
-rw-r--r--  1 hayes hayes  17 Aug 19 02:09 matplotlibrc
 +
drwxrwxr-x  2 hayes hayes 4.0K Oct 27 13:13 tex.cache/
 +
hayes@Sobchak:~/.matplotlib$ cat matplotlibrc
 +
backend : GTKAgg
 +
hayes@Sobchak:~/.matplotlib$
 +
</pre>
 +
 
 +
Change the backend line as desired.  The choices are found
-
In the release versions, automatic upgrading of saved sessions will be reinstated.
 
==Capabilities of version 1==
==Capabilities of version 1==
Line 115: Line 158:
===Planned upgrades===
===Planned upgrades===
-
There are a number of planned upgrades, ''some'' of which will be incorporated in the first [[rachel_release_candidate | release candidate] version.  The upgrade plan and priorities will be changed based on user feedback and bug reports.   
+
There are a number of planned upgrades, many of which have already been added to versions 1.0 and later.  The upgrade plan and priorities will be changed based on user feedback and bug reports.   
# More accurate stopping power calculations for low-Z beams.
# More accurate stopping power calculations for low-Z beams.

Latest revision as of 13:07, 17 May 2013

Personal tools