Add arguments to devbuild.sh script

[danrosen25]

DESCRIPTION OF CHANGES:

• devbuild.sh documented with --help
• automatically determines compiler based on machine name
• added options for app, ccpp suite, enable options, disable options
• added option for build type DEBUG, RELEASE, RELWITHDEBINFO
• added option for build jobs, default 4
• added verbosity option for make

TESTS CONDUCTED:

Tested each devbuild.sh option in isolation. Tested on Jet (needs testing and confirmation of platform/compiler defaults on other machines)

DEPENDENCIES:

None

DOCUMENTATION:

Usage: ./devbuild.sh PLATFORM [OPTIONS]...

PLATFORM
      name of machine you are building on
      (e.g. cheyenne | hera | jet | orion | wcoss)

OPTIONS
  -h, --help
      show this help guide
  --compiler=COMPILER
      compiler to use; default depends on platform
      (e.g. intel | gnu | cray | gccgfortran)
  --app=APPLICATION
      weather model application to build
      (e.g. ATM | ATMW | S2S | S2SW)
  --ccpp="CCPP_SUITE1,CCPP_SUITE2..."
      CCCP suites to include in build; delimited with ','
  --enable-options="OPTION1,OPTION2,..."
      enable ufs-weather-model options; delimited with ','
      (e.g. 32BIT | INLINE_POST | UFS_GOCART | MOM6 | CICE6 | WW3 | CMEPS)
  --disable-options="OPTION1,OPTION2,..."
      disable ufs-weather-model options; delimited with ','
      (e.g. 32BIT | INLINE_POST | UFS_GOCART | MOM6 | CICE6 | WW3 | CMEPS)
  --continue
      continue with existing build
  --clean
      removes existing build; overrides --continue
  --build-dir=BUILD_DIR
      build directory
  --install-dir=INSTALL_DIR
      installation prefix
  --build-type=BUILD_TYPE
      build type; defaults to RELEASE
      (e.g. DEBUG | RELEASE | RELWITHDEBINFO)
  --build-jobs=BUILD_JOBS
      number of build jobs; defaults to 4
  -v, --verbose
      build with verbose output

NOTE: This script is for internal developer use only;
See User's Guide for detailed build instructions

CONTRIBUTORS:

@danrosen25

[danrosen25]

@gsketefian I was looking at the ufs-weather-model CMakeList.txt and they use -DDEBUG to set CMAKE_BUILD_TYPE. Do you want me to replace --build-type=? with --debug?
https://github.com/ufs-community/ufs-weather-model/blob/develop/CMakeLists.txt#L95

[gsketefian]

@gsketefian I was looking at the ufs-weather-model CMakeList.txt and they use -DDEBUG to set CMAKE_BUILD_TYPE. Do you want me to replace --build-type=? with --debug?
https://github.com/ufs-community/ufs-weather-model/blob/develop/CMakeLists.txt#L95

I like --build-type because --debug sounds to me like a true/false flag (but isn't).

[gsketefian]

@danrosen25 This looks good now. I guess it should be tested on one more machine, e.g. Hera. I would volunteer but have some other things to finish. I can get to it say Thursday, but if someone else can test it beforehand, that would be great.

[JulieSchramm]

@danrosen25 I can test this on Hera and Cheyenne. I am out Friday, and Cheyenne is down next week, so I will start with Hera. Let me know when it is ready for testing.

[danrosen25]

@JeffBeck-NOAA @JulieSchramm @mkavulich @gsketefian
The only question I have right now is
Do you want me to change --component=<COMPONENT1,COMPONENT2,...> to --enable-option=<OPTION1,OPTION2,...> and --disable-option=<OPTION1,OPTION2,...>, which better represents enabling and disabling options in https://github.com/ufs-community/ufs-weather-model/blob/develop/CMakeLists.txt. This can be used to enable/disable any option for the ufs-weather-model including 32BIT and INLINE_POST

[JulieSchramm]

When I run ./devbuild.sh hera --build-dir=build_intel --install-dir=../bin_intel, the build goes in the build directory and the executables are installed in the bin directory. Is this the expected behavior?

[JulieSchramm]

Oops, need the --platform. I'm not a big fan of the machine-setup.sh script. It figures out the machine name from the available disk names. This caused problems when "yellowstone" became "cheyenne" and the disk names changed, and this had to be fixed in the many instances of this script. Can the platform be a required argument, and then we wouldn't need machine-setup.sh?

[danrosen25]

@JulieSchramm
I removed the platform requirement. ./devbuild.sh hera will throw an error because the argument is unknown. ./devbuild.sh will automatically determine that you're running on hera or ./devbuild.sh --platform=hera will manually specify hera.

--build-dir=build_intel will build into <CURRENT_DIRECTORY>/build_intel
and --install-dir=../bin_intel sets CMAKE_INSTALL_PREFIX=../bin_intel, which will install binaries into <CURRENT_DIRECTORY>/build_intel/../bin_intel/bin, libraries into <CURRENT_DIRECTORY>/build_intel/../bin_intel/lib, share into <CURRENT_DIRECTORY>/build_intel/../bin_intel/share, and include into <CURRENT_DIRECTORY>/build_intel/../bin_intel/include
Is that what you want?

[JulieSchramm]

@danrosen25 When I type ``./devbuild.sh hera``, I don't get an error message and the build starts. The --build-dir and --install-dir work as expected if I specify ``--platform=hera``.

…

On Mon, Jul 26, 2021 at 3:53 PM Dan ***@***.***> wrote: @JulieSchramm <https://github.com/JulieSchramm> I removed the platform requirement. ./devbuild.sh hera will throw an error because the argument is unknown. ./devbuild.sh will automatically determine that you're running on hera or ./devbuild.sh --platform=hera will manually specify hera. --build-dir=build_intel will build into <CURRENT_DIRECTORY>/build_intel and --install-dir=../bin_intel sets CMAKE_INSTALL_PREFIX=../bin_intel, which will install binaries into <CURRENT_DIRECTORY>/build_intel/../bin_intel/bin, libraries into <CURRENT_DIRECTORY>/build_intel/../bin_intel/lib, share into <CURRENT_DIRECTORY>/build_intel/../bin_intel/share, and include into <CURRENT_DIRECTORY>/build_intel/../bin_intel/include Is that what you want? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#155 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AA3WNUY5AIMQLUMM4KA6N63TZXKNVANCNFSM5AUFVAJA> .

[danrosen25]

@JulieSchramm
Oh, I see that I'm just ignoring arguments that don't start with -, so yes you can type ./devbuild.sh hera but hera is ignored. Do you want me to make PLATFORM a required argument since the machine_setup.sh script can be buggy? I would change usage to Usage: .devbuild.sh PLATFORM [OPTIONS]... and remove --platform=PLATFORM.

[JulieSchramm]

@danrosen25 Making PLATFORM a required argument would be great. Thanks for doing this.

…

On Mon, Jul 26, 2021 at 6:43 PM Dan ***@***.***> wrote: @JulieSchramm <https://github.com/JulieSchramm> Oh, I see that I'm just ignoring arguments that don't start with -, so yes you can type ./devbuild.sh hera but hera is ignored. Do you want me to make PLATFORM a required argument since the machine_setup.sh script can be buggy? I would change usage to Usage: .devbuild.sh PLATFORM [OPTIONS]... and remove --platform=PLATFORM. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#155 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AA3WNUZD5SANNYQAECMQ5QTTZX6KDANCNFSM5AUFVAJA> .

[danrosen25]

@JulieSchramm I made PLATFORM a required argument.
@mkavulich I changed --components to --enable-options and --disable-options

[mkavulich]

Looks good, my concerns have been addressed. Once @JulieSchramm is okay with the updates I believe this PR is good to go.

[JulieSchramm]

I will test on Cheyenne next week Aug 2 or 3 when the computer is back up.

[JulieSchramm]

Tested on Jet, Hera and Cheyenne.