https://github.com/unkaktus/rose
Gravitational wave volume visualizations
https://github.com/unkaktus/rose
aei apptainer bam einstein energry-flux gravitational-waves gravity paraview paraview-plugin sxs
Last synced: 6 months ago
JSON representation
Gravitational wave volume visualizations
- Host: GitHub
- URL: https://github.com/unkaktus/rose
- Owner: unkaktus
- License: mit
- Created: 2022-10-06T12:17:34.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-22T22:11:19.000Z (over 1 year ago)
- Last Synced: 2024-07-24T01:19:53.890Z (over 1 year ago)
- Topics: aei, apptainer, bam, einstein, energry-flux, gravitational-waves, gravity, paraview, paraview-plugin, sxs
- Language: Jupyter Notebook
- Homepage: https://unkaktus.art/rose
- Size: 2.63 MB
- Stars: 5
- Watchers: 4
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## rose
[](https://doi.org/10.5281/zenodo.14627565)
`rose` is a framework to visualize gravitational-wave radiation using ParaView.
It is based on [`gwpv`](https://github.com/nilsvu/gwpv) written by [Nils Vu](https://github.com/nilsvu). Check it out!
The name `rose` comes from the flower shapes of gravitaional emission of compact binary coalescences.
> Detrás de los zarzales salvajes de tu pecho \
> Hay una rosa que deslumbrará todo el jardín
_Ruido_ - La Prohibida
### Workflow
1. Create and activate Mamba/Conda environment with the Python version matching the one in ParaView
2. Install the dependencies
3. Start ParaView using `rose-pv` script to automatically load the plugins
4. Open the waveform files and setup the scene, and export the frames
5. Run the overplotting script to add legends, text, logos, and other data
6. Combine the frames into a video
5. Enjoy the results!
### Installation
1. Install Miniforge using the command below:
```
curl -L -O "https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-$(uname)-$(uname -m).sh"
bash Miniforge3-$(uname)-$(uname -m).sh
```
_In case you don't have internet access on the remote:_ use [`mitten`](https://github.com/unkaktus/mitten) instead of `ssh` to pass your internet connection to the remote.
2. Find the exact Python version your ParaView has. Go to ParaView->About ParaView and note down the "Python Library Version". For example, my ParaView 5.13.1 has Python 3.10.13.
3. Create and activate the Mamba environment for `rose` with the matching Python version and dependencies:
```shell
mamba create -y -n rose python=3.10.13 numpy scipy psutil astropy h5py spherical scri spherical_functions
mamba activate rose
```
4. From the `rose` directory root, start ParaView via `rose-pv` script by specifying path to your ParaView binary,
```shell
./rose-pv /path/to/paraview
```
or the application in case of macOS:
```shell
./rose-pv /Applications/ParaView-5.13.1.app
```
That will start the ParaView and load all `rose` plugins.
5. Now you are ready to open your waveform files using the appropriate reader. For example, `rhOverM_Asymptotic_GeometricUnits_CoM.h5` using `EnergyFluxVolumeReader`.
Note that at the momement `rose` supports only extrapolated waveforms in SXS catalog format, cf. Appendix A.3.1 of Boyle:2019kee.
### Running parallel state rendering on an HPC cluster
Running locally on your machine might be too slow or not fitting into RAM for high resolution. For that reason, you might want to run it on a more powerful cluster.
The idea here is to create the scene in ParaView locally, save it to a state file, and then render it on a remote cluster. As the paths to the data files might be different locally and on the cluster, one has to readjust them by editing the state file. As I didn't write yet the script to automatically swap the path, one has has to do it manually.
_To be written_
### Citing
If you used `rose` to produce your visuals, please cite it using the following [Zenodo record](https://doi.org/10.5281/zenodo.14627565).