Skip to content

temuller/astro-visualization

Repository files navigation

Astro-Visualization

A repository for pretty astronomical plots

This repository started as a hack project during AstroHackWeek2020. If you make use of this website in your work, please add us to your Acknowledgements: "This work has made used of the Astro-Visualization website".


Contributing

Do you have a pretty plot you would like to share with the rest of the astronomy community? Wonderful! We require an image (in png or jpg format) of your beautiful plot/figure, a title, a caption (can contain Latex symbols) and the source code used to create it. Optionally, you can add your name, affiliation and link to the original plot/figure/animation (e.g., publication, website), among other things. Also, don't forget to add tags to your plot (e.g., stars, galaxies, planets). See the available tags under Gallery on the website. Suggestions are welcome!

There are two main ways of contributing:

  1. Via Pull Request (recommended): you will need to fork the repository for this (check this link for more info on how to fork a repository). Create a new directory, with the title of your plot as the name, under astro-visualization/content/gallery/. You can copy any of the directories that are already in there. Modify the content of index.md however you see fit, but follow the same structure (this is a markdown file). The file containing the image needs to have the name featured.jpg or featured.png. When you are ready, make the pull request adding a short description. Use the title of your plot as the title of your pull request. It is important to select the option Allow edits from maintainers.

  2. Via email: if you are not familiar with Github, no problem! Just send us all the files via email. Create a file called metada.txt with all your personal information, the title of the plot, source code, etc., and the file of the image you wish to upload (in png or jpg format).


Contributors

Tomás E. Müller-Bravo ([email protected])
Johnny Esteves
Brigitta Sipöcz