.. batoms documentation master file.

=================================================
Welcome to Beautiful Atoms 2.2.0's documentation!
=================================================

.. figure:: images/batoms-h2o.png
   :align: right
   :width: 3cm

Beautiful Atoms is a Python package for creating, editing and rendering atoms and molecules structures using Blender. A Python interface that allows for automating workflows.

.. Caution::
   The latest version only supports Blender version >= 3.4.

.. note::
   Need help? Please can ask questions at: https://groups.google.com/g/beautiful-atoms


.. note::
   View and edit structure in Jupyter Notebook? You can use weas-widget_


Getting Started
==================

   .. container:: tocdescr

      .. container:: descr

         :doc:`/getting_started/about/index`

      .. container:: descr

         :doc:`/getting_started/installing/index`

      .. container:: descr

         :doc:`/getting_started/installing/update`

      .. container:: descr

         :doc:`/getting_started/gui`

      .. container:: descr

         :doc:`/getting_started/python`

Sections
========

   .. container:: tocdescr

      .. container:: descr

         .. figure:: images/interface_window-system_introduction_default-startup.png
            :target: /en/latest/interface/index.html

         :doc:`/interface/index`
            An introduction to Blender's window system, Batoms's panels and tools.


      .. container:: descr

         .. figure:: /images/modeling_primitives_partiion.png
            :target: /en/latest/modeling/index.html

         :doc:`/modeling/index`
            Modeling tools: molecules, crystals, surfaces and nanoparticles.
      
      .. container:: descr

         .. figure:: /images/animation_c2h6so.gif
            :target: /en/latest/animation/index.html

         :doc:`/animation/index`
            Overview of the animation.
      
      .. container:: descr

         .. figure:: /images/gallery_c60.png
            :target: /en/latest/rendering/index.html

         :doc:`/rendering/index`
            Rendering

      .. container:: descr

         .. figure:: /images/section_python.png
            :target: /en/latest/python/index.html

         :doc:`/python/index`
            Python interface and API.


      .. container:: descr

         .. figure:: /images/boundary_au_cubic_1.png
            :target: /en/latest/tutorial/index.html

         :doc:`/tutorial/index`
            Tutorials

      .. container:: descr

         .. figure:: /images/section_animation.png
            :target: /en/latest/advanced/index.html

         :doc:`/advanced/index`
            Advanced topics

      .. container:: descr

         .. figure:: /images/gallery_cavity.png
            :target: /en/latest/gallery.html

         :doc:`/gallery`
            Gallery images.

      
      


.. just so this is included in the toc (not user visible).

.. toctree::
   :caption: Getting Started
   :maxdepth: 1
   :hidden:

   getting_started/about/index.rst
   getting_started/installing/index.rst
   getting_started/installing/update.rst
   getting_started/gui.rst
   getting_started/python.rst

.. toctree::
   :caption: Sections
   :maxdepth: 2
   :hidden:

   interface/index
   modeling/index
   animation/index
   rendering/index
   python/index
   tutorial/index
   advanced/index
   gallery

.. toctree::
   :maxdepth: 1

   ops/index
   tips
   contact
   faqs
   development/index


* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`



.. _weas-widget: https://github.com/superstar54/weas-widget