Skip to content

Mac Build Instructions

Jump to bottom
sjanzou edited this page Jan 11, 2022 · 44 revisions

These instructions were written and tested in January 2022 with macOS 11.6.1 on an Intel based Mac and macOS 12.0.1 on an Apple Silicon based Mac, Xcode 13.1 with Command Line Developer Tools. They assume that you have at least installed Command Line Developer Tools on your Mac so that you can compile C++ projects from the command line in a terminal window. See this helpful blog for more about Xcode and Command Line Developer Tools. The builds are performed with OS X 10.15 support using the "-mmacosx-version-min=10.15" in both the CFLAGS and CXXFLAGS.

  • To install the Command Line Tools package in macOS Sierra, open a terminal window, and type the following command:

     xcode-select --install

    If Command Line Developer tools is not installed, you should see a message asking if you want to install them. Click Install: you do not need to get Xcode if you do not want the full Xcode package.

Decide where to store the SAM source code

The SAM project depends on wxWidgets libraries, which you can build in any directory. You will create a symbolic link and change the PATH environment to tell the SAM makefiles where to find the libraries.

The source code for the LK, WEX, SSC, and SAM projects should go in a single parent directory. If you already have a directory for your projects, you can use it, or you can create a new one specifically for SAM. These instructions use the following directory structure as an example:

.../sam_dev/wxWidgets-3.1.5
.../sam_dev/lk
.../sam_dev/wex
.../sam_dev/ssc
.../sam_dev/sam

The lk, wex, ssc, and sam directories should all be in one directory. The wxWidgets directory does not have to be in the same directory as those four.

Get the code repositories

  1. Download the wxWidgets 3.1.5 source code for Linux, OS X, etc. from https://github.com/wxWidgets/wxWidgets/releases/tag/v3.1.5. The code repository is available in several zip formats. These instructions explain how to unzip the following file:

    wxWidgets-3.1.5.tar.bz2

  2. Clone the SAM code repositories:

    cd sam_dev
for repo in lk wex ssc sam ; do git clone https://github.com/nrel/$repo ; done

    The latest code is in the Develop branch of each repository. If you are contributing code, you should work with this branch. To build a specific version of SAM, you can check out a tag for that version. See List of Tags for SAM Versions for a list of tags for different versions of SAM, SSC, WEX and LK.

    The git clone command automatically creates a directory for the repository, so you do not need to create a directory before you clone it. For example if you clone the lk repository into your sam_dev directory, Git will create an lk directory for the repository.

    Note. You can also download the repositories from GitHub as .zip files instead of cloning them. If you do that, be sure to extract them into directories named lk, wex, ssc, and sam so that the makefiles can find them.

Install wxWidgets 3.1.5

  1. Create a wxWidgets-3.1.5 directory, and extract the compressed file and tarball into it:

    bunzip2 –d wxWidgets-3.1.5.tar.bz2
tar xvf wxWidgets-3.1.5.tar

    Note: You may be able to use tar xvjf without first running bunzip2 according to this article on thegeekstuff.

    You should now have a directory named wxWidgets-3.1.5 that contains several files and directories:

  2. From a build folder, run the configure command (Universal binary library for both Intel and Apple Silicon based Macs):

    mkdir wxWidgets-3.1.5/build
cd wxWidgets-3.1.5/build
    Release version
