rocky-worlds-data-challenge 1.1

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

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:

• Prepare Kaggle submissions

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.