erdc / proteus

A computational methods and simulation toolkit
http://proteustoolkit.org
MIT License
88 stars 56 forks source link

Release candidate 1.7.5 #1228

Closed cekees closed 4 years ago

cekees commented 4 years ago

Mandatory Checklist

Please ensure that the following criteria are met:

As a general rule of thumb, try to follow PEP8 guidelines.

Description

codecov[bot] commented 4 years ago

Codecov Report

Merging #1228 into master will increase coverage by 0.06%. The diff coverage is 66.66%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1228      +/-   ##
==========================================
+ Coverage   52.22%   52.29%   +0.06%     
==========================================
  Files         531      531              
  Lines      109522   109521       -1     
==========================================
+ Hits        57196    57272      +76     
+ Misses      52326    52249      -77     
Impacted Files Coverage Δ
proteus/tests/SWFlow/santos_step.py 92.77% <0.00%> (+92.77%) :arrow_up:
proteus/tests/SWFlow/solitary_wave.py 93.75% <ø> (-0.16%) :arrow_down:
proteus/__init__.py 26.08% <100.00%> (ø)
proteus/tests/SWFlow/test_SWFlows.py 100.00% <100.00%> (ø)
proteus/tests/test_boundaryconditions.py 97.33% <0.00%> (-0.25%) :arrow_down:

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 294ad07...fe37131. Read the comment docs.

cekees commented 4 years ago

@zhang-alvin the name change of MeshAdapt.pyx to Adapter.pyx was breaking the documentation generation because the extension module was still named MeshAdapt.pyx. Maybe when wrapping up one of the other PR's you can make the change to Adapter just making sure you change the setup.py file and whatever python modules depend on MeshAdapt/Adapter. Unless I misunderstood what is going on here.

cekees commented 4 years ago

@ejtovar in reviewing the docs I found an extra "SWFlows" file, which I removed because it wasn't being used. The current docs use the "Green-Naghdi" naming scheme so I guess if we want to be consistent width the papers we should do some editing so the paper and a future release are using the same terminology.

cekees commented 4 years ago

Didn't know that there'd be an issue with documentation. I'll redo the name change at a later PR.

Thanks, I should have been more specific: it just shows up as a warning when generating the webpage page but then also creates a broken link. I believe sphinx loads all the modules for the package with python but then actually parses the pyx files for the docstrings, or something along those lines. With the proteus module named MeshAdapt but the pyx file named Adapter, it seems to get confused.

ejtovar commented 4 years ago

@ejtovar in reviewing the docs I found an extra "SWFlows" file, which I removed because it wasn't being used. The current docs use the "Green-Naghdi" naming scheme so I guess if we want to be consistent width the papers we should do some editing so the paper and a future release are using the same terminology.

Do you want me to make the changes for this release or a different one? @cekees