Skip to content
Snippets Groups Projects
Commit df6d1cf3 authored by Sylvia Plöckinger's avatar Sylvia Plöckinger
Browse files

Update README.md

parent 7f5b9df7
Branches
No related tags found
No related merge requests found
# Setup galaxy simulations
## Description
Reproduce the isolated disk galaxy simulations from Ploeckinger et al. (subm. 2023).
## Getting started
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
## Add your files
## Installation
The isolated galaxy simulations presented in Ploeckinger et al. (subm. 2023) use the [SWIFT](www.swiftsim.com) code (Schaller et al. [arXiv](https://arxiv.org/abs/2305.13380)). For reproducing these simulations install SWIFT following the information [here](https://swift.strw.leidenuniv.nl/docs/GettingStarted/index.html).
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
This repository contains the parameter file used in these simulations. Note, that in the future, the required parameters for the individual modules may change. After installing all [dependencies](https://swift.strw.leidenuniv.nl/docs/GettingStarted/compiling_code.html#dependencies) of SWIFT successfully, the SWIFT version used in Ploeckinger et al. (subm. 2023) can be setup and compiled with
```
cd existing_repo
git remote add origin https://gitlab.phaidra.org/softenedjeanscriteria/setup-galaxy-simulations.git
git branch -M main
git push -uf origin main
git clone https://github.com/SWIFTSIM/SWIFT.git
cd SWIFT
git checkout v0.9.0-1182-g423e9dd8
./autogen.sh
./configure --with-subgrid=EAGLE-XL --with-hydro=sphenix --with-kernel=quartic-spline --with-ext-potential=hernquist --with-tbbmalloc --disable-hand-vec --enable-ipo
make
```
## Integrate with your tools
- [ ] [Set up project integrations](https://gitlab.phaidra.org/softenedjeanscriteria/setup-galaxy-simulations/-/settings/integrations)
## Collaborate with your team
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
## Test and Deploy
Use the built-in continuous integration in GitLab.
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
***
If the code compiled successfully, an executable `swift` is produced in the SWIFT folder.
# Editing this README
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
## Suggestions for a good README
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
## Name
Choose a self-explaining name for your project.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment