Metadata-Version: 2.1
Name: jpl-rosa
Version: 1.0.0
Summary: ROSA: the Robot Operating System Agent
Home-page: https://github.com/nasa-jpl/rosa
Author: Rob Royce
Author-email: Rob.Royce@jpl.nasa.gov
License: Apache 2.0
Project-URL: Bug Reports, https://github.com/nasa-jpl/rosa/issues
Project-URL: Source, https://github.com/nasa-jpl/rosa
Keywords: Robotics,Data Science,Machine Learning,Data Engineering,Data Infrastructure,Data Analysis
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.9, <4
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: PyYAML==6.0.1
Requires-Dist: python-dotenv>=1.0.1
Requires-Dist: langchain==0.2.7
Requires-Dist: langchain-openai==0.1.14
Requires-Dist: langchain-core==0.2.12
Requires-Dist: langchain-community
Requires-Dist: pydantic
Requires-Dist: pyinputplus
Requires-Dist: azure-identity
Requires-Dist: cffi
Requires-Dist: rich
Requires-Dist: pillow>=10.4.0
Requires-Dist: numpy>=1.21.2

# ROS Agent (ROSA)

ROSA is an AI agent that can be used to interact with ROS (Robot Operating System) and perform various tasks. 
It is built using the Langchain framework and the [ROS](https://www.ros.org/) framework.

## Installation

Use pip to install ROSA:

```bash
pip install jpl-rosa
```

**Important:** ROS Noetic runs on Python 3.8, but LangChain is only available for Python >= 3.9. So you will
need to install Python3.9 separately, and run ROSA outside the ROS environment. This restriction is not true
for ROS2 variants.


# TurtleSim Demo
We have included a demo that uses ROSA to control the TurtleSim simulator. You can run the demo using the following command:

```bash
./demo.sh
```

The above command will start Docker and launch the turtlesim node. To start ROSA, you can run the following command 
the new Docker session:

```bash
catkin build && source devel/setup.bash && roslaunch turtle_agent agent
```

## Example Queries
After launching the agent, you can get a list of example queries by typing `examples` in the terminal. 
You can then run any of the example queries by typing the query number (e.g. 2) and pressing enter.
