`{toctree}
:caption: User Guide
:hidden:
user/introduction
user/overview
tutorials/index
`
`{toctree}
:caption: Reference
:hidden:
reference/index
`
`{toctree}
:caption: Developer Guide
:hidden:
dev/dev_install
dev/add_model
`
`{toctree}
:caption: About
:hidden:
about/changelog
about/contributing
about/license
`
# TorchSim documentation
Date: {sub-ref}`today`
Useful links: [Source Repository](https://github.com/TorchSim/torch-sim) | [Issues & Ideas](https://github.com/TorchSim/torch-sim/issues)
TorchSim is a next-generation open-source atomistic simulation engine for the MLIP era.
::::{grid} 3 1 1 1 :class-container: text-center :gutter: 3
:::{grid-item-card} :link: user/introduction :link-type: doc :class-header: bg-light User Guide 🚀 ^^^ The user guide provides in-depth information and tutorials for using TorchSim. ::
:::{grid-item-card}
:link: reference/index
:link-type: doc
:class-header: bg-light
API reference 📖 ^^^ The reference guide contains a detailed description of the TorchSim API. It assumes that you have an understanding of the key concepts. ::
:::{grid-item-card}
:link: dev/dev_install
:link-type: doc
:class-header: bg-light
Developer guide 👩💻 ^^^ Do you want to develop your own workflows or improve existing functionalities? Check out the developer guide. ::: :::