search

NanoComp / imageruler

measure minimum solid/void lengthscales in binary image
https://nanocomp.github.io/imageruler/
MIT License
13 stars 6 forks source link

update docs #1

Open stevengj opened 1 year ago

stevengj commented 1 year ago

We decided that ruler.py was too generic a name, so I used imageruler as the name of the repo, and the program should be updated to match.

@mawc2019

stevengj commented 1 year ago

Partially addressed by #3. Mainly we just need updated docs and examples.

ianwilliamson commented 1 year ago

With the name change from ruler -> imageruler, the import in the notebook example is now broken.

mawc2019 commented 1 year ago

I will update this in a new PR. Additionally, two minor issues on file organization are pending. Any suggestions?

stevengj commented 1 year ago

Would be good to have a readthedocs manual generated from the code docstrings. See https://docs.readthedocs.io/en/stable/tutorial/index.html