DEgym

DEgym Documentation

Welcome to the DEgym framework documentation! DEgym is a comprehensive framework for creating environments for reinforcement learning which is focused on systems governed by ODEs/DAEs

Quick Navigation

• Installation - Get started with installing DEgym.
• DEgym Essentials - Core design principles and usage patterns.
• Terminology - Key concepts and definitions.
• Tutorial - Complete guide to building new environments.

What is DEgym?

DEgym separates environment logic into two categories:

• RL-related logic: Core functionality shared by all environments including data handling and system interfaces.
• Use-case-related logic: Concrete implementations of abstract classes that define reactor-specific actions, states, dynamics, etc.

The framework provides the RL-related infrastructure, while users implement only the use-case-specific components by inheriting from abstract classes.

Getting Started

1. Start with the Installation Guide.
2. Read DEgym Essentials to understand the core concepts.
3. Review the Terminology to familiarize yourself with key terms.
4. Follow the Comprehensive Tutorial to build your first environment.

Contributing

If you wish to contribute to DEGym, please refer to the contribution guidelines and follow the development installation for setting up the development environment with testing and linting tools.

This is the list of maintainers, who are in charge of triaging issues, reviewing and approving PRs from contributors.

This site is open source. Improve this page.