.. PyCxsim documentation master file, created by
   sphinx-quickstart on Sat Sep  9 15:37:36 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

=====================
PyCxsim Documentation
=====================

.. toctree::
   :maxdepth: 2
   :caption: Table of Contents
   :hidden:

   overview
   getting_started
   user_guide
   api_reference
   contribute
   changelog

Overview
========

PyCxsim is a comprehensive package designed for [brief description of the package's main purpose]. It offers a range of modules and functionalities to cater to [specific use cases or functionalities].

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

A step-by-step guide to help new users get up and running with PyCxsim quickly.

User Guide
==========

Detailed guides and tutorials on how to use the various features and functionalities of PyCxsim.

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

Detailed documentation of the PyCxsim modules:

* `cxsim`
* `cxsim.actions`
* `cxsim.agents`
  * `cxsim.agents.language_model_agents`
* `cxsim.artifacts`
* `cxsim.background_jobs`
* `cxsim.environment`
* `cxsim.prompts`
* `cxsim.queries`
* `cxsim.templates`
* `cxsim.utilities`
* `cxsim.visualization`
  * `cxsim.visualization.tabs`

Contribute
==========

Information on how to contribute to PyCxsim, including coding standards, pull request process, and more.

Changelog
=========

A record of all notable changes made to PyCxsim.