From 5cf7d1b87ce836c404c003285bdcaf911d1db0b3 Mon Sep 17 00:00:00 2001 From: Suvayu Ali Date: Sat, 30 Mar 2024 03:17:11 +0530 Subject: [PATCH] Update README.md --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 9426710..d0ce6e3 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,24 @@ [![Coverage](https://codecov.io/gh/TulipaEnergy/TulipaIO.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/TulipaEnergy/TulipaIO.jl) [![DOI](https://zenodo.org/badge/DOI/FIXME)](https://doi.org/FIXME) +## About `TulipaIO.jl` (`TIO`) + +This package relies on [`DuckDB`](https://duckdb.org/docs/) to tie a +variety of data sources with Julia, and `TulipaEnergyModel` (`TEM`). +It also enables a bidirectional capability to manipulate datasets from +Julia and back to DuckDB. + +A standard workflow requires a DuckDB connection, either to an +in-memory database, or to a database file. Every data source is can +be made available in the database as a table, optionally importing it. +We can use SQL queries to transform and manipulate these tables into +something `TEM` can consume. Thankfully we don't need to resort to +SQL every time. `TIO` offers Julia functions that wrap common +transformations into a consistent API. These functions can be chained +together to form a data processing pipeline. + +The package also offers parsers for data formats like ESDL. + ## How to Cite If you use TulipaIO.jl in your work, please cite using the reference given in [CITATION.cff](https://github.com/TulipaEnergy/TulipaIO.jl/blob/main/CITATION.cff).