meso-web

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

install.md.in (1957B)

      1 # Compile from source
      2 
      3 No pre-compiled version of `htrdr` is provided;
      4 it must be compiled directly from its source tree.
      5 A simple way is to rely on
      6 [star-build](https://www.meso-star.com/git/star-build/), which automates the
      7 build and installation of `htrdr` and its dependencies from source code.
      8 
      9 ## Prerequisites
     10 
     11 To build `htrdr` with `star-build`, first make sure your system has the
     12 following prerequisites:
     13 
     14 - POSIX shell
     15 - POSIX make
     16 - curl
     17 - git
     18 - mandoc
     19 - pkg-config
     20 - sha512sum
     21 - GNU Compiler Collection in version 8.3 or higher
     22 - netCDF4 library and headers
     23 - OpenMPI library and headers in version 2 or higher
     24 
     25 ## Build
     26 
     27 Assuming that the aforementioned prerequisites are available, the build
     28 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=~/htrdr_@VERSION@ \
     34       BUILD=src/rad-apps/htrdr_@VERSION@.sh
     35 
     36 With `PREFIX` defining the path where `htrdr` will be installed and
     37 `BUILD` defining the installation script to be run.
     38 
     39 By default, the whole `htrdr` project is built but you may prefer to
     40 deploy `htrdr` only for a specific application, i.e. only for
     41 atmospheric radiative transfer, combustion processes or planetary
     42 science.
     43 For example, to install only the atmospheric part of `htrdr`:
     44 
     45     make \
     46         PREFIX=~/htrdr_@VERSION@ \
     47         BUILD=src/rad-apps/htrdr_@VERSION@.sh \
     48         ATMOSPHERE=ENABLE \
     49         COMBUSTION=DISABLE \
     50         PLANETS=DISABLE
     51 
     52 ## Run
     53 
     54 Evaluate the installed `profile` file in the current
     55 shell to register `htrdr` against it. You can then run
     56 `htrdr` and consult its manual pages:
     57 
     58     . ~/htrdr_@VERSION@/etc/profile
     59     htrdr -h
     60     man htrdr
     61 
     62 Refer to the Starter Packs
     63 ([atmosphere](htrdr-atmosphere-spk.html),
     64 [combustion](htrdr-combustion-spk.html) or
     65 [planets](htrdr-planets-spk.html))
     66 to quickly run a `htrdr` calculation; these archives provide input data
     67 and scripts that are good starting points to use `htrdr`.