From 2f907996325f96386f2b518074afb61d4df10aaf Mon Sep 17 00:00:00 2001 From: Niels Claes Date: Fri, 14 Apr 2023 14:45:03 +0200 Subject: [PATCH] updated README --- README.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index f6a27958..ddb8f536 100644 --- a/README.md +++ b/README.md @@ -6,24 +6,26 @@ [![legolas](https://github.com/n-claes/legolas/actions/workflows/legolas.yml/badge.svg?branch=master)](https://github.com/n-claes/legolas/actions/workflows/legolas.yml) [![pylbo](https://github.com/n-claes/legolas/actions/workflows/pylbo.yml/badge.svg?branch=master)](https://github.com/n-claes/legolas/actions/workflows/pylbo.yml) [![docs](https://github.com/n-claes/legolas/actions/workflows/docs.yml/badge.svg?branch=master)](https://github.com/n-claes/legolas/actions/workflows/docs.yml) [![codecov](https://codecov.io/gh/n-claes/legolas/branch/master/graph/badge.svg?token=OVLYGOADS7)](https://codecov.io/gh/n-claes/legolas) [![GitHub release (latest by date)](https://img.shields.io/github/v/release/n-claes/legolas?color=blue&label=release&style=flat)](https://github.com/n-claes/legolas/releases) [![Slack](https://img.shields.io/static/v1?label=Slack&message=join%20us&style=flat&logo=Slack&logoColor=white&color=orange)](https://join.slack.com/t/the-legolas-code/shared_invite/zt-tsb5yaht-LtLWHzVu8Zux~Yt3PBx32Q) ### Table of contents -1. [About](#about-legolas) +1. [About](#about) 2. [Documentation](#documentation) -3. [Versions](#stable-and-develop-versions) +3. [Versions](#versions) 4. [Using Legolas](#using-legolas) -## About Legolas -The main goal of Legolas is to provide a new and modern user-friendly code while making use of the most recent developments in linear algebra and theoretical (linear) MHD, allowing for high resolution eigenspectrum studies with various physical effects included. +## About +Legolas is a modern and user-friendly large-scale object oriented framework, capable of solving (subsets of) the full set of linearised magnetohydrodynamic equations for a general three-dimensional state with one-dimensional variation in either Cartesian or cylindrical geometries. Fourier modes are imposed in the other coordinates. The code is written in modern Fortran and relies on a Finite Element treatment to reduce the resulting system of differential equations to a large-scale complex, non-Hermitian eigenvalue problem. Legolas interfaces with the BLAS/LAPACK/ARPACK libraries, resulting in detailed eigenspectrum calculations with corresponding eigenfunctions. An efficient treatment of the underlying datastructure allows the code to run on regular laptops at high resolutions, and a complementary post-processing framework is provided for interactive visualisation and analysis of the results. + +Legolas supports the inclusion of background flows, external gravity, anisotropic thermal conduction, resistivity, optically thin radiative losses, heating, viscosity, and full Hall MHD; most of these are fully customisable by the user. Legolas is being developed and maintained at the [Centre for mathematical Plasma-Astrophysics](https://wis.kuleuven.be/CmPA), KU Leuven, Belgium. ## Documentation -We have a dedicated website on [legolas.science](https://legolas.science) which contains a detailed guide on how to install, compile and use the code. There you can also find the source code documentation of both Legolas and the post-processing framework Pylbo, which is rendered straight from the `master` (or `develop`) branch and updated on every commit. - -## Stable and develop versions -The `master` branch of this repository should contain the latest stable release of the code, the main website is built from this branch. If you would like to check out the latest development goodies instead you can take a look at the `develop` branch. As there may be some time between major releases it is possible that the development branch can be quite different from the stable branch. However, the development version has its own dedicated website at [dev.legolas.science](https://dev.legolas.science), for those who want to use the bleeding-edge version of the code. +We have a dedicated website on [legolas.science](https://legolas.science) which contains a detailed guide on how to install, compile and use the code. Source code documentation is regenerated automatically with each commit on both the `master` and `develop` branches. -Note that while everything on the `develop` branch _should_ be stable, it is possible that some features there are still under development and/or not yet entirely tested or documented. +## Versions +We (try to) ensure that the `master` branch of this repository is always stable and ready for use. +If you would like to check out the latest development goodies instead you can take a look at the `develop` branch, but note that since there may be some time between major releases it is possible that the development branch differs from the latest stable release. The development version of Legolas has its own dedicated website at [dev.legolas.science](https://dev.legolas.science), for those who want to use the bleeding-edge version of the code. +Note that while everything on the `develop` branch _should_ be stable, it is possible that some features there are still under development and/or not yet fully tested or documented. ## Using Legolas :warning: **Please note**