Simplify readme (#338)

* Simplified README

* README reshuffle

* Moved intro to index

README.md

@@ -11,53 +11,56 @@ Summary: A Python package for computing the bubble wall speed for cosmological p
 
 Development: https://github.com/Wall-Go/WallGo
 
+
 ## Status
 
 [![Version](https://img.shields.io/github/v/tag/Wall-Go/WallGo?label=Version)](https://github.com/Wall-Go/WallGo/tags/)
 
 [![WallGo tests (main)](https://github.com/Wall-Go/WallGo/actions/workflows/main.yml/badge.svg)](https://github.com/Wall-Go/WallGo/actions/workflows/main.yml)
 
+
 ## About this project
 
 [**WallGo**](https://wallgo.readthedocs.io) is an open source code for the computation of the bubble wall velocity and bubble wall width in first-order cosmological phase transitions.
 The main WallGo Python package determines the wall velocity and width by solving the scalar field(s) equation of motion, the Boltzmann equations and energy-momentum conservation for the fluid velocity and temperature.
 
 The [**WallGo**](https://github.com/Wall-Go/WallGo) package is accompanied by two subsidiary software packages:
-- [**WallGoMatrix**](https://github.com/Wall-Go/WallGoMatrix) computes the relevant matrix elements for the out-of-equilibrium particles, and is written in Mathematica. It builds on existing Mathematica packages [DRalgo](https://github.com/DR-algo/DRalgo) and [GroupMath](https://renatofonseca.net/groupmath).
 - [**WallGoCollision**](https://github.com/Wall-Go/WallGoCollision) performs the higher-dimensional integrals to obtain the collision terms in the Boltzmann equations, and is written in C++. It also has Python bindings so that it can be called directly from Python, but still benefits from the speedup from compiled C++ code.
+- [**WallGoMatrix**](https://github.com/Wall-Go/WallGoMatrix) computes the relevant matrix elements for the out-of-equilibrium particles, and is written in Mathematica. It builds on existing Mathematica packages [DRalgo](https://github.com/DR-algo/DRalgo) and [GroupMath](https://renatofonseca.net/groupmath).
 
 Users can implement their own models by specifying an effective potential and a list of out-of-equilibrium particles and their corresponding interactions.
 
+
 ## Installation
 
-WallGo can be installed as a Python package (in developer mode) with pip, using:
+WallGo can be installed with pip, using:
 
-    python -m pip install -e .
+    pip install WallGo
 
-(or equivalent with python3) from the base directory of the repository.
+If you have an existing installation, add the flag `--upgrade` to get the latest (stable) release.
 
-To also install the requirements for tests, linting and the documentation
-instead run
+Alternatively, to get the latest (unstable) development version from the repository, run:
 
-    python -m pip install -e ".[docs,lint,tests]"
+    git clone [email protected]:Wall-Go/WallGo.git
+    cd WallGo
+    pip install -e .
 
 
 ### Requirements
 
-WallGo is based on Python 3. Necessary requirements are installed automatically with
-pip. They can be found in the file `pyproject.toml`.
-
+WallGo requires Python 3.10 or above.
 
-### Tests
 
-Tests can be run from the base directory with:
+## Quick start
 
-    pytest -v
+A first example model is explained in the
+[WallGo documentation](https://wallgo.readthedocs.io/en/latest/firstExample.html).
 
 
-## Examples
+### Examples
 
-A number of example models are collected in the directory `Models/`, including the following:
+A number of example models are collected in the repository in the folder
+[Models](https://github.com/Wall-Go/WallGo/tree/main/Models), including the following:
 
 - Standard Model with light Higgs
 - Inert Doublet Model
@@ -68,7 +71,7 @@ A number of example models are collected in the directory `Models/`, including t
 After installing the package, these examples can be run directly with Python, as
 in:
 
-    python3 Models/SingletStandardModel_Z2/singletStandardModelZ2.py
+    python Models/SingletStandardModel_Z2/singletStandardModelZ2.py
 
 
 ## Feedback and further questions

docs/source/development.rst

@@ -11,8 +11,8 @@ additional functionality. The latest developments are available from our
 To install the development version, run the following::
 
     git clone https://github.com/Wall-Go/WallGo.git
-    cd bubble_det
-    python3 -m pip install -e ".[docs,tests,lint]"
+    cd WallGo
+    pip install -e ".[docs,tests,lint]"
 
 
 Tests can then be run with::

docs/source/index.rst

@@ -4,12 +4,28 @@ WallGo documentation
 
 WallGo is an open source code for the computation of the bubble wall velocity and bubble wall width in first-order cosmological phase transitions. If you use WallGo, please cite arXiv:....
 
+As the universe cooled after the Hot Big Bang, it may have gone through any number of cosmological first-order phase transitions. Such transitions proceed via the nucleation and growth of bubbles, as shown in the image below. :footcite:p:`Weir_2016` The collisions of these bubbles may lead to an observable gravitational wave signal today, depending on the speed of the bubble walls as they collide.
+
+.. image:: figures/weir-bubbles1.jpeg
+    :width: 400
+    :align: center
+    :alt: Bubbles growing in a cosmological phase transition.
+
+|
+
+How fast does the bubble wall go? WallGo is a Python package for answering this question. Our methods largely follow previous work by Laurent and Cline. :footcite:p:`Laurent:2022jrs`
+
+**********
+References
+**********
+
+.. footbibliography::
+
 
 .. toctree::
     :caption: Getting Started:
     :hidden:
 
-    intro
     installation
     firstExample
     examples