Skip to content
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

Synced README and index and add API link #239

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

Synced README and index and add API link #239

Show file tree
Hide file tree
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
11 changes: 6 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
39 changes: 28 additions & 11 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand All @@ -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.

Expand Down