Metadata-Version: 2.4
Name: the-well-nwo
Version: 0.1.0
Summary: Physics-informed robotics control using The Well dataset and NWO Robotics API
Author-email: NWO Robotics <support@nworobotics.cloud>
License: MIT
Project-URL: Homepage, https://github.com/nwo-robotics/the-well-nwo-integration
Project-URL: Documentation, https://nwo-robotics.github.io/the-well-nwo-integration
Project-URL: Repository, https://github.com/nwo-robotics/the-well-nwo-integration
Project-URL: Issues, https://github.com/nwo-robotics/the-well-nwo-integration/issues
Project-URL: Changelog, https://github.com/nwo-robotics/the-well-nwo-integration/blob/main/CHANGELOG.md
Keywords: robotics,physics,ai,machine-learning,simulation,fno,neural-operator
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.21.0
Requires-Dist: torch>=2.0.0
Requires-Dist: requests>=2.28.0
Requires-Dist: pydantic>=2.0.0
Requires-Dist: typing-extensions>=4.0.0
Requires-Dist: aiohttp>=3.8.0
Requires-Dist: tqdm>=4.65.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: h5py>=3.7.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
Requires-Dist: black>=23.0.0; extra == "dev"
Requires-Dist: flake8>=6.0.0; extra == "dev"
Requires-Dist: mypy>=1.0.0; extra == "dev"
Requires-Dist: sphinx>=7.0.0; extra == "dev"
Requires-Dist: sphinx-rtd-theme>=1.3.0; extra == "dev"
Provides-Extra: all
Requires-Dist: matplotlib>=3.5.0; extra == "all"
Requires-Dist: plotly>=5.0.0; extra == "all"
Requires-Dist: wandb>=0.15.0; extra == "all"
Dynamic: license-file

# The Well × NWO Robotics Integration

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
[![The Well](https://img.shields.io/badge/The%20Well-15TB%20Physics-green)](https://polymathic-ai.github.io/the_well/)

> Physics-informed robotics control using pre-trained surrogate models from The Well dataset

## 🎯 Overview

This integration brings **15TB of physics simulations** from [The Well](https://polymathic-ai.github.io/the_well/) (Polymathic AI) to the NWO Robotics API, enabling robots to predict physical phenomena 100-1000x faster than traditional simulators.

### Key Capabilities (Phase 1)

- ⚡ **12ms predictions** vs 45s full simulations
- 🌊 **Fluid dynamics** for drones and underwater robots
- 🔊 **Acoustic scattering** for sonar navigation
- 🧲 **Magnetohydrodynamics** for space robotics
- 🦠 **Active matter** for swarm coordination

## 📦 Installation

```bash
pip install the-well-nwo

Or from source:
git clone https://github.com/RedCiprianPater/the-well-nwo-integration.git
cd the-well-nwo-integration
pip install -e .

🚀 Quick Start

from the_well_nwo import PhysicsPredictor, NWOClient

# Initialize
predictor = PhysicsPredictor(model="FNO-fluid_dynamics")
client = NWOClient(api_key="your_api_key")

# Predict physics before robot acts
prediction = predictor.predict(
    scenario="fluid_interaction",
    robot_state={"position": [0, 0, 10], "velocity": [5, 0, 0]}
)

# Send to robot with physics context
client.send_command(
    robot_id="drone_01",
    command="navigate_through_turbulence",
    physics_context=prediction.to_context()
)
📚 Documentation

• Getting Started
• API Reference
• Available Models
• Examples
• Contributing

🔬 Available Physics Models

| Dataset               | Model | Use Case                 | Latency |
| --------------------- | ----- | ------------------------ | ------- |
| active_matter         | FNO   | Swarm coordination       | 12ms    |
| fluid_dynamics        | TFNO  | Drone/water aerodynamics | 15ms    |
| acoustic_scattering   | U-Net | Sonar navigation         | 18ms    |
| magneto_hydrodynamics | FNO   | Space robotics           | 20ms    |
| turbulence            | TFNO  | High-speed navigation    | 22ms    |

🏗️ Architecture

┌─────────────────┐     ┌──────────────────┐     ┌─────────────────┐
│   NWO Robotics  │────▶│  Physics Engine  │────▶│   The Well      │
│     API         │     │   (This Repo)    │     │  Pre-trained    │
│                 │◀────│                  │◀────│   Models        │
└─────────────────┘     └──────────────────┘     └─────────────────┘
        │                       │                       │
        ▼                       ▼                       ▼
   Robot Commands         Predictions            15TB Dataset

🛣️ Roadmap

Phase 1: Basic Integration ✅ (Current)

• [x] Pre-trained model loading
• [x] Basic prediction API
• [x] NWO Robotics client integration
• [x] Fluid dynamics support
• [x] Documentation and examples

Phase 2: Fine-tuning for Robotics 🚧 (Open for Contributions)

• [ ] Robotics-specific fine-tuning
• [ ] Real robot data integration
• [ ] Multi-modal sensor fusion
• [ ] Custom physics scenarios

Phase 3: Real-time & Publishing 🚧 (Open for Contributions)

• [ ] Real-time model updates
• [ ] Robotics dataset creation
• [ ] Publish back to The Well
• [ ] Distributed training

🤝 Contributing

We welcome contributions! See CONTRIBUTING.md for guidelines.

Priority Areas for Contributors

• NWO Robotics for the robotics API platform
• NVIDIA Modulus for FNO/TFNO implementations

📞 Support

• Issues: GitHub Issues
• Discussions: GitHub Discussions
• Email: support@nworobotics.cloud

───

Built with ❤️ by the NWO Robotics Community
