Parses the extra_fields of the incoming detections to retrieve the binary field prv_candidates if the alert comes from ZTF. Otherwise, it does nothing.
This step returns a list with the processed objects, including their aid, previous candidates, detections without the extra_fields field and their non_detections.
The step calls all the logic from the core folder, which contains all the main logic of the step.
By default, unrecognized surveys are considered to have only the incoming alert as a detection and do not have any non-detections.
To include new strategies, a new module must be included in core.strategy, whose name must match the lower case
name of the survey in question. This must have a function called extract_detections_and_non_detections, which receives
the incoming alert. Other functions or classes are possible. The aforementioned function must return:
# The values refer to the types of the return
{"aid": str, "detections": list, "non_detections": list}Important: For everything to work, remember to import the module in the __init__.py file of core.strategy.
Poetry is configured to manage all dependencies in three groups: main, dev and test.
- Install poetry:
pip install poetry - If you want to set create
.venvenvironment in the project folder:poetry config virtualenvs.in-project true - Create environment with all dependencies (main, dev and test):
poetry install - To install only main dependencies:
poetry install --only main - Show tree of dependencies:
poetry show --tree - Add a new dependency
poetry add PACKAGEpoetry add -G dev PACKAGEpoetry add -G test PACKAGE
- Run all tests :
poetry run pytest - Run only unit test:
poetry run pytest tests/unittest - Run only integration tests:
poetry run pytest tests/integration