tboudreaux/SERiF
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(readme): updated logo

Browse Source
This commit is contained in:
Emily Boudreaux
2025-05-22 07:30:50 -04:00
parent 32cdb76509
commit def379e8ab
1 changed files with 12 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
Readme.md
View File

@@ -1,6 +1,11 @@
# SERiF
<p style="display: flex; justify-content: center;">
<img src="assets/logo/serifLogo.png" width="300" alt="Logo">
</p>
## 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.