From def379e8abad295285adb0d039986e901fde85f4 Mon Sep 17 00:00:00 2001 From: Emily Boudreaux Date: Thu, 22 May 2025 07:30:50 -0400 Subject: [PATCH] docs(readme): updated logo --- Readme.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/Readme.md b/Readme.md index 7836ad4..4fc24f4 100644 --- a/Readme.md +++ b/Readme.md @@ -1,6 +1,11 @@ -# SERiF +

+ Logo +

+ ## Stellar Evolution and Rotation in Four dimensions. -___N.B.___ This code is very early in development and should not be used for scientific purposes yet. + +> ⚠️ This code is very early in development and should not be used for scientific purposes yet. +---- ## Introduction SERiF is a stellar structure and evolution program written in C++. This README will eventually provide guidance on how end users (i.e. non SERiF developers) can use the code. However, due @@ -22,7 +27,11 @@ of dependencies. Let us therefore first look at what depdendencies SERiF has. ### Dependencies There are only a small number of dependencies which must be installed by the user 1. pip -2. clang/gcc +2. clang/gcc (clang >= 16, gcc >= 13) +3. ninja +4. meson + +Further, if you use the `mk` script `ninja` and `meson` can even be installed for you! There are a number of dependencies which are automatically installed by our build system. These are all stored in the `subprojects` 1. MFEM - MFEM is a finite element modeling library developed primarily by a team at Lawrence Livermore National Labs. MFEM is used as our primary solver.