{"id":19386700,"url":"https://github.com/unkaktus/rose","last_synced_at":"2025-04-23T23:30:36.377Z","repository":{"id":65944584,"uuid":"546645837","full_name":"unkaktus/rose","owner":"unkaktus","description":"Gravitational wave volume visualizations","archived":false,"fork":false,"pushed_at":"2024-07-22T22:11:19.000Z","size":2756,"stargazers_count":5,"open_issues_count":3,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-07-24T01:19:53.890Z","etag":null,"topics":["aei","apptainer","bam","einstein","energry-flux","gravitational-waves","gravity","paraview","paraview-plugin","sxs"],"latest_commit_sha":null,"homepage":"https://unkaktus.art/rose","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/unkaktus.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-10-06T12:17:34.000Z","updated_at":"2024-07-22T22:11:22.000Z","dependencies_parsed_at":null,"dependency_job_id":"d446ba21-f26a-4ea1-8915-6fe3f751690a","html_url":"https://github.com/unkaktus/rose","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unkaktus%2Frose","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unkaktus%2Frose/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unkaktus%2Frose/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unkaktus%2Frose/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/unkaktus","download_url":"https://codeload.github.com/unkaktus/rose/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223936992,"owners_count":17228140,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aei","apptainer","bam","einstein","energry-flux","gravitational-waves","gravity","paraview","paraview-plugin","sxs"],"created_at":"2024-11-10T10:07:15.047Z","updated_at":"2025-04-23T23:30:36.370Z","avatar_url":"https://github.com/unkaktus.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"![The rose](rose.png)\n\n\n## rose\n\n[![DOI](https://zenodo.org/badge/546645837.svg)](https://doi.org/10.5281/zenodo.14627565)\n\n`rose` is a framework to visualize gravitational-wave radiation using ParaView.\n\nIt is based on [`gwpv`](https://github.com/nilsvu/gwpv) written by [Nils Vu](https://github.com/nilsvu). Check it out!\n\nThe name `rose` comes from the flower shapes of gravitaional emission of compact binary coalescences.\n\n\u003e Detrás de los zarzales salvajes de tu pecho \\\n\u003e Hay una rosa que deslumbrará todo el jardín\n\n_Ruido_ - La Prohibida\n\n### Workflow\n1. Create and activate Mamba/Conda environment with the Python version matching the one in ParaView\n2. Install the dependencies\n3. Start ParaView using `rose-pv` script to automatically load the plugins\n4. Open the waveform files and setup the scene, and export the frames\n5. Run the overplotting script to add legends, text, logos, and other data\n6. Combine the frames into a video\n5. Enjoy the results!\n\n\n### Installation\n\n1. Install Miniforge using the command below:\n\n```\ncurl -L -O \"https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-$(uname)-$(uname -m).sh\"\nbash Miniforge3-$(uname)-$(uname -m).sh\n```\n\n_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.\n\n2. Find the exact Python version your ParaView has. Go to ParaView-\u003eAbout ParaView and note down the \"Python Library Version\". For example, my ParaView 5.13.1 has Python 3.10.13.\n\n3. Create and activate the Mamba environment for `rose` with the matching Python version and dependencies:\n\n```shell\nmamba create -y -n rose python=3.10.13 numpy scipy psutil astropy h5py spherical scri spherical_functions\nmamba activate rose\n```\n4. From the `rose` directory root, start ParaView via `rose-pv` script by specifying path to your ParaView binary, \n\n```shell\n./rose-pv /path/to/paraview\n```\n\nor the application in case of macOS:\n\n```shell\n./rose-pv /Applications/ParaView-5.13.1.app\n```\n\nThat will start the ParaView and load all `rose` plugins.\n\n5. Now you are ready to open your waveform files using the appropriate reader. For example, `rhOverM_Asymptotic_GeometricUnits_CoM.h5` using `EnergyFluxVolumeReader`.\nNote that at the momement `rose` supports only extrapolated waveforms in SXS catalog format, cf. Appendix A.3.1 of Boyle:2019kee.\n\n### Running parallel state rendering on an HPC cluster\n\nRunning 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.\n\nThe 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.\n\n_To be written_\n\n### Citing\n\nIf you used `rose` to produce your visuals, please cite it using the following [Zenodo record](https://doi.org/10.5281/zenodo.14627565).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funkaktus%2Frose","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Funkaktus%2Frose","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funkaktus%2Frose/lists"}