solstice-install.md.in (1879B)
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 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 - sha512sum 31 - GNU Compiler Collection in version 8.3 or higher 32 33 ## Build 34 35 Assuming that the aforementioned prerequisites are available, the 36 build procedure is summed up to: 37 38 git clone git://git.meso-star.com/star-build.git 39 cd star-build 40 make \ 41 PREFIX=/path/to/solstice/ \ 42 BUILD=src/rad-apps/solstice_@SOLSTICE_VERSION@.sh 43 44 With `PREFIX` defining the path where Solstice will be installed 45 and `BUILD` defining the installation script to be run. 46 47 ## Run 48 49 Source the installed `profile` file in the current 50 shell to register `solstice` against it. 51 You can then run `solstice` and consult its manual pages: 52 53 . /path/to/solstice/etc/profile 54 solstice -h 55 man solstice 56 57 Refer to the [Solstice: Absolute Beginner's Guide](solstice-resources.html) to 58 quickly run a solar plant simulation through the `solstice` CLI; this archive 59 provides input data and scripts and is a good starting point to begin with the 60 Solstice framework.