Specify minimum requirements for installation in documentation

[ashwinvis]

Specify minimum requirements for installation in documentation

[bastorer]

Expanding on the list a bit before I add it into the documentation

• netcdf4 (tested on 4.7 and 4.8)
  • requires parallel installation
  • hdf5 required
• mpi (openmpi or intel mpi, not mpich)
• compilers: either gcc or icpc (intel compiler)
  • intended to be compiled with c++14 standard (this is specified in the compiler flags in the system.mk file)

Not required for FlowSieve, but required for the Tutorials (specified in Tutorials/environment.yml). May not require these specific version, but tested with these versions.

• python=3.7
• numpy=1.17
• matplotlib=3.1
• netCDF4=1.4
• scipy=1.3
• pip

[ashwinvis]

Seems like I have those... will update if I discover something on my end once #24 is fixed.

[ashwinvis]

Seems like

• curl
• hdf5-mpi (not just hdf5)

is also required to compile. Here is the Nix file I used to compile

❯ cat default.nix 
# Use `nix-shell --pure` to verify if the listed dependencies are sufficient or not
{ pkgs ? import <nixpkgs> {} }:

let
  shell = pkgs.mkShell {
    name = "flowsieve-nix-dev";

    packages = [
      pkgs.mpi
      pkgs.pkg-config
      pkgs.netcdf-mpi
      pkgs.hdf5-mpi
      pkgs.gcc9
      pkgs.curl
    ];

    # cp -f ${builtins.getEnv "PWD"}/Systems/Graham.mk system.mk
    shellHook = ''
      make clean
      OMPI_CXX=$(command -v g++) make -j Case_Files/coarse_grain.x
    '';
  };
in shell

[bastorer]

I've added a section to the Install documentation outlining these library requirement. Thanks for the suggestion!

I'm not familiar with Nix (or other library image tools), but I'll look into them a bit. I tend to shy away from compiling libraries mostly because it seems daunting, but the improved portability would be nice.

[ashwinvis]

I dont expect you to use Nix, I simply shared it for future reference. It fetches precompiled builds of libraries.and gives an isolated shell. It was handy for me to track down dependencies.

[bastorer]

That's great, thanks!

[ashwinvis]

I see that it updated in https://flowsieve.readthedocs.io/en/latest/install1.html, so this issue can be closed.