Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactoring notebooks #5

Open
3 of 5 tasks
iled opened this issue Mar 27, 2022 · 2 comments
Open
3 of 5 tasks

Refactoring notebooks #5

iled opened this issue Mar 27, 2022 · 2 comments

Comments

@iled
Copy link
Member

iled commented Mar 27, 2022

Hey all,

Following the lead by @eeholmes, I have started to refactor code out of the notebooks. The goal is to extract code that can be reused elsewhere.

For now, these efforts are being done in the refactoring branch. Note: this tutorial of the hackweek has more info on branches.

Notebooks whose functions have been refactored so far:

  • DataDownload/OpenAltimetry_example.ipynb by @eeholmes
  • DataDownload/SlideRule_example.ipynb by @eeholmes

TODO:

  • improve docstrings (documentation in the code, see coastal/plot.py/plot_from_oa_url for a good example)
  • refactor code that was not in functions defined within the notebooks but that can be moved to one
  • rewrite the notebooks to use the functions already refactored and test them

This issue will be updated as more notebooks are refactored.

@iled
Copy link
Member Author

iled commented Mar 27, 2022

092e1aa removes def's from the two first refactored notebooks and imports those functions from the local modules. Outputs are confirmed to be the same, so those functions seem to be ready to be used!

@iled
Copy link
Member Author

iled commented Mar 29, 2022

As of ee2fe74 (4 commits), two more notebooks had defs refactored out:

  • DataDownload/SlideRule_getData.ipynb by @eeholmes
  • contributors/NoelleHelder/AK_topobathy_vis.ipynb by @nkhelder

Additionally, refactored notebooks were moved to ./examples, which can later be renamed according to discussion in #6

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant