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

docs(readme): updated readme

Browse Source
This commit is contained in:
Emily Boudreaux
2025-02-16 14:33:31 -05:00
parent 189a4f5f0b
commit 41da26cd81
1 changed files with 13 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
Readme.md
View File

@@ -1,8 +1,16 @@
# New implimentation of 3+1D SSE
New (as yet unnamed) 4DSSE code.
We need an exciting name.
# Building
In order to build run
This code is very early in development and should not be used for scientific purposes yet.
## Building
In order to build you will need meson installed on your system. The easiest way to do this is to use the python package manager (pip)
```bash
pip install meson
```
You can then either use the mk script or meson commands automatically. When running either the script or meson commands manually `MFEM` will be pulled from github and built. As part of this a small patch will be applied to the MFEM `CMakeLists.txt` file. This process should only need to happen once as future builds will use the cached version of MFEM in `subprojects` and the cached build files of `MFEM` in `build`.
```bash
./mk
```
@@ -10,3 +18,6 @@ if you want to build with no test suite run
```bash
./mk --noTest
```
## Current Status
Currently we are working on implimenting modules such as opacity, equation of state, polytrope, and meshing. Builds may not work on any branches at any time.