From 23b7b471b04e2e680173b5a238751fcd312c3a49 Mon Sep 17 00:00:00 2001 From: Nicolas Bock Date: Thu, 14 Feb 2019 11:15:17 -0700 Subject: [PATCH] Synced README and index and add API link Signed-off-by: Nicolas Bock --- README.md | 11 ++++++----- docs/index.md | 39 ++++++++++++++++++++++++++++----------- 2 files changed, 34 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index dc0de1f09..97e196f43 100644 --- a/README.md +++ b/README.md @@ -16,11 +16,12 @@ This website is intended to provide some guidance on how to get and install the bml library. LA-UR number LA-UR-**17-27373**. -The basic matrix library (bml) is a collection of various matrix data formats -(in dense and sparse) and their associated algorithms for basic matrix -operations. Application programming interfaces (API) are available for both C -and FORTRAN. The current status of this library allows us to use two different -formats for representing matrix data: dense and ELLPACK. +The basic matrix library (bml) is a collection of various matrix data +formats (in dense and sparse) and their associated algorithms for +basic matrix operations. [Application programming interfaces +(API)](/bml/API) are available for both C and FORTRAN. The current +status of this library allows us to use two different formats for +representing matrix data: dense and ELLPACK. # Mailing List diff --git a/docs/index.md b/docs/index.md index 3e31a8901..d7d39e8b7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -20,11 +20,12 @@ title: BML This website is intended to provide some guidance on how to get and install the bml library. LA-UR number LA-UR-**17-27373**. -The basic matrix library (bml) is a collection of various matrix data formats -(in dense and sparse) and their associated algorithms for basic matrix -operations. Application programming interfaces (API) are available for both C -and FORTRAN. The current status of this library allows us to use two different -formats for representing matrix data: dense and ELLPACK. +The basic matrix library (bml) is a collection of various matrix data +formats (in dense and sparse) and their associated algorithms for +basic matrix operations. [Application programming interfaces +(API)](/bml/API) are available for both C and FORTRAN. The current +status of this library allows us to use two different formats for +representing matrix data: dense and ELLPACK. # Mailing List @@ -91,14 +92,28 @@ format](https://launchpad.net/~nicolasbock/+archive/ubuntu/qmmd). # Build Instructions -The bml library is built with CMake. For convenience, we provide a shell +The bml library is built with CMake. For convenience, we provide a shell script which goes through the necessary motions and builds the library, runs -the tests, and installs it (in the `install` directory). Simply run: +the tests, and installs it (in the `install` directory). + +## For a quick installation + +We suggest to take a look at the `example_build.sh` script that sets +the most important +environmental variables needed by `build.sh` script. Change the Variables +according to the compilers and architecture. The script can be run just by +doing: + + $ ./example_build.sh + +## For a more involved installation + +By running: $ ./build.sh install -and the library will be built in the `build` directory and installed in the -`install` directory. In case you change any sources and simply want to +the library will be built in the `build` directory and installed in the +`install` directory. In case you change any sources and simply want to rebuild the library, you don't have to run `build.sh` again, but rather $ make -C build @@ -200,6 +215,8 @@ with the following `bibtex` snipped: url = {https://doi.org/10.5281/zenodo.841949} } +Another citation source is the following journal article: [BMLPaper](https://link.springer.com/article/10.1007/s11227-018-2533-0) + # Authors The core developers of the bml in alphabetical order: @@ -223,9 +240,9 @@ produced under U.S. Government contract DE-AC52-06NA25396 for Los Alamos National Laboratory (LANL), which is operated by Los Alamos National Security, LLC for the U.S. Department of Energy. The U.S. Government has rights to use, reproduce, and distribute this -software. NEITHER THE GOVERNMENT NOR LOS ALAMOS NATIONAL SECURITY, +software. NEITHER THE GOVERNMENT NOR LOS ALAMOS NATIONAL SECURITY, LLC MAKES ANY WARRANTY, EXPRESS OR IMPLIED, OR ASSUMES ANY LIABILITY -FOR THE USE OF THIS SOFTWARE. If software is modified to produce +FOR THE USE OF THIS SOFTWARE. If software is modified to produce derivative works, such modified software should be clearly marked, so as not to confuse it with the version available from LANL.