.. Copyright 2022-2026 The Ramble Authors

   Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   https://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your
   option. This file may not be copied, modified, or distributed
   except according to those terms.

===================
Ramble
===================

If you're new to Ramble and want to start using it, see :doc:`getting_started`.

.. toctree::
   :maxdepth: 2
   :caption: User Tutorials

   tutorials

.. toctree::
   :maxdepth: 2
   :caption: Developer Tutorials

   developer_tutorials

.. toctree::
   :maxdepth: 2
   :caption: Basics

   getting_started
   configuration_files
   workspace
   workspace_config
   package_managers
   workflow_managers
   systems
   platforms
   success_criteria
   results
   mirror_config

.. toctree::
   :maxdepth: 2
   :caption: Reference

   ramble
   command_index

.. toctree::
   :maxdepth: 2
   :caption: Object Lists

   application_list
   modifier_list
   package_manager_list
   workflow_manager_list
   base_application_list
   base_modifier_list
   base_package_manager_list
   base_workflow_manager_list

.. toctree::
   :maxdepth: 2
   :caption: Contributing

   Contributing Guidelines <https://github.com/GoogleCloudPlatform/ramble#contributing>
   dev_guides

.. toctree::
   :maxdepth: 2
   :caption: External Resources

   Spack <https://github.com/spack/spack>

==================
Indices and tables
==================

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