Verified Commit c1781bb2 authored by Karl Wette's avatar Karl Wette Committed by Adam Mercer

*/README.md: minor style and reformatting edits

parent 1d1dce7b
......@@ -2,47 +2,78 @@
This is the main LALSuite development repository.
We now utilize [git-lfs](https://wiki.ligo.org/Computing/GitLFS#Install_the_git_LFS_client) 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:
## 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:
$ git lfs install
This only needs to be done once for each machine you access the repository. It can then be cloned using:
This only needs to be done once for each machine you access the
repository. It can then be cloned using:
$ git clone git@git.ligo.org:lscsoft/lalsuite.git
## Contributing to LALSuite
The guide to [Contributing](https://git.ligo.org/lscsoft/lalsuite/blob/master/CONTRIBUTING.md) to LALSuite explains how to report issues and contribute fixes or new features using the fork and pull workflow. Please read and follow these directions.
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.
## Nightly Documentation
The Doxygen Documentation is built under GitLab-CI every night and can be viewed at:
https://lscsoft.docs.ligo.org/lalsuite
## Citing LALSuite
The [LALSuite Doxygen documentation][nightlydocs] is built under
GitLab-CI every night.
The whole software suite can be cited with the doi
[10.7935/GT1W-FZ16](https://doi.org/10.7935/GT1W-FZ16).
An example bibtex entry could look like this:
## Notes on Ancient History
@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"
}
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:
In addition, many codes contained in LALSuite are directly based on
one or several scientific papers,
many (not all) of which can be discovered through the documentation,
and should be cited when using those specific codes.
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.
## Notes on Ancient History
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.
LALSuite was transferred to git.ligo.org in December 2017. Older history has been imported, though commit hashes were rewritten during the GitLFS conversion. Please note:
## For More Information
1. The "Original: " commit IDs quoted in each commit message can be used to compare with the [archived reference repo](https://git.ligo.org/lscsoft/lalsuite-archive), old issue discussions on the [Redmine tracker](https://bugs.ligo.org/redmine/projects/lalsuite), review wiki pages etc.
Please visit the [LALSuite project page][project].
1. Commits before December 2017 may also include references to issues ("#number"). These refer to the corresponding [Redmine issue](https://bugs.ligo.org/redmine/projects/lalsuite) (LVC-authorized access only), and any clickable link the internal gitlab web interface produces for those old commits will be spurious.
[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
LAL
================================
# LAL
Core gravitational wave analysis routines.
Acknowledgment
--------------------------------
## 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](https://doi.org/10.7935/GT1W-FZ16).
An example bibtex entry could look like this:
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}",
......@@ -22,13 +19,12 @@ An example bibtex entry could look like this:
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.
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.
Basic Build Instructions
--------------------------------
## Basic Build Instructions
./configure --prefix=...
make
......@@ -37,19 +33,18 @@ Basic Build Instructions
Please read the [LALSuite install how-to][install] for more detailed
build instructions.
Bug Reporting
--------------------------------
## Bug Reporting
Please visit the [LALSuite bug reporting system][bugs] (LIGO.org
authentication required to submit new issues),
or use the e-mail helpdesk:
`contact+lscsoft/lalsuite@support.ligo.org`
authentication required to submit new issues), or use the [e-mail
helpdesk][helpdesk].
For More Information
--------------------------------
## For More Information
Please visit the [LALSuite project page][project].
[install]: https://wiki.ligo.org/Computing/DASWG/LALSuiteInstall
[bugs]: https://git.ligo.org/lscsoft/lalsuite/issues/
[project]: https://wiki.ligo.org/Computing/DASWG/LALSuite
[doi]: https://doi.org/10.7935/GT1W-FZ16
[helpdesk]: mailto:contact+lscsoft/lalsuite@support.ligo.org
[install]: https://wiki.ligo.org/Computing/DASWG/LALSuiteInstall
[bugs]: https://git.ligo.org/lscsoft/lalsuite/issues/
[project]: https://wiki.ligo.org/Computing/DASWG/LALSuite
LALApps
================================
# LALApps
Collection of gravitational wave data analysis codes and pipelines
utilising the LAL libraries.
Acknowledgment
--------------------------------
## 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](https://doi.org/10.7935/GT1W-FZ16).
An example bibtex entry could look like this:
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}",
......@@ -23,13 +20,12 @@ An example bibtex entry could look like this:
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.
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.
Basic Build Instructions
--------------------------------
## Basic Build Instructions
./configure --prefix=...
make
......@@ -38,19 +34,18 @@ Basic Build Instructions
Please read the [LALSuite install how-to][install] for more detailed
build instructions.
Bug Reporting
--------------------------------
## Bug Reporting
Please visit the [LALSuite bug reporting system][bugs] (LIGO.org
authentication required to submit new issues),
or use the e-mail helpdesk:
`contact+lscsoft/lalsuite@support.ligo.org`
authentication required to submit new issues), or use the [e-mail
helpdesk][helpdesk].
For More Information
--------------------------------
## For More Information
Please visit the [LALSuite project page][project].
[install]: https://wiki.ligo.org/Computing/DASWG/LALSuiteInstall
[bugs]: https://git.ligo.org/lscsoft/lalsuite/issues/
[project]: https://wiki.ligo.org/Computing/DASWG/LALSuite
[doi]: https://doi.org/10.7935/GT1W-FZ16
[helpdesk]: mailto:contact+lscsoft/lalsuite@support.ligo.org
[install]: https://wiki.ligo.org/Computing/DASWG/LALSuiteInstall
[bugs]: https://git.ligo.org/lscsoft/lalsuite/issues/
[project]: https://wiki.ligo.org/Computing/DASWG/LALSuite
LALBurst
================================
# LALBurst
LAL routines for burst gravitational wave data analysis.
Acknowledgment
--------------------------------
## 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](https://doi.org/10.7935/GT1W-FZ16).
An example bibtex entry could look like this:
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}",
......@@ -22,13 +19,12 @@ An example bibtex entry could look like this:
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.
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.
Basic Build Instructions
--------------------------------
## Basic Build Instructions
./configure --prefix=...
make
......@@ -37,19 +33,18 @@ Basic Build Instructions
Please read the [LALSuite install how-to][install] for more detailed
build instructions.
Bug Reporting
--------------------------------
## Bug Reporting
Please visit the [LALSuite bug reporting system][bugs] (LIGO.org
authentication required to submit new issues),
or use the e-mail helpdesk:
`contact+lscsoft/lalsuite@support.ligo.org`
authentication required to submit new issues), or use the [e-mail
helpdesk][helpdesk].
For More Information
--------------------------------
## For More Information
Please visit the [LALSuite project page][project].
[install]: https://wiki.ligo.org/Computing/DASWG/LALSuiteInstall
[bugs]: https://git.ligo.org/lscsoft/lalsuite/issues/
[project]: https://wiki.ligo.org/Computing/DASWG/LALSuite
[doi]: https://doi.org/10.7935/GT1W-FZ16
[helpdesk]: mailto:contact+lscsoft/lalsuite@support.ligo.org
[install]: https://wiki.ligo.org/Computing/DASWG/LALSuiteInstall
[bugs]: https://git.ligo.org/lscsoft/lalsuite/issues/
[project]: https://wiki.ligo.org/Computing/DASWG/LALSuite
LALFrame
================================
# LALFrame
LAL wrapping of the LIGO/Virgo Frame library.
Acknowledgment
--------------------------------
## 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](https://doi.org/10.7935/GT1W-FZ16).
An example bibtex entry could look like this:
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}",
......@@ -22,13 +19,12 @@ An example bibtex entry could look like this:
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.
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.
Basic Build Instructions
--------------------------------
## Basic Build Instructions
./configure --prefix=...
make
......@@ -37,19 +33,18 @@ Basic Build Instructions
Please read the [LALSuite install how-to][install] for more detailed
build instructions.
Bug Reporting
--------------------------------
## Bug Reporting
Please visit the [LALSuite bug reporting system][bugs] (LIGO.org
authentication required to submit new issues),
or use the e-mail helpdesk:
`contact+lscsoft/lalsuite@support.ligo.org`
authentication required to submit new issues), or use the [e-mail
helpdesk][helpdesk].
For More Information
--------------------------------
## For More Information
Please visit the [LALSuite project page][project].
[install]: https://wiki.ligo.org/Computing/DASWG/LALSuiteInstall
[bugs]: https://git.ligo.org/lscsoft/lalsuite/issues/
[project]: https://wiki.ligo.org/Computing/DASWG/LALSuite
[doi]: https://doi.org/10.7935/GT1W-FZ16
[helpdesk]: mailto:contact+lscsoft/lalsuite@support.ligo.org
[install]: https://wiki.ligo.org/Computing/DASWG/LALSuiteInstall
[bugs]: https://git.ligo.org/lscsoft/lalsuite/issues/
[project]: https://wiki.ligo.org/Computing/DASWG/LALSuite
LALInference
================================
# LALInference
LAL routines for Bayesian inference data analysis.
Acknowledgment
--------------------------------
## 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](https://doi.org/10.7935/GT1W-FZ16).
An example bibtex entry could look like this:
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}",
......@@ -22,13 +19,12 @@ An example bibtex entry could look like this:
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.
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.
Basic Build Instructions
--------------------------------
## Basic Build Instructions
./configure --prefix=...
make
......@@ -37,19 +33,18 @@ Basic Build Instructions
Please read the [LALSuite install how-to][install] for more detailed
build instructions.
Bug Reporting
--------------------------------
## Bug Reporting
Please visit the [LALSuite bug reporting system][bugs] (LIGO.org
authentication required to submit new issues),
or use the e-mail helpdesk:
`contact+lscsoft/lalsuite@support.ligo.org`
authentication required to submit new issues), or use the [e-mail
helpdesk][helpdesk].
For More Information
--------------------------------
## For More Information
Please visit the [LALSuite project page][project].
[install]: https://wiki.ligo.org/Computing/DASWG/LALSuiteInstall
[bugs]: https://git.ligo.org/lscsoft/lalsuite/issues/
[project]: https://wiki.ligo.org/Computing/DASWG/LALSuite
[doi]: https://doi.org/10.7935/GT1W-FZ16
[helpdesk]: mailto:contact+lscsoft/lalsuite@support.ligo.org
[install]: https://wiki.ligo.org/Computing/DASWG/LALSuiteInstall
[bugs]: https://git.ligo.org/lscsoft/lalsuite/issues/
[project]: https://wiki.ligo.org/Computing/DASWG/LALSuite
LALInspiral
================================
# LALInspiral
LAL routines for inspiral and ringdown CBC gravitational wave data
analysis.
Acknowledgment
--------------------------------
## 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](https://doi.org/10.7935/GT1W-FZ16).
An example bibtex entry could look like this:
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}",
......@@ -23,13 +20,12 @@ An example bibtex entry could look like this:
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.
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.
Basic Build Instructions
--------------------------------
## Basic Build Instructions
./configure --prefix=...
make
......@@ -38,19 +34,18 @@ Basic Build Instructions
Please read the [LALSuite install how-to][install] for more detailed
build instructions.
Bug Reporting
--------------------------------
## Bug Reporting
Please visit the [LALSuite bug reporting system][bugs] (LIGO.org
authentication required to submit new issues),
or use the e-mail helpdesk:
`contact+lscsoft/lalsuite@support.ligo.org`
authentication required to submit new issues), or use the [e-mail
helpdesk][helpdesk].
For More Information
--------------------------------
## For More Information
Please visit the [LALSuite project page][project].
[install]: https://wiki.ligo.org/Computing/DASWG/LALSuiteInstall
[bugs]: https://git.ligo.org/lscsoft/lalsuite/issues/
[project]: https://wiki.ligo.org/Computing/DASWG/LALSuite
[doi]: https://doi.org/10.7935/GT1W-FZ16
[helpdesk]: mailto:contact+lscsoft/lalsuite@support.ligo.org
[install]: https://wiki.ligo.org/Computing/DASWG/LALSuiteInstall
[bugs]: https://git.ligo.org/lscsoft/lalsuite/issues/
[project]: https://wiki.ligo.org/Computing/DASWG/LALSuite
LALMetaIO
================================
# LALMetaIO
LAL wrapping of the MetaIO LIGO_LW XML library.
Acknowledgment
--------------------------------
## 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](https://doi.org/10.7935/GT1W-FZ16).
An example bibtex entry could look like this:
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}",
......@@ -22,13 +19,12 @@ An example bibtex entry could look like this:
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.
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.
Basic Build Instructions
--------------------------------
## Basic Build Instructions
./configure --prefix=...
make
......@@ -37,19 +33,18 @@ Basic Build Instructions
Please read the [LALSuite install how-to][install] for more detailed
build instructions.
Bug Reporting
--------------------------------
## Bug Reporting
Please visit the [LALSuite bug reporting system][bugs] (LIGO.org
authentication required to submit new issues),
or use the e-mail helpdesk:
`contact+lscsoft/lalsuite@support.ligo.org`
authentication required to submit new issues), or use the [e-mail
helpdesk][helpdesk].
For More Information
--------------------------------
## For More Information
Please visit the [LALSuite project page][project].
[install]: https://wiki.ligo.org/Computing/DASWG/LALSuiteInstall
[bugs]: https://git.ligo.org/lscsoft/lalsuite/issues/
[project]: https://wiki.ligo.org/Computing/DASWG/LALSuite
[doi]: https://doi.org/10.7935/GT1W-FZ16
[helpdesk]: mailto:contact+lscsoft/lalsuite@support.ligo.org
[install]: https://wiki.ligo.org/Computing/DASWG/LALSuiteInstall
[bugs]: https://git.ligo.org/lscsoft/lalsuite/issues/
[project]: https://wiki.ligo.org/Computing/DASWG/LALSuite
LALPulsar
================================
# LALPulsar
LAL routines for pulsar and continuous wave gravitational wave data
analysis.
Acknowledgment
--------------------------------
## 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](https://doi.org/10.7935/GT1W-FZ16).
An example bibtex entry could look like this:
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}",
......@@ -23,13 +20,12 @@ An example bibtex entry could look like this:
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.
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.
Basic Build Instructions
--------------------------------
## Basic Build Instructions
./configure --prefix=...
make
......@@ -38,19 +34,18 @@ Basic Build Instructions
Please read the [LALSuite install how-to][install] for more detailed
build instructions.
Bug Reporting
--------------------------------
## Bug Reporting
Please visit the [LALSuite bug reporting system][bugs] (LIGO.org
authentication required to submit new issues),
or use the e-mail helpdesk:
`contact+lscsoft/lalsuite@support.ligo.org`
authentication required to submit new issues), or use the [e-mail
helpdesk][helpdesk].
For More Information
--------------------------------
## For More Information
Please visit the [LALSuite project page][project].
[install]: https://wiki.ligo.org/Computing/DASWG/LALSuiteInstall
[bugs]: https://git.ligo.org/lscsoft/lalsuite/issues/
[project]: https://wiki.ligo.org/Computing/DASWG/LALSuite
[doi]: https://doi.org/10.7935/GT1W-FZ16
[helpdesk]: mailto:contact+lscsoft/lalsuite@support.ligo.org
[install]: https://wiki.ligo.org/Computing/DASWG/LALSuiteInstall
[bugs]: https://git.ligo.org/lscsoft/lalsuite/issues/
[project]: https://wiki.ligo.org/Computing/DASWG/LALSuite
LALSimulation
================================
# LALSimulation
LAL routines for gravitational waveform and noise generation.
Acknowledgment
--------------------------------