install.md.in (1802B)
1 # Compile from source 2 3 The installation of Stardis consists of compiling the solver and the 4 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 `stardis` and 8 its dependencies from source code. 9 10 ## Prerequisites 11 12 To build `stardis` with `star-build`, first make sure your system has 13 the following prerequisites: 14 15 - POSIX shell 16 - POSIX make 17 - curl 18 - git 19 - mandoc 20 - pkg-config 21 - sha512sum 22 - GNU Compiler Collection in version 8.3 or higher 23 - OpenMPI library and headers in version 2 or higher (optional) 24 25 ## Build 26 27 Assuming that the aforementioned prerequisites are available, the 28 build procedure is summed up to: 29 30 git clone git://git.meso-star.com/star-build.git 31 cd star-build 32 make \ 33 PREFIX=/path/to/stardis/ \ 34 BUILD=src/therm-apps/stardis_@STARDIS_VERSION@.sh 35 36 With `PREFIX` defining the path where Stardis will be installed 37 and `BUILD` defining the installation script to be run. 38 39 By default, Stardis is built with MPI enabled, so OpenMPI is one of its 40 requirements. 41 To disable MPI support, simply set the `DISTRIB_PARALLELISM` parameter 42 to NONE as follows: 43 44 make \ 45 PREFIX=/path/to/stardis/ \ 46 BUILD=src/therm-apps/stardis_@STARDIS_VERSION@.sh \ 47 DISTRIB_PARALLELISM=NONE 48 49 ## Run 50 51 Evaluate the installed `profile` file in the current 52 shell to register `stardis` against it. 53 You can then run `stardis` and consult its manual pages: 54 55 . /path/to/stardis/etc/profile 56 stardis -h 57 man stardis 58 59 Refer to the [Stardis: Starter Pack](starter-pack.html) to quickly run a 60 thermal simulation through the `stardis` CLI; this archive provides 61 input data and scripts and is a good starting point to begin with the 62 Stardis framework.