CoralNet is a website which serves as a repository and resource for benthic image analysis.
Website home: https://coralnet.ucsd.edu
Read more about us: https://coralnet.ucsd.edu/about/
CoralNet's machine-learning processes are powered by PySpacer: https://github.com/coralnet/pyspacer
Building and viewing the documentation
You can browse the docs right in the GitHub repo under
/docs, but GitHub doesn't support some of the ReStructured Text links. The build will get everything working:
- Download or
git clonethis repository's code.
- Install Python and Sphinx. You can do this by either following the installation steps (
docs/installation.rstin this repo) until Sphinx is installed, or you can use some other Python environment which already has Sphinx installed.
- Open a terminal/command line, cd to the
docsdirectory, and run
make html. (This command is cross platform, since there's a
Makefileas well as a
docs/_build/html/index.htmlin a web browser to start browsing the documentation.
- It's also possible to output in formats other than HTML, if you use
make <format>with a different format. See Sphinx's docs.