Getting and Building

Sangmin Seo edited this page Aug 30, 2016 · 1 revision

URLs

  • SSH URL: git@github.com:pmodels/argobots.git
  • HTTPS URL: https://github.com/pmodels/argobots.git

For differences between above URLs, please refer to https://help.github.com/articles/which-remote-url-should-i-use/

Checking out the Argobots source

To check out a new copy of the Argobots source, use

$ git clone --origin argobots git@github.com:pmodels/argobots.git argobots

or

$ git clone --origin argobots https://github.com/pmodels/argobots.git argobots

This will create an argobots directory in your $PWD that contains a completely functional repository with full project history.

You can see the branches it contains using:

$ git branch -a
* master
  remotes/argobots/HEAD -> argobots/master
  remotes/argobots/master

Setting up the build environment

The git repository does not contain any of the "derived" files, including configure scripts and Makefiles. To build these, run

$ ./autogen.sh

Occasionally changes are made to the autoconf macros that are not detected by the dependency tests for the configure scripts. It is always correct to delete all the configure script before running autogen.sh:

$ find . -name configure -print | xargs rm 
$ ./autogen.sh

The autoconf macros and the configure.ac scripts require the following:

You can select a particular version of autoconf and autoheader by using the environment variables AUTOCONF and AUTOHEADER respectively. autogen.sh will use these if they are set. However, note that for these tools to work properly, both they and all of their data files must be installed in the same set of directories. The easiest way to ensure this is to use exactly the same configure arguments when you configure and install these tools. For example, if you set the prefix, set the prefix to exactly the same path for all three tools.

Building the software

After setting up the build environment with autogen.sh, you can perform the usual three step process to build it like any other unix package:

$ ./configure --prefix=INSTALLATION_PREFIX 
$ make -j 
$ make -j install

Obviously, substitute INSTALLATION_PREFIX above with a proper directory. Otherwise /usr will be assumed as a default.

Updated derived files such as configure

If you change one of the files that is the source for a derived file, such as a configure.ac file, you will need to rebuild the derived file (e.g., the corresponding configure file). The safest way to do this is to rerun autogen.sh:

$ ./autogen.sh

You can direct autogen.sh to only update certain classes of files. For example, to update all configure files, use

$ ./autogen.sh -do=build_configure

You can use multiple -do arguments. For example, to rebuild the Makefile.in files and the configure files, use

$ ./autogen.sh -do=build_configure -do=makefiles

Check the source of autogen.sh to see what other options are available for -do.

Cleaning everything

If you want to remove all untracked files from your current git branch, use

$ git clean -x -d -f
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.