meso-web

Sources of the |Méso|Star> website
git clone git://git.meso-star.com/meso-web.git
Log | Files | Refs | README | LICENSE

solstice-install.md.in (1921B)

      1 # Compile from source
      2 
      3 The installation of Solstice consists of compiling the solver, the
      4 anim library, and the command line tools directly on the target machine.
      5 A simple way is to rely on
      6 [star-build](https://www.meso-star.com/git/star-build/),
      7 which automates the build and installation of `solstice`, its
      8 dependencies, and a few post-processing tools from source code.
      9 
     10 ## Compatibility
     11 
     12 Solstice can be built on any x86-64 POSIX system, starting with Linux.
     13 
     14 For Windows users, there is no longer a Windows prebuilt version of Solstice.
     15 Also, native Windows build is no longer possible out of the box, nor supported.
     16 However, Solstice runs perfectly on the Windows Subsystem for Linux. Ask your
     17 favourite search engine for details on the topic.
     18 
     19 ## Prerequisites
     20 
     21 To build `solstice` with `star-build`, first make sure your system has
     22 the following prerequisites:
     23 
     24 - POSIX shell
     25 - POSIX make
     26 - curl
     27 - git
     28 - mandoc
     29 - pkg-config
     30 - libYAML in version 0.2 or higher
     31 - sha512sum
     32 - GNU Compiler Collection in version 8.3 or higher
     33 
     34 ## Build
     35 
     36 Assuming that the aforementioned prerequisites are available, the
     37 build procedure is summed up to:
     38 
     39     git clone git://git.meso-star.com/star-build.git
     40     cd star-build
     41     make \
     42       PREFIX=/path/to/solstice/ \
     43       BUILD=src/rad-apps/solstice_@SOLSTICE_VERSION@.sh
     44 
     45 With `PREFIX` defining the path where Solstice will be installed
     46 and `BUILD` defining the installation script to be run.
     47 
     48 ## Run
     49 
     50 Source the installed `profile` file in the current
     51 shell to register `solstice` against it.
     52 You can then run `solstice` and consult its manual pages:
     53 
     54     . /path/to/solstice/etc/profile
     55     solstice -h
     56     man solstice
     57 
     58 Refer to the [Solstice: Absolute Beginner's Guide](solstice-resources.html) to
     59 quickly run a solar plant simulation through the `solstice` CLI; this archive
     60 provides input data and scripts and is a good starting point to begin with the
     61 Solstice framework.