Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
suvayu committed Mar 29, 2024
1 parent dbb72df commit 5cf7d1b
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down

0 comments on commit 5cf7d1b

Please sign in to comment.