Skip to content

Commit a97508b

Browse files
committed
Adding info to start page and example to build page to match JOSS request
1 parent 2890cc4 commit a97508b

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

docs/online-docs/index.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ COMPAS
1111
======
1212

1313
**C**\ ompact **O**\ bject **M**\ ergers: **P**\ opulation **A**\ strophysics and **S**\ tatistics
14+
is a publicly available rapid stellar / binary population synthesis code designed so that evolution prescriptions and model parameters are
15+
easily adjustable. COMPAS draws properties for a binary star system from a set of initial distributions, and evolves it from
16+
zero-age main sequence to the end of its life as two compact remnants. It has been used for inference from observations of
17+
gravitational-wave mergers, Galactic neutron stars, X-ray binaries, and luminous red novae.
1418

1519
`... by` `TeamCOMPAS <https://compas.science/index.html>`_
1620

docs/online-docs/pages/Getting started/building-COMPAS.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,11 @@ in which all source files are compiled, type::
5454
The `clean` option instructs ``make`` to remove all existing object files (.o), and the COMPAS executable. A subsequent ``make`` is then forced to compile
5555
all source files and link the resultant object files (and external libraries) into a new executable.
5656

57+
The executable can be tested with, e.g.,
58+
59+
./COMPAS -v
60+
61+
which will display the code version.
5762

5863
See :doc:`../Developer guide/Developer build/COMPAS-local-build` for a detailed description of ``Makefile`` functionality.
5964

0 commit comments

Comments
 (0)