From dace966d8708c37110b64461ffc43d4bd88ac8c2 Mon Sep 17 00:00:00 2001 From: Yifan Wang <yifan.wang@aei.mpg.de> Date: Mon, 30 May 2022 13:33:26 +0000 Subject: [PATCH] Update README.md --- README.md | 102 ++++++++++++------------------------------------------ 1 file changed, 23 insertions(+), 79 deletions(-) diff --git a/README.md b/README.md index 005072b..a1f985a 100644 --- a/README.md +++ b/README.md @@ -1,92 +1,36 @@ -# 2022-summer-eccwaveform +# 2022 Summer Undergraduate Research: Charactering the accuracy of gravitational waveform with eccentricity +## Greetings +Welcome to AEI! -## Getting started +We are researchers from the Max Planck Institute for Gravitationalphysics (Also called AEI, Albert Einstein Institute). AEI in Hannover carries on a variety of experimental, theoretical and numerical research topics on gravitational waves. AEI researchers develop and operate a ground-based gravitational wave detector GEO-600, look for and analyze the signals of gravitational waves from compact binary coalescence (CBC) and continuous waves (CW), and so on. A more detailed introduction of this institute can be found [here](https://www.aei.mpg.de). -To make it easy for you to get started with GitLab, here's a list of recommended next steps. +## Mentor: + - [Xisco](https://www.aei.mpg.de/person/101103/693322) + - [Yifan](https://yi-fan-wang.github.io). -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)! +## Brief Introduction on the research project -## Add your files +Gravitational wave astronomy has brought observational astronomy into a new era. So far over 90 gravitaitonal-wave events have been recorded by [LIGO](https://www.ligo.org) (Laser Interferometer Gravitational-wave Observatory) and [Virgo](https://www.virgo-gw.eu) detectors, all are from mergers of black holes or neutron stars. The discover has lead to significant scientific progress, e.g, testing the validity of general relativity in strong gravity regime, inferring the population synthesis of black holes and neutron stars, and so on. -- [ ] [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: +Inferring the source properties of gravitational waves require accurate modeling of waveform. So far most of the state-of-the-art analytical waveform approximate only takes the circular orbit into account, due to the expected fast circularization of gravitational wave on binary merger. However, eccentric binary mergers can be significant for future space-based detectors which probe low frequency band of gravitational wave (thus earlier stage of binary inspiral). Modeling of waveforms with eccentricity is also quickly under development. -``` -cd existing_repo -git remote add origin https://gitlab.aei.uni-hannover.de/interns-obsrelcos/2022-summer-eccwaveform.git -git branch -M main -git push -uf origin main -``` +In this project we utilize two recently developed waveform model, namely SEOBNRE ([1910.00784](https://arxiv.org/abs/1910.00784)) and TEOBresums ([2001.11736](https://arxiv.org/abs/2001.11736)), and a numerical relativity catalog ([2202.00018](https://arxiv.org/abs/2202.00018)) relesed most recently, to characterize the accuracy of the waveform modeling, and probe any potential implications to gravitational wave parameter estimation and detection for eccentric binary black hole / neutron star binaries. -## Integrate with your tools +## Research Goals: -- [ ] [Set up project integrations](https://gitlab.aei.uni-hannover.de/interns-obsrelcos/2022-summer-eccwaveform/-/settings/integrations) +- [ ] Generate the waveform of gravitational wave from eccentric binary black hole mergers using analytical approximant +- [ ] Generate the waveform of gravitational wave from numerical relativity simulation +- [ ] Charactering the accuracy of analytical waveform approximant -## Collaborate with your team +Advanced goals: +- [ ] Performing Bayesian parameter estimation for simulated and real gravitational wave data using eccentric waveform of gravitaitonal wave -- [ ] [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) +## Some useful papers: + - Validating the Effective-One-Body Numerical-Relativity Waveform Models for Spin-aligned Binary Black Holes along Eccentric Orbits [1910.00784](https://arxiv.org/abs/1910.00784) + - A faithful analytical effective one body waveform model for spin-aligned, moderately eccentric, coalescing black hole binaries [2001.11736](https://arxiv.org/abs/2001.11736) + - The Fourth RIT binary black hole simulations catalog: Extension to Eccentric Orbits [2202.00018](https://arxiv.org/abs/2202.00018) -## 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) - -*** - -# 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. - -## Description -Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors. - -## Badges -On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge. - -## Visuals -Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method. - -## Installation -Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection. - -## Usage -Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README. - -## Support -Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc. - -## Roadmap -If you have ideas for releases in the future, it is a good idea to list them in the README. - -## Contributing -State if you are open to contributions and what your requirements are for accepting them. - -For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. - -You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. - -## Authors and acknowledgment -Show your appreciation to those who have contributed to the project. - -## License -For open source projects, say how it is licensed. - -## Project status -If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers. +## Some waveform codes: + - https://bitbucket.org/eob_ihes/teobresums/src/eccentric/ -- GitLab