README.md 2.93 KB
Newer Older
Adam Mercer's avatar
Adam Mercer committed
1 2
# LALSuite

3
This is the main LALSuite development repository.
Adam Mercer's avatar
Adam Mercer committed
4

5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
## Acknowledgment

We request that any academic report, publication, or other academic
disclosure of results derived from the use of this software acknowledge
the use of the software by an appropriate acknowledgment or citation.

The whole LALSuite software suite can be cited with the DOI
[10.7935/GT1W-FZ16][doi]. An example BibTeX entry could look like this:

     @misc{lalsuite,
           author         = "{LIGO Scientific Collaboration}",
           title          = "{LIGO} {A}lgorithm {L}ibrary - {LALS}uite",
           howpublished   = "free software (GPL)",
           doi            = "10.7935/GT1W-FZ16",
           year           = "2018"
     }

In addition, some codes contained in this package may be directly based
on one or several scientific papers, which should be cited when using
those specific codes; some of these can be discovered through the
documentation.

## Cloning the Repository

We now utilize [Git LFS][gitlfs] for the managament of large files and
as such `git-lfs` needs to be installed and configured to correctly
clone this repository. After installing `git-lfs` it can be configured
using:
Adam Mercer's avatar
Adam Mercer committed
33

34
     $ git lfs install
Adam Mercer's avatar
Adam Mercer committed
35

36 37
This only needs to be done once for each machine you access the
repository. It can then be cloned using:
Adam Mercer's avatar
Adam Mercer committed
38

39
     $ git clone git@git.ligo.org:lscsoft/lalsuite.git
40

41 42
## Contributing to LALSuite

43 44 45
The [guide to contributing to LALSuite][contributing] explains how to
report issues and contribute fixes or new features using the fork and
pull workflow. Please read and follow these directions.
46

47 48
## Nightly Documentation

49 50
The [LALSuite Doxygen documentation][nightlydocs] is built under
GitLab-CI every night.
51

52
## Notes on Ancient History
53

54 55 56
LALSuite was transferred to `git.ligo.org` in December 2017. Older
history has been imported, though commit hashes were rewritten during
the [Git LFS][gitlfs] conversion. Please note:
57

58 59 60 61
1. The `Original:` commit IDs quoted in each commit message can be used
   to compare with the [archived reference repo][oldlalsuite], old issue
   discussions on the [Redmine tracker][oldredmine], review wiki pages
   etc.
62

63 64 65 66 67
1. Commits before December 2017 may also include references to issues
   (`#number`). These refer to the corresponding [Redmine
   issue][oldredmine] (LVC-authorized access only), and any clickable
   link the internal GitLab web interface produces for those old commits
   will therefore be spurious.
68

69
## For More Information
70

71
Please visit the [LALSuite project page][project].
72

73 74 75 76 77 78 79
[doi]:          https://doi.org/10.7935/GT1W-FZ16
[gitlfs]:       https://wiki.ligo.org/Computing/GitLFS#Install_the_git_LFS_client
[contributing]: https://git.ligo.org/lscsoft/lalsuite/blob/master/CONTRIBUTING.md
[nightlydocs]:  https://lscsoft.docs.ligo.org/lalsuite
[oldlalsuite]:  https://git.ligo.org/lscsoft/lalsuite-archive
[oldredmine]:   https://bugs.ligo.org/redmine/projects/lalsuite
[project]:      https://wiki.ligo.org/Computing/DASWG/LALSuite