Developer Guide - Ideas and Suggestions

[tennlee]

If you are thinking about contributing some code to PyEarthTools, you are very welcome.

If you think you may want to contribute code, you will need to follow the PyEarthTools installation instructions here: https://pyearthtools.readthedocs.io/en/latest/installation.html#developer-installation and read the developer guide here: https://pyearthtools.readthedocs.io/en/latest/devguide.html .

To learn more about PyEarthTools in general, a good place to start is: https://pyearthtools.readthedocs.io/en/latest/newuser.html

Below is a non-exhaustive list of things you could consider doing. Alternatively, you are very welcome to look through the GitHub issue tracker and see if there is anything that grabs your interest. If you are going to work on an issue, let me know so we can avoid people doubling up.

Providing Feedback and User Testing

• Install PyEarthTools on your machine and report back about the quality of the instructions and the ease of installation
• Run the “low hardware requirements” tutorials on your machine, and report back about whether they worked well and whether there were any issues
• Read through the tutorials and let us know if anything seems unclear
• Find some cool open data we can try in PyEarthTools and work out how to access it
• Review the API docs and find (and maybe fix) any rendering/formatting issues

Coding Tasks

• Add any amount of test coverage to anything
• Implement and write tutorial for slice operators on the pipelines / data accessors
• Help with a blocking normalisation operator which will warm up on the main thread
• Provide a Bundled Models interface for LUCIE
• Provide a Bundled Models interface for a CNN

Tutorials

• Update tutorials to use the new weatherbench accessor
• Write up an issue describing a use case that you would like the developers to explain in a tutorial
• Write a tutorial for PyEarthTools
• Write a tutorial on using a diffusion model
• Write a tutorial on using a transformer model

Discussions, Design and Prototyping

• If you know about multiprocess, dask and pytorch workers, we need to talk, I have questions
• Talk to me about some ideas for lightweight syntax options
• Work out the best way to support “queries” rather than operator-based coding
• Try to write up one of the existing Jupyter notebooks as a Marimo notebook and demo it to help us work out if we should be adopting Marimo or suggesting it to others