Nuclear Data Section (NDS)
             Department of Nuclear Sciences and Applications
                International Atomic Energy Agency (IAEA)
                Vienna International Centre, P.O. Box 100,
                        A-1400 Vienna, Austria
                Tel:(+43 1) 2600-21714; Fax:(+43 1) 26007
  
        WORKING MATERIALS ON THE DEVELOPMENT OF X4PRO DISTRIBUTION
  
          "X4Pro - universal, fully relational EXFOR database"
              Prepared by Viktor Zerkin, IAEA-NDS, 2021-2023
            Experimental version for MS-Windows, Linux, MacOS
                 Last modified: 2023-06-30 by V.Zerkin

_______________________________________________________________________________

CONTENT

 1) x4sqlite1.db (SQLite): relational database X4Pro-mini* (ver.2023-06-30)
    *Mini-version of the database is incomplete. Full version is also available.
 2) x4pro1: directory with set of python3 and gfortan demo programs to retrieve
    and modify EXFOR data and plot them together with evaluated data retrieved
    from ENDF Web system on http://www-nds.iaea.org/endf
 3) MS-Windows system components*:
    3.a) MinGW with GCC and GNU Fortran-9.2.0
    3.b) Python-3.9.5 with installed packages: plotly-5.7.0,
         matplotlib-3.5.2 and requests-2.27.1
    *Note. Provided to avoid any installation on MS-Windows.
_______________________________________________________________________________

LICENSES

 1) See LICENSE.TXT
 2) For third party software, please see the README, "license.terms" files that 
    come in the associated directories.
_______________________________________________________________________________

DOWNLOAD

 1) Download file "x4pro1-20230630-mini.zip" from Internet:
    https://www-nds.iaea.org/cdroms/x4pro.htm#x4pro1
_______________________________________________________________________________

INSTALL

 Windows*:
 1) Uncompress file "x4pro1-20230630-mini.zip" to HD disk
    (required free space on HD disk: ~2Gb)
 2) start Explorer and create icon "run-x4pro.bat": 
    right-click on the file run-x4pro.bat and select "Send to: Desktop"
 3) start Explorer and create icon "start-x4pro.bat": 
    right-click on the file start-x4pro.bat and select "Send to: Desktop"
 *Note. Windows distibution is portable (having embedded python3, mingw, gfortran)

 Linux/MacOS:
 1) Uncompress file "x4pro1-20230630-mini.zip" to HD disk
    (required free space on HD disk: ~8Gb)
      $ unzip x4pro1-20230630-mini.zip
      $ rm -rf x4pro1pkg/win-*
 2) check python3 (install if you don't have it)
      $ python3 --version
 3) install needed pip3 and python3 packages:
      $ sudo apt-get install python3-pip
      $ pip3 install plotly
      $ pip3 install requests
      $ pip3 install matplotlib
       *Note. You may need to install another version of matplotlib:
      $ pip3 install matplotlib 'matplotlib==3.6.2'
       *Note. If pip3 install fails with error-message:
        "connection error: [SSL: CERTIFICATE_VERIFY_FAILED]..."
      $ pip3 install --trusted-host files.pythonhosted.org \
        --trusted-host pypi.org --trusted-host pypi.python.org 'plotly>=4.0.0'
 4) install and check gfortran
      $ gfortran --version
 5) make fortran executables
      $ cd x4pro1pkg/x4pro1
      $ ./init-lin.sh
_______________________________________________________________________________

STARTUP

 Windows:
 1) Run all demo-examples:
    double click on the icon "run-x4pro.bat - short-cut"
    or run Explorer and double-click on the file "run-x4pro.bat"
 2) Start using package. Set environment and continue working:
    click on the icon "start-x4pro.bat - short-cut"
    or run Explorer and double-click on the file "start-x4pro.bat"
 ...you should have opened cmd - terminal window
    2a) Quick demo test
        x4pro1> bash run-all.sh quick
        ...script will run one test and open Html file in your Web browser...
    2b) Start all demos (or go to selected dir and start individual demo-program)
        x4pro1> bash run-all.sh
        ...script will run all tests and open Html files in your Web browser...
        ...the total running time should be approximately 2-3 minutes....
    2c) Run single example, e.g. script sig1x.py from test-10 in part2-1-sig1/
        x4pro1> cd part2-1-sig1
        part2-1-sig1> python -B sig1x.py "Al-27" "n,a" log lin

 Linux/MacOS:
 1) cd x4pro1pkg/x4pro1
 2) Quick demo test
    $ bash run-all3.sh quick
 ...script will run one test and open Html file in your Web browser...
 3) Start all demos (or go to selected dir and start individual demo-program)
    $ source run-all3.sh
      or
    $ bash run-all3.sh
      or
    $ ./run-all3.sh
 ...programs run one after another and open Html files in your Web browser...
 ...the total running time should be approximately 2-3 minutes....
_______________________________________________________________________________

SWITCH OUTPUT

 Most of the scripts can be switched from using Plotly to Matplotlib and back.

 Windows:
 1) Set Plotly
    x4pro1> bash set1.sh
 2) Set Matplotlib
    x4pro1> bash set2.sh

 Linux/MacOS:
 1) Set Plotly
    $ ./set1.sh
 2) Set Matplotlib
    $ ./set2.sh
_______________________________________________________________________________

Please report setup/runtime errors to V.Zerkin@iaea.org

_______________________________________________________________________________

         ALL PRODUCTS ON THIS PACKAGE ARE PROVIDED IN GOOD FAITH AND 
                    WITHOUT A WARRANTY OF ANY KIND.