Documentation Status GitHub Actions CI Status Codecov Coverage Powered by Astropy Badge

Utilities and notebooks for preparing submissions to the Rocky Worlds DDT Data Challenge.

This package provides helpers for:

  • describing eclipsing exoplanet systems and derived orbital quantities

  • validating posterior samples, light curves, and questionnaire responses

  • writing and reloading challenge submission ZIP archives

  • interactively completing the submission form

Installation

For standard use, install the package from PyPI:

python -m pip install rocky-worlds-data-challenge

To validate an installed wheel with the package’s bundled test suite, install the optional test dependencies and run the installed tests:

python -m pip install "rocky-worlds-data-challenge[test]"
python -m pytest --pyargs rocky_worlds_data_challenge.tests

Local Development

To work on the package locally, clone the repository and install it in editable mode with development, documentation, and test dependencies:

git clone https://github.com/spacetelescope/rocky-worlds-data-challenge.git
cd rocky-worlds-data-challenge
python -m pip install -e ".[dev,docs,test]"

Quick Start

The best place to start is the tutorial in the hosted documentation:

That tutorial walks through packaging posterior samples, photometry products, completed forms, and the final submission ZIP archive.

Documentation

Documentation is built with Sphinx and published on Read the Docs.

To build the docs locally:

python -m sphinx -W -b html docs docs/_build/html

Testing

Run the test suite with:

python -m pytest

The CI configuration also runs style checks, security checks, package build checks, and documentation link checks through tox.

Simulation Code

The rocky-worlds-data-challenge/simulator directory is reserved for the code used to generate the simulated data products. The intention is to provide that code once the data challenge is complete.

License

See LICENSE.rst for more information.

Contributing

Contributions are welcome. See CONTRIBUTING.md for guidance.

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for taylorbell57 from gravatar.com taylorbell57

Credits

Author: STScI

License expression

BSD-3-Clause
View SPDX License List

Requires

Python >=3.10

Provides Extra

test docs dev

Tags

astronomy astrophysics

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rocky_worlds_data_challenge-1.1.tar.gz (174.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rocky_worlds_data_challenge-1.1-py3-none-any.whl (33.1 kB view details)

Uploaded Python 3

File details

Details for the file rocky_worlds_data_challenge-1.1.tar.gz.

File metadata

File hashes

Hashes for rocky_worlds_data_challenge-1.1.tar.gz
Algorithm Hash digest
SHA256 a60947ab5260a138dea630f19860d9888a88aa66b54d132a4be709053076c67c
MD5 c8afcb23bf91ff9346805c0c8e08d128
BLAKE2b-256 f17c9a434f7e665779c392fd32b3c5180e7bfd3e2c6672a73a75bc3f1a729d51

See more details on using hashes here.

Provenance

The following attestation bundles were made for rocky_worlds_data_challenge-1.1.tar.gz:

Publisher: publish_pypi.yml on spacetelescope/rocky-worlds-data-challenge

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file rocky_worlds_data_challenge-1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for rocky_worlds_data_challenge-1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3fce56e5c5722e6eb071e32559458b544463bf864703f65358ad2032852e0827
MD5 d280645ec68f29544c70ffc001258ca8
BLAKE2b-256 8483c8ac834257cbcc740d152961fc61be402c14662cf8567e16104ef350d757

See more details on using hashes here.

Provenance

The following attestation bundles were made for rocky_worlds_data_challenge-1.1-py3-none-any.whl:

Publisher: publish_pypi.yml on spacetelescope/rocky-worlds-data-challenge

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

1.1 This release

2 files

1.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page