..  vim: set expandtab shiftwidth=4 softtabstop=4 syntax=rst:

..
    === UCSF ChimeraX Copyright ===
    Copyright 2016 Regents of the University of California.
    All rights reserved.  This software provided pursuant to a
    license agreement containing restrictions on its disclosure,
    duplication and use.  For details see:
    http://www.rbvi.ucsf.edu/chimerax/docs/licensing.html
    This notice must be embedded in or attached to all copies,
    including partial copies, of the software or any revisions
    or derivations thereof.
    === UCSF ChimeraX Copyright ===

.. _User's Manual: ../user/index.html

***************************
ChimeraX Programming Manual
***************************

This manual covers programming APIs for ChimeraX.
They are implemented in `Python <http://www.python.org/>`_
with routines that need to run fast implemented in C++.

User documentation for the ChimeraX application is in the `User's Manual`_.

Tutorials and Examples
======================

.. toctree::
   :maxdepth: 1

   tutorials/introduction.rst
   Command and Python recipes <https://rbvi.github.io/chimerax-recipes/>

Developer Guide
===============
Bundle developers can optionally skip Compiling ChimeraX and 
Code Conventions. It is recommended that developers intending to 
contribute to ChimeraX read all sections.

.. toctree::
   :maxdepth: 1

   environment.rst
   getcode.rst
   building.rst
   ides_debugging_profiling.rst
   conventions.rst
   apps/ChimeraX/ChimeraX.rst
   writing_bundles.rst
   core.rst

API Reference
=============

.. toctree::
   :maxdepth: 1

   supported_api.rst
   modules.rst
   modules/core/commands/user_commands.rst
   classes.rst
   cpplibs.rst
   prereqs.rst

Index
=====

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

License
=======

This code is free for non-commercial use, see the :doc:`license <license>` for details.

Copyright 2016-2024 Regents of the University of California.
All rights reserved.  This software provided pursuant to a
license agreement containing restrictions on its disclosure,
duplication and use.  For details see:
https://www.rbvi.ucsf.edu/chimerax/docs/licensing.html
This notice must be embedded in or attached to all copies,
including partial copies, of the software or any revisions
or derivations thereof.