README.md

metadata

title: MORL4Water
emoji: 🌊
colorFrom: blue
colorTo: green
sdk: docker
tags:
  - multi-objective reinforcement learning
  - gym environment
  - simulation
  - water management
license: mit
datasets:
  - zosika/morl4water

MORL4Water

🥐 Dataset Metadata

This repository includes a Croissant metadata file croissant.json, making MORL4Water compatible with Hugging Face standards for dataset discoverability and interoperability.
Learn more about Croissant metadata.

---

Welcome to MORL4Water, a flexible Gym environment designed for simulating water management in river systems.
With MORL4Water, you can build detailed water simulations and train or test multi-objective reinforcement learning (MORL) agents.

Currently, we have three river basins implemented as Gym environments:

• Nile River Basin
• Susquehanna River Basin
• Omo River Basin

The toolkit is modular, allowing users to extend or build their own water systems.
For an overview of available system components, please refer to the System Elements.

---

🚀 Installation and Running

Installation

Ensure you are using Python ≥ 3.11. Install via pip:

pip install morl4water

Running an Example Simulation

import mo_gymnasium
import morl4water.examples

# Create the environment
water_management_system = mo_gymnasium.make('nile-v0')

def run_nile():
    obs, info = water_management_system.reset()
    print(f'Initial Obs: {obs}')
    final_truncated = False
    final_terminated = False
    for t in range(10):
        if not final_terminated and not final_truncated:
            action = water_management_system.action_space.sample()
            print(f'Action for month {t}: {action}')
            (
                final_observation,
                final_reward,
                final_terminated,
                final_truncated,
                final_info
            ) = water_management_system.step(action)
            print(f'Observation: {final_observation}')
            print(f'Reward: {final_reward}')
        else:
            break
    return final_observation

run_nile()

---

📚 Documentation

For detailed documentation, visit the MORL4Water Website. Source code is also avaiable at Github.

---

📜 License

This project is licensed under the MIT License.

---

✨ Citation

If you use MORL4Water in your work, please consider citing it (BibTeX coming soon).

---

🛠️ Contributing

Contributions are welcome! Feel free to open an issue or pull request.

---

🛡️ About

Developed by Zuzanna Osika, 2025.

---