Skip to content

Commit

Permalink
Rename project, fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
FlorianK13 committed Nov 8, 2023
1 parent a741983 commit f679667
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 11 deletions.
7 changes: 2 additions & 5 deletions docs/dagster_and_dbt.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
# Dagster and dbt
This project builds upon two open-source frameworks: [Dagster](https://dagster.io/) and [dbt](https://docs.getdbt.com/). We use the data orchestration tool `Dagster` to build and schedule our pipelines. Inside `Dagster`, many of the actual data transformations are implemented using `dbt`.
Both frameworks are documented extensively. Before you dive into `energy-dagster`, make sure that you have a basic understanding of the two frameworks.
The codebase of `open-dapro` builds upon two open-source frameworks: [Dagster](https://dagster.io/) and [dbt](https://docs.getdbt.com/). We use the data orchestration tool `Dagster` to build and schedule our pipelines. Inside `Dagster`, many of the actual data transformations are implemented using `dbt`.
Both frameworks are documented extensively. Before you dive into `open-dapro`, make sure that you have a basic understanding of the two frameworks.

!!! tip

If you understand how to use Dagster and dbt, you will also understand `energy-dagster`.

```mermaid
flowchart TB
Expand Down
9 changes: 3 additions & 6 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Getting Started
Energy-dagster is the data orchestration and pipelining tool for the german energy system built with [Dagster](https://dagster.io/) and [dbt](https://docs.getdbt.com/). Its purpose is to collect and combine data from different sources which is relevant for the german energy system. This is done regularly to keep the database up to date.


`open-dapro` is the data orchestration and pipelining tool for the German Energy System built with [Dagster](https://dagster.io/){:target="_blank"}, [dbt](https://docs.getdbt.com/){:target="_blank"}, [PostGIS](https://postgis.net/){:target="_blank"}, and [GeoServer](https://geoserver.org/){:target="_blank"}. Its purpose is the collection and combination of data from different sources. The data pipelines can be scheduled regularly to keep the database up to date.

## How to use it
1. Clone the repository [git.fortiss.org/ASCI-public/energy-dagster](https://git.fortiss.org/ASCI-public/energy-dagster) and open it in a terminal.
Expand All @@ -10,9 +8,8 @@ Energy-dagster is the data orchestration and pipelining tool for the german ener
docker --version
docker-compose --version
```
1. Run `docker-compose up` and go to [localhost:3000](localhost:3000) to see the dagster UI. A documentation of the dagster UI can be found [here](https://docs.dagster.io/concepts/dagit/dagit).
1. Run `docker-compose up` and go to [localhost:3000](localhost:3000){:target="_blank"} to see the dagster UI. A documentation of the dagster UI can be found [here](https://docs.dagster.io/concepts/webserver/ui){:target="_blank"}.
1. Start exploring the data pipelines :tada:

For an alternative setup where dagster is running in a terminal, you can also follow the instructions in the [Setup for development](developing/setup_development.md).

For an alternative setup you can also follow the instructions in the [Setup for development](developing/setup_development.md).

0 comments on commit f679667

Please sign in to comment.