ecmwf/ecbuild

INSTALL file out of date and has bad link

Closed this issue · 5 comments

I'm a new user to ecbuild trying to build, install, and use it for the first time. So, since there wasn't a README.md file, I turned to INSTALL. However a link in that:

https://software.ecmwf.int/wiki/display/ECbuild/ecBuild

no longer exists on ECMWF's wiki/Confluence. (The same goes for the link that is in the project's description: https://software.ecmwf.int/wiki/display/ecbuild which redirects to: https://confluence.ecmwf.int//display/ecbuild which I get a "Not Permitted" error when viewing.)

Also:

tar zxvf ecbuild-1.9.0-Source.tar.gz -C /path/to/install

refers to an old version and I believe the releases aren't even named like that if you use the GitHub auto-generated releases here.

I'm assuming, though, that the installation method via CMake is still correct?

I am also a new user to ecbuild and was able to get it installed today. I found that the CMake installation method was still correct, though I also passed in -DCMAKE_INSTALL_PREFIX=/my/install/path since I wasn't installing globally. My build script looks like

builddir=/myhome/ecbuild/build
mkdir -p $builddir
cd $builddir
cmake \
  -DCMAKE_MODULE_PATH=$builddir \
  -DCMAKE_INSTALL_PREFIX=$builddir \
  .. |& tee cmake.log
make install |& tee make.log

Also, for some reason git clone https://github.com/ecmwf/ecbuild.git grabs the develop branch by default. That wasn't working for me when compiling something else, so I used git clone https://github.com/ecmwf/ecbuild.git --branch master.

We have now changed the default branch to master.
Thanks for reporting.

Regarding the README, thanks for the feedback. We will add a README.md for the upcoming release of ecbuild 3.0.0 (currently in develop branch).

We also plan to move the documentation to somewhere more accessible (such as GitHub hosting)

@tlmquintino I suppose this can be closed now? I noticed that on the releases page, it looks like ecbuild 3+ has been tagged (if not "formally Github released")