Skip to content

docs: clarify Autotools build process and prerequisites in README #88 #92

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
arybhatt4533 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: clarify Autotools build process and prerequisites in README #88 #92

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 13 additions & 21 deletions README
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,33 +33,25 @@ for example, the GNU C++ compiler g++.

* Getting started

MUSIC can be built and installed using the generic installation
instructions found in the file INSTALL. At the top of the source
distribution directory, do:
NOTE: This project uses **Autotools** for its build system. CMake is currently not supported.

**Prerequisites:**
Before building, ensure you have the following packages installed on your system:
* `build-essential`
* `autoconf`
* `automake`
* `libtool`
* `MPI` (e.g., OpenMPI or MPICH)

**Build and Installation Steps:**
Run the following commands from the root directory of the source distribution:

```bash
./autogen.sh
./configure --prefix=<PREFIX>
make
make install

(On some UNIX distributions you might need to run `ldconfig' or define
LD_LIBRARY_PATH:

export LD_LIBRARY_PATH=/usr/local/lib

for the music utility to find its library.)

A MUSIC co-simulation is specified in a configuration file given as
the first argument to the music utility. The test subdirectory
contains a collection of examples, for example:

cd test
mpirun -np 4 /usr/local/bin/music demo.music

On some systems, this way of invoking a MUSIC co-simulation isn't
supported. Se blow for an alternative method.


* Compilation and linking flags

configure.ac contains mechanisms which try to identify which MPI
Expand Down