# ROSS - Rotordynamic Open-Source Software

ROSS is a Python library for rotordynamic analysis, which allows the construction of rotor models and their numerical
simulation. 

The source code is available at [github](https://github.com/petrobras/ross).

### 💡 ROSS GPT – Your Virtual Assistant for Rotordynamics

Access [ROSS GPT](https://bit.ly/rossgpt), a virtual assistant specialized in the ROSS (Rotordynamic Open-Source Software) package. 

::::{grid} 2
:gutter: 2

:::{grid-item-card} 
:class-body: text-center
:link: getting_started/overview
:link-type: doc
```{image} /_static/img/getting_started.svg
:height: 50
```
### Getting Started 

New to ROSS? Check out the getting started guides. They contain an
introduction to ROSS main concepts and links to additional tutorials.
:::

:::{grid-item-card} 
:class-body: text-center
:link: user_guide/user_guide
:link-type: doc
```{image} /_static/img/user_guide.svg
:height: 50
```
### User Guide

The user guide provides in-depth information on the
key concepts of ROSS with useful background information and explanation.
:::

:::{grid-item-card} 
:class-body: text-center
:link: references/api
:link-type: doc
```{image} /_static/img/api.svg
:height: 50
```
### API Reference

The API reference contains a detailed description of the functions,
modules, and objects included in ROSS. The reference describes how the
methods work and which parameters can be used.
:::

:::{grid-item-card} 
:class-body: text-center
:link: contributing
:link-type: doc
```{image} /_static/img/contributor.svg
:height: 50
```
### Contributor's Guide
Saw a typo in the documentation? Want to improve
existing functionalities? The contributing guidelines will guide
you through the process of improving ROSS.

:::

::::

```{toctree}
:maxdepth: 1
:caption: Getting Started
getting_started/overview
getting_started/architecture
getting_started/installation
```

```{toctree}
:maxdepth: 1
:caption: User Guide
user_guide/user_guide
```

```{toctree}
:maxdepth: 1
:caption: References
references/api
```

```{toctree}
:maxdepth: 1
:caption: Additional Info
release_notes/release_notes
```

```{toctree}
:maxdepth: 1
contributing
```

```{toctree}
:maxdepth: 1
citing
```