https://github.com/4d-star/ester_nix
https://github.com/4d-star/ester_nix
nix stellar-evolution
Last synced: 16 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/4d-star/ester_nix
- Owner: 4D-STAR
- License: mit
- Created: 2024-08-11T08:47:48.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-01-15T15:59:56.000Z (6 months ago)
- Last Synced: 2025-06-30T20:06:47.482Z (16 days ago)
- Topics: nix, stellar-evolution
- Language: Nix
- Homepage:
- Size: 16.6 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Ester Nix
[Evolution STEllaire en Rotation (Ester)](https://github.com/ester-project/ester) is a 2d stellar evolution code. This repo provides a script to build a C++/Fortran/Python development environment to compile and execute ester using the [Nix](https://nix.dev) ecosystem.
## Pre-requisites
The only requirement is Nix itself. Install Nix following the instructions at https://nixos.org/download/.
Alternatively, you can use one-liner for installing Determinate Nix
```
curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install --determinate
```Test your installation by running
```
nix --version
```which should return something like `nix (Nix) 2.24.1`.
## Using this repo
Clone or download this repo. Then open a terminal, navigate to the root of this repository and execute
```
nix develop --extra-experimental-features nix-command --extra-experimental-features flakes
```This will instantiate the development environment and compile Ester's `evolution` branch. Upon finishing, you will be in a bash shell with the following commands available: `star1d`, `star2d`, `star_evol`.
## Why Nix
The lock file in this directory guarantees a consistent development environment, greatly facilitating the installation of ester across different distributions
## Notes and TODOs
-The build has been tested in Ubuntu, Arch Linux, Rocky Linux, MacOS(M1) and in Windows through the [WSL](https://learn.microsoft.com/en-us/windows/wsl/install)