rs-station / careless

Merge X-ray diffraction data with Wilson's priors, variational inference, and metadata
MIT License
16 stars 6 forks source link

online documentation #137

Open dennisbrookner opened 1 year ago

dennisbrookner commented 1 year ago

It finally happened, I went rogue and built docs for careless! No rush to get this merged in, and theres's still a little work to be done, as outlined below.

Changes in this PR

Action items before merging

def main(): run_analysis(parse_arguments().parse_args())


so that the `parse_arguments()` function can be understood by the documentation parser.
- Change references to my fork to refer back to the main repo. This will temporarily break things, but make the merge smoother.

# Action items after merging
- Make sure that the new `publish.yml` script works!! This sadly can't be tested on my fork.
- Link to the docs on the rs-station website
- Go through the little dance of creating an empty, unlinked `gh-pages` branch. I **think** this is necessary to do once and won't happen automatically
    - Add an empty `.nojekyll` file to the `gh-pages` branch, so that CSS and such gets read properly
codecov-commenter commented 1 year ago

Codecov Report

Merging #137 (2d07ad9) into main (4f25d47) will increase coverage by 0.03%. Report is 1 commits behind head on main. The diff coverage is 37.14%.

@@            Coverage Diff             @@
##             main     #137      +/-   ##
==========================================
+ Coverage   79.09%   79.12%   +0.03%     
==========================================
  Files          52       52              
  Lines        2353     2362       +9     
==========================================
+ Hits         1861     1869       +8     
- Misses        492      493       +1     
Flag Coverage Δ
unittests 79.12% <37.14%> (+0.03%) :arrow_up:

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Changed Coverage Δ
careless/stats/prior_b.py 0.00% <0.00%> (ø)
careless/stats/rescale.py 0.00% <0.00%> (ø)
careless/stats/completeness.py 87.87% <33.33%> (+0.37%) :arrow_up:
careless/stats/filter_by_image_cc.py 89.55% <33.33%> (+0.15%) :arrow_up:
careless/stats/rsplit.py 90.41% <33.33%> (+0.13%) :arrow_up:
careless/stats/ccanom.py 88.75% <50.00%> (+0.14%) :arrow_up:
careless/stats/cchalf.py 91.02% <50.00%> (+0.11%) :arrow_up:
careless/stats/ccpred.py 92.00% <50.00%> (+0.10%) :arrow_up:
careless/stats/history.py 89.65% <50.00%> (+3.44%) :arrow_up:
careless/stats/image_cc.py 89.83% <50.00%> (+0.17%) :arrow_up:

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more

kmdalton commented 1 year ago

This looks like a great start. It'll take me some time to review. Let me address some of these action items: