Line data    Source code

       1           0 : \cond NEVER
       2             : Distributed under the MIT License.
       3             : See LICENSE.txt for details.
       4             : \endcond
       5             : \mainpage Introduction
       6             : 
       7             : \tableofcontents
       8             : 
       9             : \htmlonly
      10             : <p>
      11             : <a
      12             : href="https://github.com/sxs-collaboration/spectre/blob/develop/LICENSE.txt"><img
      13             : src="https://img.shields.io/badge/license-MIT-blue.svg"
      14             : alt="license"
      15             : data-canonical-src="https://img.shields.io/badge/license-MIT-blue.svg"
      16             : style="max-width:100%;"></a>
      17             : 
      18             : <a href="https://en.wikipedia.org/wiki/C%2B%2B#Standardization"
      19             : rel="nofollow"><img
      20             : src="https://img.shields.io/badge/c%2B%2B-17-blue.svg"
      21             : alt="Standard"
      22             : data-canonical-src="https://img.shields.io/badge/c%2B%2B-17-blue.svg"
      23             : style="max-width:100%;"></a>
      24             : 
      25             : <a href="https://github.com/sxs-collaboration/spectre/actions" rel="nofollow"><img
      26             : src="https://github.com/sxs-collaboration/spectre/workflows/Tests/badge.svg?branch=develop"
      27             : alt="Build Status"
      28             : data-canonical-src="https://github.com/sxs-collaboration/spectre/workflows/Tests/badge.svg?branch=develop"
      29             : style="max-width:100%;"></a>
      30             : 
      31             : <a href="https://coveralls.io/github/sxs-collaboration/spectre?branch=develop"
      32             : rel="nofollow"><img
      33             : src="https://camo.githubusercontent.com/9ac925f8d36b285f98b8dbc9b977606a5148d9b5/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6769746875622f7378732d636f6c6c61626f726174696f6e2f737065637472652f62616467652e7376673f6272616e63683d646576656c6f70"
      34             : alt="Coverage Status"
      35             : data-canonical-src="https://coveralls.io/repos/github/sxs-collaboration/spectre/badge.svg?branch=develop"
      36             : style="max-width:100%;"></a>
      37             : 
      38             : <a href="https://codecov.io/gh/sxs-collaboration/spectre" rel="nofollow"><img
      39             : src="https://camo.githubusercontent.com/ac504b33d403e271c9fb3831d1133118f1886317/68747470733a2f2f636f6465636f762e696f2f67682f7378732d636f6c6c61626f726174696f6e2f737065637472652f6272616e63682f646576656c6f702f67726170682f62616467652e737667"
      40             : alt="codecov"
      41             : data-canonical-src="https://codecov.io/gh/sxs-collaboration/spectre/branch/develop/graph/badge.svg"
      42             : style="max-width:100%;"></a>
      43             : 
      44             : </p>
      45             : \endhtmlonly
      46             : 
      47             : # What is SpECTRE? {#intro_sec}
      48             : 
      49             : SpECTRE is an open-source code for multi-scale, multi-physics problems
      50             : in astrophysics and gravitational physics. In the future, we hope that
      51             : it can be applied to problems across discipline boundaries in fluid
      52             : dynamics, geoscience, plasma physics, nuclear physics, and
      53             : engineering. It runs at petascale and is designed for future exascale
      54             : computers.
      55             : 
      56             : SpECTRE is being developed in support of our collaborative Simulating
      57             : eXtreme Spacetimes (SXS) research program into the multi-messenger
      58             : astrophysics of neutron star mergers, core-collapse supernovae, and
      59             : gamma-ray bursts.
      60             : 
      61             : ## Citing SpECTRE
      62             : 
      63             : Please cite SpECTRE in any publications that make use of its code or data. Cite
      64             : the latest version that you use in your publication. The DOI for this version
      65             : is:
      66             : 
      67             : - DOI: [\spectredoi](https://doi.org/\spectredoi)
      68             : 
      69             : You can cite this BibTeX entry in your publication:
      70             : 
      71             : \include citation.bib
      72             : 
      73             : To aid reproducibility of your scientific results with SpECTRE, we recommend you
      74             : keep track of the version(s) you used and report this information in your
      75             : publication. We also recommend you supply the YAML input files and, if
      76             : appropriate, any additional C++ code you wrote to compile SpECTRE executables as
      77             : supplemental material to the publication.
      78             : 
      79             : See our [publication policy](https://spectre-code.org/publication_policies.html)
      80             : for more information.
      81             : 
      82             : ## Navigating the Documentation {#navigate_documentation_sec}
      83             : 
      84             : The SpECTRE documentation is organized into tutorials, developer guides, groups
      85             : of related code, namespaces, and files for easier navigation. These can all be
      86             : accessed by links in the menu bar at the top.
      87             : 
      88             : - For instructions on **installing SpECTRE** on personal computers and clusters
      89             :   consult the \ref installation "Installation" and \ref installation_on_clusters
      90             :   "Installation on clusters" pages, respectively.
      91             : - If you are looking to **run simulations with SpECTRE** we recommend starting
      92             :   with the \ref tutorials "User Tutorials". The tutorials are designed to get
      93             :   users up and running with a simulation, as well as analyzing and visualizing
      94             :   the output.
      95             : - For people looking to **contribute to SpECTRE** there are tutorials on the
      96             :   \ref dev_guide "Dev Guide" page. For instance, the dev guide details the \ref
      97             :   code_review_guide "code review guidelines", how to \ref writing_unit_tests
      98             :   "write unit tests", how to \ref writing_good_dox "write documentation", and
      99             :   also provides information about C++ and the philosophy behind SpECTRE
     100             :   development.
     101             : - The [Code modules](modules.html) section contains groups of related code
     102             :   (managed through doxygen groups). For example, there is a group for all the
     103             :   data structures we use, a group for utility functions and classes, as well as
     104             :   groups for coordinate maps, domain creation, and many others. The
     105             :   [Code modules](modules.html) are designed to help developers discover existing
     106             :   functionality so that things are not re-implemented several times.
     107             : - You can also get an overview of the code base by namespace by visiting the
     108             :   [Namespaces](namespaces.html) section.
     109             : - To browse all files in the repository you can visit the
     110             :   [GitHub repository](https://github.com/sxs-collaboration/spectre) directly.