Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

scope

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

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

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.

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.

Metadata

Release files for scope-astr 0.4.4b0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for scope-astr 0.4.4b0
File Size Uploaded Provenance Actions
scope_astr-0.4.4b0.tar.gz 57.6 kB Without provenance Details for scope_astr-0.4.4b0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for scope-astr 0.4.4b0
File Interpreter ABI Platform Actions
scope_astr-0.4.4b0-py3-none-any.whl Python 3 none any Details for scope_astr-0.4.4b0-py3-none-any.whl

Total release size: 105.0 kB

Release files / scope_astr-0.4.4b0.tar.gz

Download URL scope_astr-0.4.4b0.tar.gz
Size 57.6 kB
Tags Source
SHA-256 checksum
How to use checksums
697c29ea4a3ba2510bd4ae49e23ffc5733c474afb525f5b6f6e432851e81ffce
BLAKE2b-256 checksum
How to use checksums
c4cd8310ef1470fe3a75398464279802b944a2a0121570a6c5537d066c7c3516
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.7

Release files / scope_astr-0.4.4b0-py3-none-any.whl

Download URL scope_astr-0.4.4b0-py3-none-any.whl
Size 47.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3c47c0ba8c38115e58a3f27e5db2ed0907d28b50ae8371662076be19a67e683b
BLAKE2b-256 checksum
How to use checksums
8d2f2f0960097eef29ce03c1f9b04ef58f98242bcc4426ae1752faa6eca6b5f5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.7

Security for scope-astr 0.4.4b0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page