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

[WIP] Better Readme and Binder testing #3

Open
wants to merge 17 commits into
base: master
Choose a base branch
from
Open

[WIP] Better Readme and Binder testing #3

wants to merge 17 commits into from

Conversation

gmaze
Copy link
Member

@gmaze gmaze commented Jun 3, 2020

This is about the commits I've made after v0.1.0 on the master branch
Not ready to merge, need to fix some Binder issues with the ancillary data.

@gmaze gmaze requested a review from edsmall-bodc June 3, 2020 14:01
@gmaze gmaze self-assigned this Jun 3, 2020
@gmaze gmaze removed the request for review from edsmall-bodc June 3, 2020 14:02
@codecov
Copy link

codecov bot commented Jul 6, 2020

Codecov Report

Merging #3 into master will decrease coverage by 3.05%.
The diff coverage is 0.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master       #3      +/-   ##
==========================================
- Coverage   91.38%   88.32%   -3.06%     
==========================================
  Files          65       34      -31     
  Lines        3145     1928    -1217     
==========================================
- Hits         2874     1703    -1171     
+ Misses        271      225      -46     
Flag Coverage Δ
#unittests 88.32% <0.00%> (-3.06%) ⬇️
Impacted Files Coverage Δ
setup.py 0.00% <0.00%> (ø)
...alibration/signal_variance/signal_variance_test.py
...n/get_region/data_functions/wrap_longitude_test.py
ow_calibration/find_10thetas/find_10thetas_test.py
...plot_diagnostics/sal_var_plot/sal_var_plot_test.py
ow_calibration/set_calseries/set_calseries_test.py
ow_calibration/get_region/get_region_data_test.py
..._calibration/noise_variance/noise_variance_test.py
...bration/get_region/data_functions/get_data_test.py
...ration/calc_piecewisefit/calc_piecewisefit_test.py
... and 23 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fef54bb...8075df8. Read the comment docs.

@gmaze
Copy link
Member Author

gmaze commented Jul 6, 2020

Changes summary from this PR:

  • Clean binder environment testing, click it, launch it, test it: it works.
  • Initial set-up for the software distribution packaging. Current version is 0.1.0. THIS IS NOT OVER YET. It still need internal refactoring to make this right.
  • Delete the ow_calibration.py script at the root level. With a proper packaging, this is not necessary, users don't run the code from the software folder. Content of this file goes into the README for documentation.
  • Created a docs/Tryit.ipynb notebook to get user started

@gmaze gmaze mentioned this pull request Jul 6, 2020
SteveLoch pushed a commit that referenced this pull request Dec 2, 2021
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

Successfully merging this pull request may close these issues.

1 participant