../configure --prefix=$HOME/local/wx-3.1.5/Release --enable-stl=yes --enable-shared=no --disable-debug_flag --with-cocoa --enable-universal_binary=x86_64,arm64 --enable-unicode --enable-webview --disable-mediactrl --with-cxx=11 --with-macosx-version-min=10.15  --with-libjpeg=builtin --with-libpng=builtin --with-regex=builtin --with-libtiff=builtin --with-zlib=builtin --with-expat=builtin

   Debug version
   ../configure --prefix=$HOME/local/wx-3.1.5/Debug --enable-stl=yes --enable-debug --enable-debug_info --enable-shared=no --with-cocoa --enable-universal_binary=x86_64,arm64 --enable-unicode --enable-webview --disable-mediactrl --with-cxx=11 --with-macosx-version-min=10.15  --with-libjpeg=builtin --with-libpng=builtin --with-regex=builtin --with-libtiff=builtin --with-zlib=builtin --with-expat=builtin	

    ```

  3. Type the following make commands to install wxWidgets. The makefile will install wxWidgets in ~/local/wx-3.1.5:

        make clean
make
make install

    Note: You can use -j to increase the number of jobs and speed up the build, for example make -j2 or make -j8. See this discussion on Stackexchange.

    When the installation finishes, you should see the following message:

  4. Create a symbolic link to the wxWidgets installation directory.

    ln -s ~/local/wx-3.1.5/bin/wx-config /usr/local/bin/wx-config-3

  5. Test the installation:

    wx-config-3 --cflags

    If the installation was successful, you should see:

    -I/Users/<USER>/local/wx-3.1.5/lib/wx/include/osx_cocoa-unicode-static-3.1 -I/Users/<USER>/local/wx-3.1.5/include/wx-3.1 -D_FILE_OFFSET_BITS=64 -DwxDEBUG_LEVEL=0 -D__WXMAC__ -D__WXOSX__ -D__WXOSX_COCOA__

Build Googletest

SAM's repositories contain dependencies on the Google Test framework Google Test, which is a C++ unit-test framework.

Clone Google Test and do an out-of-source build for the Debug or Release configuration:

git clone https://github.com/google/googletest.git
mkdir googletest/build
cd googletest/build
it clone https://github.com/google/googletest.git
mkdir googletest/build
cd googletest/build
cmake .. -DCMAKE_BUILD_TYPE=Debug
make -j4
rm -rf .
cmake .. -DCMAKE_BUILD_TYPE=Release
make -j4

If the builds succeed, you should see googletest/build/lib/libgtest<d>.a.

Set Environment Variables

Environment variables store values for programs and processes on your computer. The SAM build script use five environment variables to determine where the files it needs are stored on your computer. Before building the projects, you should set the following environment variables to point to each of the project folders you created in Step 1.

To conveniently set your environment variables to be set every time you open a terminal, set them in your user .bash_profile file:

export GTEST=/path/to/googletest
export LKDIR=/path/to/lk
export WEXDIR=/path/to/wex
export SSCDIR=/path/to/ssc
export SAMNTDIR=/path/to/SAM

Reopen the terminal to update the environment variables.

Build SAM

The build requires CMake 3.19 or higher.

  1. In the sam_dev folder, save the following text as CMakeLists.txt:

    option(SAM_SKIP_TOOLS "Skips the sdktool and tcsconsole builds" OFF)
option(SAM_SKIP_TESTS "Skips building tests" OFF)
option(SAMAPI_EXPORT "Export of ssc binaries to the SAM_api directory; for Unix, compile ssc libraries for SAM_api" ON)
option(SAM_SKIP_AUTOGEN "Skips the automatic regeneration of SAMAPI files from export_config" ON)
     
cmake_minimum_required(VERSION 3.19)
     
Project(system_advisor_model VERSION 1.0.0)
     
add_subdirectory(lk)
add_subdirectory(wex)
add_subdirectory(ssc)
add_subdirectory(sam)

    There are four CMake options used for build settings:

    SAM_SKIP_TOOLS allows skipping sandboxes and the tcsconsole executables. Off by default.

    SAM_SKIP_TESTS allows skipping the Test project in SSC. Off by default.

    SAMAPI_EXPORT turns on the SAM api project for producing PySAM files. On by default.

    SAM_SKIP_AUTOGEN allows skipping re-generation of the SAM api files. On by default. If you will be making development versions of PySAM, this should be OFF.

  2. If you have a CMake-supporting IDE, then you can simply create the project by opening this CMakeLists.txt file and changing the CMake build settings from their default values if desired via project settings.

  3. Building from the Command Line. Go to the SAM parent folder that contains the CMakeLists.txt from step 1 and the 4 SAM repositories.

    cd sam_dev
mkdir build
cd build
cmake .. -DCMAKE_BUILD_TYPE=Release

    To change any of the default options, such as for building development versions of PySAM, set the CMake option:

    cmake .. -DCMAKE_BUILD_TYPE=Release -DSAM_SKIP_AUTOGEN=OFF

    To build the Debug version, change the CMAKE_BUILD_TYPE to "Debug".

    Then run make to build the entire project, using for example 8 processors:

    make -j8

    Once the build is complete, you should have a SAM.app file in the build folder.

Test the build

  1. To run SAM, type open SAM.app at the command line, or open a Finder window, go to the build folder of the SAM project, sam_dev/build/sam or sam_dev/sam/build, and double-click the SAM icon.

    Note. If you want to make a dmg file, you can do so by typing: bash makedmg.sh.

  2. When SAM starts, click Start a new project, and then click Photovoltaic (detailed) and Residential (distributed), and OK.

  3. On the Location and Resource page, click View data. That should open a DView window with data from the weather file selected on the Location and Resource page. DView is from WEX, so that confirms that WEX built correctly.

  4. Close the DView window.

  5. Click through the input pages to see that they display correctly. The user interface uses libraries from wxWidgets and WEX.

  6. Click Simulate in the bottom left corner of the SAM window. SAM should run a simulation and display results on the Results page. The results page also uses DView from WEX, and displays data generated by SSC.

  7. Click Macros (under the Simulate button), and click the Inverter Sizing Information button. Click Run macro at the top of the window. The macro should run and display a window with information about the inverter's performance. That confirms that LK (also from WEX) is working.

Clone this wiki locally