kuchtact / wipplpy Goto Github PK

The ~wipplypy.modules.generic_get_data.Data.get function is too bulky at the moment and should be cleaned and refactored. The ruff error was ignored in commit 5f97191.

Code coverage tools identify which lines of code are run at least once when tests are run, and which lines of code are untested. Code coverage is a good way to see where new tests are needed, and it can also help us identify sections of code that cannot be reached. We should enable code coverage for WiPPLPy, and make it so that the repo gets connected to Codecov.

The ~wipplypy.modules.shot_loader.get_remote_shot_tree function is too cluttered and the ruff error was ignored in commit 1a00272. This function needs to be refactored into multiple functions to ease readability.

When pulling data from MDSPlus, we want to put that data into xarrays. This is a necessary step that is also useful for organization and keeping track of metadata.

This should be a generic class that can do local or remote connections to MDSplus. Then there is a subclass for MST and BRB that will have it's own ruleset for how to connect to the corresponding tree.

In order to perform tests of WiPPLPy, we'll need to be able to use MDSplus. However, MDSplus is not installable from the Python Package Index. We'll probably need to update the GitHub Action so that it installs Python with miniconda, and then installs MDSplus from conda-forge.

The README needs instructions for new contributors to install WiPPLPy and prepare to contribute. These should be similar to those found on https://docs.plasmapy.org/en/latest/contributing/getting_ready.html.

In #9, I'm running sphinx-quickstart to set up the initial documentation. If all goes according to plan, I'm going to add a tox environment for the documentation build and a GitHub Action for building the docs.

After that, we'll need to put the documentation on Read the Docs.