https://github.com/coralnet/coralnet

Development of CoralNet.
https://github.com/coralnet/coralnet

Last synced: about 2 months ago
JSON representation

Development of CoralNet.

• Host: GitHub
• URL: https://github.com/coralnet/coralnet
• Owner: coralnet
• License: bsd-2-clause
• Created: 2016-03-09T21:20:31.000Z (almost 9 years ago)
• Default Branch: main
• Last Pushed: 2024-10-24T09:04:39.000Z (2 months ago)
• Last Synced: 2024-10-29T22:31:36.216Z (2 months ago)
• Language: Python
• Homepage: http://coralnet.ucsd.edu/
• Size: 80.6 MB
• Stars: 54
• Watchers: 6
• Forks: 3
• Open Issues: 163
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: license.txt

Awesome Lists containing this project

• open-sustainable-technology - CoralNet - A repository and resource for benthic image analysis. (Biosphere / Marine Life and Fishery)

README

        
# CoralNet

[![CI Status](https://github.com/coralnet/coralnet/actions/workflows/django.yml/badge.svg)](https://github.com/coralnet/coralnet/actions/workflows/django.yml)

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 clone` this repository's code.

- Install Python and Sphinx. You can do this by either following the installation steps (`docs/installation.rst` in 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 `docs` directory, and run `make html`. (This command is cross platform, since there's a ``Makefile`` as well as a ``make.bat``.)

- Open `docs/_build/html/index.html` in a web browser to start browsing the documentation.

- It's also possible to output in formats other than HTML, if you use ``make `` with a different format. See [Sphinx's docs](http://www.sphinx-doc.org/en/master/usage/quickstart.html#running-the-build).