https://github.com/arjunsavel/scope

Simulating high-resolution cross-correlation spectroscopy of exoplanet atmospheres.

https://github.com/arjunsavel/scope

Science Score: 46.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
  • Academic publication links
    Links to: arxiv.org
  • Committers with academic emails
    3 of 4 committers (75.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.5%) to scientific vocabulary

Keywords

astronomy atmospheres exoplanets
Last synced: 7 months ago · JSON representation

Repository

Simulating high-resolution cross-correlation spectroscopy of exoplanet atmospheres.

Basic Info
Statistics
  • Stars: 3
  • Watchers: 1
  • Forks: 2
  • Open Issues: 29
  • Releases: 8
Topics
astronomy atmospheres exoplanets
Created over 2 years ago · Last pushed about 1 year ago
Metadata Files
Readme License Code of conduct

README.md

scope

Documentation Status License: MIT Code style: black pre-commit CodeQL Tests codecov Maintainability PyPI - Version

Simulating high-resolution cross-correlation spectroscopy for exoplanet atmospheres. Currently supports simulating IGRINS (on Gemini-S), IGRINS-2 (on Gemini-N), and CRIRES+ (on the VLT) observations of transmission and emission spectra.

installation

You can install scope using pip: pip install scope-astr

To install from source, run python3 -m pip install -U pip python3 -m pip install -U setuptools setuptools_scm pep517 git clone https://github.com/arjunsavel/scope cd scope python3 -m pip install -e .

You'll also need to download some data files. Currently, these data files are about 141 MB large. You can download them (to the correct directory, even!) with the following:

cd src/scope chmod +x download_data.bash ./download_data.bash

This will create a data directory and plop the relevant files into it. You're also welcome to run the tests to make sure everything's been installed correctly:

pytest .

workflow

For more details, see the documentation.

Ideally, most user interaction with scope will simply occur through the input file (scope/input.txt). Any data field in a row marked with the [DB] flag can be pulled from a local database by inputting DATABASE. In our case, a database simply refers to a CSV containing contents from the Exoplanet Archive, with planet parameters resolved with the planet name. You can also specify most arguments from the command line, overwriting the input file.

Simply edit the input file to the desired parameters, then run:

python run_simulation.py

Running the script requires exoplanet, stellar, and telluric spectra. Default spectra and parameters currently correspond to the exoplanet WASP-77Ab.

Once completed, the code will create a directory for the data in output/ (based on the input modelname) with the following types of files: - simdata_: the simulated flux cube with PCA performed. That is, the principal components with the largest variance have been removed. - nopca_simdata_: the simulated flux cube, including all spectral components (exoplanet, star, blaze function, tellurics). - A_noplanet_: the simulated flux cube with the lowest-variance principal component(s) removed. - lls_: the log-likelihood surface for the simulated flux cube, as a Kp--Vsys map. - ccfs_: the cross-correlation function for the simulated flux cube, as a Kp--Vsys map.

attribution

If you use scope in your work, please cite our paper: https://arxiv.org/abs/2411.07303

Owner

  • Name: Arjun Savel
  • Login: arjunsavel
  • Kind: user
  • Company: @astroumd

PhD candidate at UMD, College Park | exoplanet atmospheres 🪐

GitHub Events

Total
  • Create event: 32
  • Release event: 4
  • Issues event: 61
  • Watch event: 3
  • Delete event: 2
  • Issue comment event: 63
  • Push event: 91
  • Pull request event: 47
  • Fork event: 2
Last Year
  • Create event: 32
  • Release event: 4
  • Issues event: 61
  • Watch event: 3
  • Delete event: 2
  • Issue comment event: 63
  • Push event: 91
  • Pull request event: 47
  • Fork event: 2

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 360
  • Total Committers: 4
  • Avg Commits per committer: 90.0
  • Development Distribution Score (DDS): 0.028
Past Year
  • Commits: 282
  • Committers: 4
  • Avg Commits per committer: 70.5
  • Development Distribution Score (DDS): 0.035
Top Committers
Name Email Commits
arjunsavel a****l@g****m 350
Arjun Savel a****l@l****u 7
Arjun Savel a****l@l****u 2
Arjun Savel a****l@l****u 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 45
  • Total pull requests: 40
  • Average time to close issues: about 2 months
  • Average time to close pull requests: about 10 hours
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 0.82
  • Average comments per pull request: 0.6
  • Merged pull requests: 29
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 30
  • Pull requests: 40
  • Average time to close issues: about 21 hours
  • Average time to close pull requests: about 10 hours
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.57
  • Average comments per pull request: 0.6
  • Merged pull requests: 29
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • arjunsavel (71)
Pull Request Authors
  • arjunsavel (79)
Top Labels
Issue Labels
enhancement (44) bug (14) documentation (6) data-analysis (5) physics (4) packaging (2) high priority (1) hard (1) testing (1) future-helping (1)
Pull Request Labels
enhancement (6) packaging (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 12 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 3
  • Total maintainers: 1
pypi.org: scope-astr

Simulating high-resolution spectroscopy of exoplanet atmospheres.

  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 12 Last month
Rankings
Dependent packages count: 10.1%
Average: 33.5%
Dependent repos count: 56.9%
Maintainers (1)
Last synced: 7 months ago

Dependencies

docs/doc_requirements.txt pypi
  • nbsphinx *
  • sphinx_book_theme *
environment.yml pypi
requirements.txt pypi
  • exoplanet *
  • jax *
  • numba *
  • numpy *
  • scikit-learn *
  • scipy *
  • tqdm *
setup.py pypi