Skip to content

Commit

Permalink
chore: move advanced example to libecalc and use in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kjbrak committed Dec 12, 2024
1 parent 7400bf3 commit 98f2061
Show file tree
Hide file tree
Showing 10 changed files with 86 additions and 352 deletions.
16 changes: 8 additions & 8 deletions docs/docs/about/modelling/examples/advanced.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
import CodeLinesFromFile from "../../../../src/components/CodeLinesFromFile";
import CodeBlock from '@theme/CodeBlock';
import compressorChartCsv from '!!raw-loader!./advanced/compressor_chart.csv';
import compressorSampledCsv from '!!raw-loader!./advanced/compressor_sampled.csv';
import genset from '!!raw-loader!./advanced/genset.csv';
import pumpChart from '!!raw-loader!./advanced/pump_chart.csv';
import baseProfile from '!!raw-loader!./advanced/base_profile.csv';
import yamlModel from '!!raw-loader!./advanced/model.yaml';
import compressorChartCsv from '!!raw-loader!@examples/advanced/compressor_chart.csv';
import compressorSampledCsv from '!!raw-loader!@examples/advanced/compressor_sampled.csv';
import genset from '!!raw-loader!@examples/advanced/genset.csv';
import pumpChart from '!!raw-loader!@examples/advanced/pump_chart.csv';
import baseProfile from '!!raw-loader!@examples/advanced/base_profile.csv';
import yamlModel from '!!raw-loader!@examples/advanced/model.yaml';

# Advanced model example
This is a model very similar to [Simple example](/about/modelling/examples/simple.mdx). The main difference is the use of more advanced
Expand Down Expand Up @@ -115,7 +115,7 @@ Here we specify:
- Gas turbine
- Simplified compressor train model

<CodeLinesFromFile title="model.yaml" start={41} end={95} language="yaml">{yamlModel}</CodeLinesFromFile>
<CodeLinesFromFile title="model.yaml" start={41} end={99} language="yaml">{yamlModel}</CodeLinesFromFile>

See [MODELS](/about/references/MODELS.md) for further details.

Expand All @@ -126,7 +126,7 @@ by allowing descriptive variable names and avoid duplications.

For our model, we specify the following variables:

<CodeLinesFromFile title="model.yaml" start={97} end={134} language="yaml">{yamlModel}</CodeLinesFromFile>
<CodeLinesFromFile title="model.yaml" start={101} end={138} language="yaml">{yamlModel}</CodeLinesFromFile>

We reference the [TIME_SERIES](#time_series) `SIM` using the column names from the CSV file.

Expand Down
23 changes: 0 additions & 23 deletions docs/docs/about/modelling/examples/advanced/base_profile.csv

This file was deleted.

12 changes: 0 additions & 12 deletions docs/docs/about/modelling/examples/advanced/compressor_chart.csv

This file was deleted.

This file was deleted.

8 changes: 0 additions & 8 deletions docs/docs/about/modelling/examples/advanced/genset.csv

This file was deleted.

269 changes: 0 additions & 269 deletions docs/docs/about/modelling/examples/advanced/model.yaml

This file was deleted.

10 changes: 0 additions & 10 deletions docs/docs/about/modelling/examples/advanced/pump_chart.csv

This file was deleted.

2 changes: 1 addition & 1 deletion docs/docs/about/modelling/examples/simple.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -241,4 +241,4 @@ The model is specified:
<CodeBlock title="genset.csv">{genset}</CodeBlock>
<CodeBlock title="pump_chart.csv">{pumpChart}</CodeBlock>
<CodeBlock title="pump_sampled.csv">{pumpSampled}</CodeBlock>
<CodeBlock title="production_data.csv">{productionData}</CodeBlock>
<CodeBlock title="production_data.csv">{productionData}</CodeBlock>
Loading

0 comments on commit 98f2061

Please sign in to comment.