SALSA
SALSA: A Python Package for Constructing Synthetic Quasar Absorption Line Catalogs from Astrophysical Hydrodynamic Simulations - Published in JOSS (2020)
Science Score: 95.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 5 DOI reference(s) in README and JOSS metadata -
✓Academic publication links
Links to: joss.theoj.org, zenodo.org -
✓Committers with academic emails
2 of 8 committers (25.0%) from academic institutions -
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Scientific Fields
Repository
Salsa is a Python package for constructing synthetic absorber catalogs from astrophysical hydrodynamic simulations
Basic Info
Statistics
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 4
- Releases: 2
Metadata Files
README.md
SALSA
SALSA: Synthetic Absorption Line Surveyor Application is a Python tool that constructs synthetic absorber catalogs from hydrodynamic galaxy simulations. Salsa heavily utilizes yt to access simulation data and Trident to create light rays/sight lines and generate synthetic spectra.
Observational studies generate large absorber catalogs by studying the absorption line spectra of distant quasars, as their light passes through intervening galaxies. Salsa can generate similar catalogs from cosmological and galactic simulations, allowing research to study these simulations from an observers perspective. This can give new insights into the data as well as help facilitate comparisons and collaboration between simulations and observations.
Salsa allows us to dip into galactic simulations and start to chip away at the many unknowns of the universe
A JOSS paper was published for SALSA and we recommend reading it for an overview of the package and its possible uses. If you do use SALSA in a project we ask that you cite this paper.
For detailed information on how to install and run salsa, Read the Docs here
Install
If you have all the dependencies installed, you can use pip and run these commands to install the most stable version: ``` $ pip install astro-salsa $ python
import salsa
If you want to install the latest development version and have all the dependencies installed, you can clone the repository and run these commands:$ git clone https://github.com/biboyd/SALSA.git $ cd SALSA $ pip install -e . $ python import salsa ``` Now you should be all set to code!
Installing dependencies
To help with installing dependencies, enivronment.yml is included in the
repository. First,
install conda
Then you should be able to create a conda environment via:
$ conda env create --file environment.yml
$ conda activate salsa-env
Note that you need gcc compiler installed (which it often already is on most machines).
For a more detailed description see the
installation guide
which also includes tips if you want to install dependencies on your own.
Getting Started
For an annotated example go here. Or launch an interactive jupyter hosted on Binder here (note that the notebook may take some time to load as it generally has to build the repository).
If you want to explore on your own, the easiest way to get started is use
salsa.generate_catalog(). This takes:
* The simulation dataset
* Number of light rays/sightlines to make
* Directory to save those light rays
* A list of ions
* Some other optional parameters.
This creates a number light rays and then extracts absorbers for each ion. A
pandas.DataFrame is returned with information about all the absorbers which
can then be further analyzed.
Contributing Guidelines
All contributions are welcome! This is an open-source project, built on many other open-source projects. Contributing can take many forms including: contributing code, testing and experimenting, or offering ideas for different features.
If you are interested in contributing you can contact us directly at boyd.brendan@stonybrook.edu or add an issue on this Github page.
Owner
- Name: Brendan Boyd
- Login: biboyd
- Kind: user
- Repositories: 3
- Profile: https://github.com/biboyd
Physics grad student at Stony Brook University
JOSS Publication
SALSA: A Python Package for Constructing Synthetic Quasar Absorption Line Catalogs from Astrophysical Hydrodynamic Simulations
Authors
Department of Physics and Astronomy, Michigan State University
Department of Computational Mathematics, Science and Engineering, Michigan State University
Department of Physics and Astronomy, Michigan State University, Department of Computational Mathematics, Science and Engineering, Michigan State University, National Superconducting Cyclotron Laboratory, Michigan State University
Space Telescope Science Institute, Department of Physics & Astronomy, Johns Hopkins University
Space Telescope Science Institute, Department of Physics & Astronomy, Johns Hopkins University
Space Telescope Science Institute
Editor
Daniel S. Katz
Tags
astronomy simulation spectraGitHub Events
Total
Last Year
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| boydbre1 | b****1@m****u | 348 |
| biboyd | b****6@g****m | 134 |
| boydbre1 | 4****1 | 7 |
| Brendan Isaac Seaton Boyd | b****1@d****i | 5 |
| Brendan Isaac Seaton Boyd | b****1@d****i | 4 |
| Brendan Boyd | b****1@d****i | 3 |
| Brendan Isaac Seaton Boyd | b****1@d****i | 2 |
| Daniel S. Katz | d****z@i****g | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 6
- Total pull requests: 4
- Average time to close issues: 3 days
- Average time to close pull requests: 11 minutes
- Total issue authors: 3
- Total pull request authors: 3
- Average comments per issue: 1.33
- Average comments per pull request: 0.0
- Merged pull requests: 3
- Bot issues: 0
- Bot pull requests: 1
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- clairekope (3)
- zpace (2)
- olebole (1)
Pull Request Authors
- biboyd (2)
- dependabot[bot] (1)
- danielskatz (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 34 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 1
- Total maintainers: 1
pypi.org: astro-salsa
Synthetic absorber catalog generator from astrophysical simulations
- Homepage: https://github.com/biboyd/SALSA
- Documentation: https://astro-salsa.readthedocs.io/
- License: BSD 3-Clause
-
Latest release: 1.0.0
published about 5 years ago
Rankings
Maintainers (1)
Dependencies
- astropy ==3.2.3
- gwcs ==0.10.0
- spectacle *
- specutils ==0.5.2
- trident *
- matplotlib <=3.2.1 test
- mpi4py * test
- numpy ==1.16.6 test
- pandas * test
- pip * test
- pytest * test
- scipy * test
- yt * test