Add datamodel and naming conventions

oemof · Feb 21, 2019 · 4eda205 · 4eda205
1 parent 1d6258b
commit 4eda205
Showing 1 changed file with 23 additions and 0 deletions.
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -62,6 +62,29 @@ Modelling energy systems based on these classes is straightforward.
 Parametrization of an energy system can either be done via python scripting or
 by using the datapackage structure described below.
 
+Datamodel and Naming Conventions
+----------------------------------
+
+Facades require specific attributes. For all facades the attribute `carrier`
+and 'tech' need to be set. The attribute type is string, therefore you can
+choose string for these. However, if you want to leverage full postprocessing
+functionality we recommend using one of the types listed below
+
+Carrier types
+
+* solar, wind, biomass, coal, lignite, uranium, oil, gas, hydro, waste,
+electricity, heat, other
+
+Tech types
+
+* st, ocgt, ccgt, ce, pv, onshore, offshore, ror, rsv, phs, ext, bp, battery
+
+We recommend use the following naming convention for your facade names:
+
+	bus-carrier-tech-number
+
+For example: `DE-gas-ocgt-1`.
+
 
 Datapackage
 ============