Metadata-Version: 2.4
Name: nexus-e-interface
Version: 0.0.1
Author-email: Matthieu Boubat <mboubat@ethz.ch>
License-File: LICENSE
Requires-Python: >=3.9.15
Requires-Dist: sqlalchemy>=2.0.39
Description-Content-Type: text/markdown

# Nexus-e Interface

[Nexus-e](https://nexus-e.org/) is an interconnected energy system modeling platform.
Nexus-e interface is a library which provides ORM models and interfaces to
develop the modules used in Nexus-e.

# Motivation

The role of this library is to provide a stable interface for energy system
modelers to integrate their models into Nexus-e. We want Nexus-e to become
an interoperability layer between different energy system scenarios and models.

## Features (work in progress)

- ORM models to interact with Nexus-e energy scenarios
- Interfaces to implement Nexus-e modules

## Installation (work in progress)

## Usage (work in progress)

## Contributing

We haven't decided on a contribution process yet.

## License

This project is licensed under the [Apache License 2.0](LICENSE).

## Credits

- This project uses [SQLAlchemy](https://github.com/sqlalchemy/sqlalchemy).