V03/smoothemulatorscott - #72

Marking as ready for review and seeking reviewers.

@DanielRPhillips for socialization?

@scottedwardpratt - is there any way that we can make SmoothUtilities part of SmoothEmulator?
If you want to keep them fully separate, then I suggest having part of the install procedure for SmoothEmulator to be to clone the external dependency (probably within SmoothEmulator).

@scottedwardpratt - what is the location of the repo containing smoothutilities?

I am proposing that the user be instructed to git clone this repo from GITHOME_BAND/SmoothEmulator (so that it would show up as a subdirectory of GITHOME_BAND/SmoothEmulator). In general, it would be good for everything needed to be brought in for smoothemulator to be in GITHOME_BAND/SmoothEmulator and not in a parallel file location.

I am proceeding assuming that the instruction will reflect cloning and building commonutils (see below for my suggested way to proceed).

Here are the steps I took:

# Environmental variable
export GITHOME_BAND="/home/wild/oldcomp/repos/bandframework/software"
cd $GITHOME_BAND/SmoothEmulator

# Confirm cmake is around
which cmake

# Download and build eigen 
git clone https://gitlab.com/libeigen/eigen.git
cd eigen
mkdir build_dir
cd build_dir
cmake ../
sudo make install
cd ../..

# Download and build GSL 
sudo apt install libgsl-dev
export GSL_INCLUDE_DIR="/usr/include/gsl/"

# Obtain and build utilities
cd $GITHOME_BAND/SmoothEmulator
git clone git@github.com:scottedwardpratt/commonutils.git
cd commonutils/software
cmake .
make

make is failing due to the error

[  5%] Building CXX object CMakeFiles/msu_commonutils.dir/src/Arrays/arraycalc.cc.o
In file included from /home/wild/oldcomp/repos/bandframework/software/SmoothEmulator/commonutils/software/include/msu_commonutils/arrays.h:4,
                 from /home/wild/oldcomp/repos/bandframework/software/SmoothEmulator/commonutils/software/src/Arrays/arraycalc.cc:1:
/home/wild/oldcomp/repos/bandframework/software/SmoothEmulator/commonutils/software/include/msu_commonutils/commondefs.h:27:10: fatal error: Eigen/Dense: No such file or directory
   27 | #include <Eigen/Dense>
      |          ^~~~~~~~~~~~~
compilation terminated.
make[2]: *** [CMakeFiles/msu_commonutils.dir/build.make:76: CMakeFiles/msu_commonutils.dir/src/Arrays/arraycalc.cc.o] Error 1
make[1]: *** [CMakeFiles/Makefile2:83: CMakeFiles/msu_commonutils.dir/all] Error 2
make: *** [Makefile:91: all] Error 2

I believe that this is because the correct Eigen3 include is not being used.
Suggestions for proceeding @scottedwardpratt ?

Scott says:

it’s ready to be looked at.

To clone the repo:
% git clone https://github.com/bandframework/bandframework.git -b v03/smoothemulatorscott

If you go to the doc/ directory you can look at the User Manual, which has installation instructions, plus a tutorial chapter.

Thanks to Stefan and Kyle for previous checks.

Please let me know what problems you might be having.

All the best — Scott
it’s ready to be looked at.

To clone the repo:
% git clone https://github.com/bandframework/bandframework.git -b v03/smoothemulatorscott

If you go to the doc/ directory you can look at the User Manual, which has installation instructions, plus a tutorial chapter.

Thanks to Stefan and Kyle for previous checks.

Please let me know what problems you might be having.

All the best — Scott

@kylegodbey - are you reviewing this one?

@kylegodbey - are you reviewing this one?

I will, once the yada yada's subside

A couple notes on the manual and process:

• Maybe listing the C++ standard required somewhere would be a good idea -- I was building on an older Ubuntu version and had to fast forward to g++-11
• The cmake -D YOUR_PREFERRED_COMPILER instruction led to an error for me, so I instead did -D CMAKE_CXX_COMPILER=g++-11
• It is claimed that fakerhic makes a directory ${MY PROJECT}/fullmodel_testdata/, but for me it was in smooth_data. That may be user error.
• For the smooth emulator parameter file, perhaps put the name of the file in the manual's tutorial. Right now it says: For the template used in this tutorial, that file is
• Starting in section 10.2, there are some LaTeX errors -- perhaps due to \end{verbatime}
• Manual says figs/YvY/ but it should be figs/YvsY/
• My fullmodel_testdata directory discrepancy shows up again for the YvsY business. Perhaps I went awry
• The tutorial sections are a bit messed up. Looking in the ToC, we see section 8, then 9 and 10 that should be part of the tutorial, before jumping back to 9.

Other than that, I was able to run everything fine with no bugs. I think it's good to merge once some of the tutorial instructions are polished up.

Thanks @kylegodbey & @scottedwardpratt