Skip to content

Commit

Permalink
Update citation information in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jfowkes authored Aug 18, 2023
1 parent 2a53928 commit 299a1c0
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ export OMP_CANCELLATION=TRUE
export OMP_PROC_BIND=TRUE
```

## Generate shared library
## Generating a shared library

SPRAL must be compiled with `-fPIC` to be able to generate a shared library.
The static library `libspral.a` can be converted to a shared library using one of the following commands:
Expand All @@ -68,14 +68,13 @@ gfortran -fPIC -shared -Wl,--whole-archive libspral.a -Wl,--no-whole-archive -lg
gfortran -fPIC -shared -Wl,-all_load libspral.a -Wl,-noall_load -lgomp -lopenblas -lhwloc -lmetis -lstdc++ -o libspral.dylib
```

## Citing
To cite SSIDS, please use the following reference:
## Citing SPRAL or SSIDS
If you write a paper using software from SPRAL, please cite an appropriate paper (a list can usually be found in the method section of the user documentation). To cite SSIDS, please use the following reference:

J. Hogg, E. Ovtchinnikov, and J. Scott (2016). A sparse symmetric indefinite direct solver for GPU architectures. ACM Transactions on Mathematical Software (TOMS), 42(1), 1-25, [https://dx.doi.org/10.1145/275654](https://doi.org/10.1145/2756548)
> J. Hogg, E. Ovtchinnikov, and J. Scott (2016). A sparse symmetric indefinite direct solver for GPU architectures. ACM Transactions on Mathematical Software (TOMS), 42(1), 1-25, [https://dx.doi.org/10.1145/275654](https://doi.org/10.1145/2756548)
In BibTeX, the citation is:


```
@article{hogg2016sparse,
title={A sparse symmetric indefinite direct solver for GPU architectures},
Expand All @@ -88,3 +87,7 @@ In BibTeX, the citation is:
publisher={ACM New York, NY, USA}
}
```

If no paper is listed, a citation of the SPRAL GitHub website should be used, for example:

> SPRAL: an open-source library for sparse linear algebra, Version 2023-08-02, https://github.com/ralna/spral, August 2023.

0 comments on commit 299a1c0

Please sign in to comment.