Skip to content

Commit 1868c0c

Browse files
authored
Merge pull request #1235 from jguarato/update/readme
Fix links in readme
2 parents f84d290 + 540a567 commit 1868c0c

File tree

1 file changed

+29
-18
lines changed

1 file changed

+29
-18
lines changed

README.md

Lines changed: 29 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# Rotordynamic Open Source Software (ROSS)
2-
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/ross-rotordynamics/ross/main)
1+
# ROSS — Rotordynamic Open-Source Software
2+
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/petrobras/ross/main)
33
![github actions](https://github.com/petrobras/ross/workflows/Tests/badge.svg)
44
[![Documentation Status](https://readthedocs.org/projects/ross/badge/?version=latest)](https://ross.readthedocs.io/en/latest/?badge=latest)
55
<a href="https://codecov.io/gh/petrobras/ross">
@@ -16,34 +16,45 @@ energy is not taken into account. Bearings and seals are included as linear stif
1616
After defining the elements for the model, you can plot the rotor geometry and run simulations such as static analysis,
1717
modal analysis, undamped critical speed, frequency response, unbalance response, time response, and more.
1818

19-
You can try it out now by running the tutorial on [binder](https://mybinder.org/v2/gh/ross-rotordynamics/ross/main)
19+
## 🚀 Quick Start
2020

21-
# Documentation
22-
Access the documentation [here](https://ross.readthedocs.io/en/latest/index.html).
23-
The documentation provides the [installation procedure](https://ross.readthedocs.io/en/latest/getting_started/installation.html),
24-
[a tutorial](https://ross.readthedocs.io/en/latest/tutorials/tutorial_part_1.html),
25-
[examples](https://ross.readthedocs.io/en/latest/discussions/discussions.html) and the
26-
[API reference](https://ross.readthedocs.io/en/latest/references/api.html).
21+
You can try ROSS instantly in your browser:
2722

28-
# Questions
29-
If you have any questions, you can use the [Discussions](https://github.com/petrobras/ross/discussions) area in the repository.
23+
👉 [**Launch ROSS in Binder**](https://mybinder.org/v2/gh/petrobras/ross/main)
3024

31-
# 💡 ROSS GPT – Your Virtual Assistant for Rotordynamics
25+
Or install it locally:
26+
```bash
27+
pip install ross-rotordynamics
28+
```
3229

33-
Meet [ROSS GPT](https://bit.ly/rossgpt), a virtual assistant specialized in the ROSS (Rotordynamic Open-Source Software) package. With ROSS GPT, you can:
30+
## 📚 Documentation
3431

32+
Access full documentation [**here**](https://ross.readthedocs.io).
33+
34+
Key sections:
35+
- [Installation guide](https://ross.readthedocs.io/en/latest/installation.html)
36+
- [User guide](https://ross.readthedocs.io/en/latest/user_guide/user_guide.html)
37+
- [API reference](https://ross.readthedocs.io/en/latest/api.html)
38+
- [Release notes](https://ross.readthedocs.io/en/latest/release_notes/release_notes.html)
39+
40+
## 🤖 ROSS GPT
41+
42+
Meet [**ROSS GPT**](https://bit.ly/rossgpt), the official AI assistant for the ROSS package. With ROSS GPT, you can:
3543
- Create and modify rotor models using ROSS in Python.
3644
- Request practical examples for modal analysis, Campbell diagrams, unbalance response, and more.
3745
- Get detailed technical explanations on elements such as shafts, disks, bearings, and couplings.
3846

39-
Access [ROSS GPT here](https://bit.ly/rossgpt) and enhance your modeling workflow with expert automated support!
47+
## ❓ Support & Questions
4048

49+
If you have **questions**, need **guidance**, or want to **discuss ideas**, please use the [**Discussions**](https://github.com/petrobras/ross/discussions) tab.
50+
51+
If you encounter a **bug**, experience unexpected behavior, or want to **request a new feature**, please open an [**Issue**](https://github.com/petrobras/ross/issues) describing the problem and how to reproduce it.
52+
53+
## 🤝 Contributing
4154

42-
# Contributing to ROSS
4355
ROSS is a community-driven project. If you want to contribute to the project, please
44-
check [CONTRIBUTING.md](https://github.com/petrobras/ross/blob/main/CONTRIBUTING.md).
56+
check [**CONTRIBUTING.md**](https://github.com/petrobras/ross?tab=contributing-ov-file).
4557

4658
The code has been initially developed by Petrobras in cooperation with the Federal University of Rio de Janeiro (UFRJ)
4759
with contributions from the Federal University from Uberlândia (UFU).
48-
Currently, Petrobras has a cooperation agreement with UFRJ (LAVI) and UFU (LMEST) to develop and maintain the code.
49-
60+
Currently, Petrobras has a cooperation agreement with UFRJ (LAVI) and UFU (LMEST) to develop and maintain the code.

0 commit comments

Comments
 (0)