Development¶

• Build from source

  • Clone source code:

    git clone git@github.com:spin-scenario/spin-scenario.git
    

  • For Windows:

    Note

    Make sure you have Visual Studio (2019) and Cmake installed prior to the build.

    Download and install the precompiled Boost (1.7.2), CUDA, ArrayFire and HDF5.

    Then open CMakeLists.txt:

    • modify BOOST_ROOT into your Boost’s full path.
    • modify ArrayFire_DIR into your ArrayFire’s cmake directory (e.g. C:/Program Files/ArrayFire/v3/cmake).

    • run sh ./dep_win.sh to generate visual studio projects for other 3rd-party libraries (nlopt, linenoise, yacas, lua) and spin-scenario.
    • complie the above 3rd-party libraries via visual studio.
    • complie spin-scenario via visual studio.

  • For Linux (e.g. Ubuntu):

    Using the following commands to install dependencies into the system.

    sudo apt-get install build-essential cmake libboost-all-dev libfftw3-dev libhdf5-dev libnlopt-dev libnlopt-cxx-dev libpython3-dev gnuplot
    

    Run sh script to complie other 3rd-party libraries.

    sh ./dep.sh
    

    Using the following commands to complie and install spin-scenario.

    mkdir build
    cd build
    cmake ..
    make
    make package
    make install
    

• Documentation

  Spin-Scenario use Sphinx to create all the documentation. Go into the docs directory and use sphinx-build -b html source build to build HTML files.