.. COSIMA & BlenderNC documentation master file, created by
   sphinx-quickstart on Thu Aug 26 17:49:09 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to COSIMA & BlenderNC's documentation!
==============================================



=============
3D animations
=============
|Documentation Status| |Documentation|

.. |Documentation Status| image:: https://github.com/COSIMA/3D_animations/actions/workflows/sphinx.yml/badge.svg
   :target: https://github.com/COSIMA/3D_animations/actions/workflows/sphinx.yml


.. |Documentation| image:: https://img.shields.io/badge/documentation-in%20development-orange
   :target: https://cosima.github.io/3D_animations/


This repository contains examples of 3D animations generated using `blender <https://www.blender.org>`_ and `BlenderNC <https://github.com/blendernc/blendernc>`_. 

Each folder included within this repository has the following structure:

- Example Name
 
  * ``example_blender_file.blend``
  * ``example_animation.png``
  * ``example_animation.rst``
  * ``example_animation.mp4``
  * ``example_animation.mov``

All the animations can be found in YouTube in a link contained in each ``example_animation.rst`` file. For easier access to the animations and their documentations, refer to the the `COSIMA 3D Animation <http://cosima.github.io/3D_animations/>`_ website. All the animations contained in this repository were generated using `VDI <https://nci.org.au>`_ and data located in gdata.
.. init_info..


.. toctree::
   :maxdepth: 2
   :caption: Install Blender & BlenderNC

   ./content/install_blendernc.rst



.. toctree::
	:maxdepth: 1
	:caption: Animations

	./content/salinity_animation.rst
	./content/temperature_animation.rst
	./content/mld_animation.rst


.. add_contents..


.. toctree::
   :maxdepth: 2
   :caption: Extra - Editing 

   ./content/time_compass.rst
   ./content/post-rendering.rst


=============
Documentation
=============

This repository documentation can be found at the `COSIMA 3D Animation <http://cosima.github.io/3D_animations/>`_ website.

To learn more about BlenderNC and Blender, follow the links below:

- Blender at https://www.blender.org
- Blender tutorials at https://cloud.blender.org/training/
- BlenderNC at https://blendernc.readthedocs.io


=================================
Contributing & Animation requests
=================================

**All contributions and ideas are welcome.** You can request and provide examples by using the `Github repository <https://github.com/COSIMA/3D_animations/>`_.

Aditionally, you can report bugs, suggest animations, and provide examples at the `Github repository issues <https://github.com/COSIMA/3D_animations/issues>`_.