Devel

[visionjo]

Develop branch-- prepare for next version release.

Aim for the following for version 0.1.1:

• [ ] Notebook is updated to use interface recently modulated (#21)
• [ ] Update Documentation to explain steps to run (#21)
  • [ ] add to README in root
  • [x] move results from README in root to the README in results/
  • [x] move data section from README in root to the README in data/
  • [x] save curve data along with PDF (i.e., in results/)
  • [ ] Add simple (brief) docstring where missing)
  • [ ] A sample (toy) set is run end-to-end (demonstrate in README)
  • [ ] if small enough, add to repo (i.e., < 40 MB or so)
• [ ] Finish script to generate Tar @ Far table
• [ ] Improve annotation in notebooks; more description, i.e., tutorial-like.
• [ ] create pdf versions of notebooks and add to project in notebooks/pdfs (or create nbviewer and point to it)
• [ ] add assertions (and tests) where appropriate-- at least critical cases, such a specific type is expected.
• [ ] Consider moving some of the analysis functions to visualizations.
  • [ ] modulate the handling of plt.axes objects
  • [ ] add optional input arguments for the title and other figure cosmetics or settings
• [x] Add benchmarks for sphereface features. Make these the results showcased throughout.

[review-notebook-app[bot]]

Check out this pull request on 

You'll be able to see Jupyter notebook diff and discuss changes. Powered by ReviewNB.