Roadmap to 1.0

[SkyWa7ch3r]

Roadmap to 1.0

This issue will outline the steps needed to get to the first release, the goal is to do this release at the end of the year (2023). Upon release of 1.0 PyFHD will be given to the EoR community in full.

Calibration

• Translate Calibration
• Test Calibration
• Get the Calibration code to run on real data as part of the Python pipeline
• Merge the PR once approved

Gridding

• Make the gridding code fully compatible with the full Python pipeline
• Work out a solution to import the beam in that doesn't require a HPC to run PyFHD
• Get the Calibration and gridding code to work together
• Merge the PR once approved

Obs

• Add one or two tests for the obs function, recent testing has made it clear it needs a test or two

vis_flag_basic

• Translate vis_flag_basic
• Test vis_flag_basic
• Integrate it into Python pipeline

vis_flag

• vis_flag needs to pass its tests

vis_weights_update

• vis_weights_update needs to pass its tests

fhd_quickview

• Translate fhd_quickview (Some parts won't be translated)
• Test fhd_quickview
• Integrate it into the Python pipeline

healpix_snapshot_cube_generate

• Translate healpix_snapshot_cube_generate
• Test healpix_snapshot_cube_generate
• Integrate it into the Python pipeline

Virtual Community Q & A, Tutorial and Documentation

• Find the best day and time for the EoR community to do a Q & A @SkyWa7ch3r @nicholebarry
• Contact members of the EoR community for help on documentation @nicholebarry
• Develop the Contribution guide before the event and use that to create a talk for the community on helpful development advice for using PyFHD @SkyWa7ch3r
• Work out an agenda for the session @SkyWa7ch3r @nicholebarry

I/O

• Add save points and checkpoints for every part of the Python Pipeline
• Add load points for each part as a part of the checkpoints
• Make a save and load function that isn't deepdish as deepdish is no longer supported :(

Configuration

• Clean up the configuration options to remove unused options or duplicate options
• Ensure that pyfhd.yaml has comments for configuration and has 'good' defaults
• Ensure all arguments are in their correct group
• Remove Hardcoded variables as much as possible
• Deal with deprecation of setup.py and use pyproject.toml instead

Code Cleanup and Refactoring

• Ensure all functions are in their most appropriate modules given their use throughout PyFHD
• Removed any unused functions even if they have been translated, mention any translated but removed code in the changelog in case someone wants to use it later
• Switch to using the black formatter and format across project with a pre-commit available

Documentation

• Fill in all remaining docstrings for the API documentation
• Ensure Typing is consistently used across PyFHD with proper use of the typing module and NumPy typing module
• Add examples of running just PyFHD code same as the IDL examples that exist in the docs now
  • Add tutorial for adding options to PyFHD into the contribution guide
  • Add information on the input & output of PyFHD
• Add a contribution guide for developers of PyFHD (include PyFHD & FHD installation instructions)
• Add a contribution guide for new translation endeavours
• Pull Request Template
• Implement Changelog
• Add v1.0 notes to the changelog
• Update the installation page for Python only

Testing

• Add a testing badge for pytest and code coverage from pytest
• Add HTML reports to the sphinx documentation
• Work with the EoR community to store the current tests
• Work with the EoR community to create CI for existing tests
• Test the pipeline on real data and ensure it can do actual science!

PyPI & Conda-Forge

• Publish to PyPI
• Publish to Conda-Forge

JOSS

• Submit PyFHD to JOSS
• Create a Guide for referencing the package when used for publishing papers and results generated by PyFHD

ADACS

• Update FHD description on ADACS Website