Skip to content

Commit

Permalink
Add docs folder with compile documentation
Browse files Browse the repository at this point in the history
Documentation generated with Dymola 2017 and setup so that, hopefully,
GitHub recognises it and the contents are published as GitHub
Pages. README.md has been updated with a link to the expected URI.
  • Loading branch information
raulrpearson committed Apr 2, 2017
1 parent d829c5d commit dbfd490
Show file tree
Hide file tree
Showing 301 changed files with 14,619 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## Overview

*PVSystems* is a [Modelica](https://modelica.org/) library providing models useful for the design and evaluation of photovoltaic systems and power converters as well as their associated control algorithms.
*PVSystems* is a [Modelica](https://modelica.org/) library providing models useful for the design and evaluation of photovoltaic systems and power converters as well as their associated control algorithms. For more information, check out the [online documentation](https://raulrpearson.github.io/pvsystems).

![Screenshot](PVSystems/Resources/Images/screenshot.png)

Expand Down
257 changes: 257 additions & 0 deletions docs/Complex.html

Large diffs are not rendered by default.

Binary file added docs/ComplexI.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
53 changes: 53 additions & 0 deletions docs/ExternalObject.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>ExternalObject</title>
<meta name="HTML-Generator" content="Dymola">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<style type="text/css">
* { font-size: 100%; font-family: Arial, sans-serif; }
.modelica, .modelica * { font-size: 90%; font-family: Courier, monospace; white-space: pre; } /* For the Modelica code (in exported html). */
h4 { font-size: 100%; font-weight: bold; color: green; }
h3 { font-size: 110%; font-weight: bold; color: green; }
h2 { font-size: 130%; font-weight: bold; color: green; }
address { font-weight: normal; }
td { padding: 2px; border: 1px solid #808080; vertical-align: top; }
th { padding: 2px; border: 1px solid #808080; vertical-align: top; font-weight: bold; }
table { border: 1px solid #808080; border-collapse: collapse; }
pre, code {font-family: "Courier New", monospace;}
pre {white-space: pre; overflow-x : hidden;}
.ModelicaDescription {font-weight: bold;} /* For the description string of the class. */
.ModelicaBaseClass {} /* For the list of base-classes at the of the description. */
.ModelicaKeyword { color: blue; font-weight: normal; font-style: normal; } /* Keywords in Modelica. */
.ModelicaComment { color: #006400; font-weight: normal; font-style: normal;} /* All three variants of comments in Modelica. */
.ModelicaString { color: #006400; font-weight: normal; font-style: normal;} /* String constants. */
.ModelicaClass { color: red; font-weight: normal; font-style: normal;} /* Formatting the names of referenced classes (for base-class and components). */
.ModelicaFunction { color: red; font-weight: normal; font-style: normal;} /* Formatting for called functions. */
.ModelicaTablePackageContent { } /* The table of contents for each package. */
.ModelicaTableCrossReference { } /* The optional cross-reference table. */
.ModelicaTableInputs {} /* The table of inputs for a function. */
.ModelicaTableOutputs {} /* The table of outputs for a function. */
.ModelicaTableParameters {} /* The table of parameters for a model/block. */
.ModelicaTableConnectors {} /* The table of connectors for a model/block. */
.ModelicaTableContents {} /* The table of contents for a connector. */
.ModelicaStartAttribute { font-weight: bold; } /* The formatting used for start-attribute in the table of parameters, to separate them from parameter values. */
.ModelicaParameterTab { background-color: #c0c0c0; font-weight: bold; } /* The tab-heading in the table of parameters */
.ModelicaParameterGroup { background-color: #e0e0e0; } /* The group-heading in the table of parameters */
</style>
</head>
<body>
<!--[if supportFields]><span style="mso-element:field-begin"></span>
<span style="mso-spacerun:yes"></span>XE ExternalObject<![endif]-->
<!--[if supportFields]><span style="mso-element:field-end"></span><![endif]-->
<h2><a name="ExternalObject"></a>ExternalObject</h2>
<h3>Modelica definition</h3>
<div class="modelica"><span class="ModelicaKeyword">partial </span><span class="ModelicaKeyword">model</span> ExternalObject
Integer id;
<span class="ModelicaKeyword">end </span>ExternalObject;
</div>
<hr>
<address>
<a href="http://www.3ds.com/">Automatically generated</a> Sun Apr 02 18:12:04 2017.
</address>
</body>
</html>
Binary file added docs/ExternalObjectI.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Modelica.Blocks.Continuous.FirstOrderD.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Modelica.Blocks.Continuous.FirstOrderI.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Modelica.Blocks.Continuous.IntegratorD.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Modelica.Blocks.Continuous.IntegratorI.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Modelica.Blocks.Continuous.LimIntegratorI.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Modelica.Blocks.Continuous.PID.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Modelica.Blocks.Continuous.PII.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Modelica.Blocks.Icons.BlockI.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Modelica.Blocks.Interfaces.BlockIconI.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Modelica.Blocks.Interfaces.BooleanInputD.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Modelica.Blocks.Interfaces.BooleanInputI.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Modelica.Blocks.Interfaces.BooleanOutputI.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Modelica.Blocks.Interfaces.RealInputD.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Modelica.Blocks.Interfaces.RealInputI.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Modelica.Blocks.Interfaces.RealOutputD.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Modelica.Blocks.Interfaces.RealOutputI.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Modelica.Blocks.Interfaces.SI2SOD.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Modelica.Blocks.Interfaces.SI2SOI.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Modelica.Blocks.Interfaces.SISOD.png
Binary file added docs/Modelica.Blocks.Interfaces.SISOI.png
Binary file added docs/Modelica.Blocks.Interfaces.SignalSourceD.png
Binary file added docs/Modelica.Blocks.Interfaces.SignalSourceI.png
Binary file added docs/Modelica.Blocks.Logical.LessD.png
Binary file added docs/Modelica.Blocks.Logical.LessI.png
Binary file added docs/Modelica.Blocks.Logical.NotD.png
Binary file added docs/Modelica.Blocks.Logical.NotI.png
Binary file added docs/Modelica.Blocks.Math.AddD.png
Binary file added docs/Modelica.Blocks.Math.AddI.png
Binary file added docs/Modelica.Blocks.Math.CosD.png
Binary file added docs/Modelica.Blocks.Math.CosI.png
Binary file added docs/Modelica.Blocks.Math.DivisionD.png
Binary file added docs/Modelica.Blocks.Math.DivisionI.png
Binary file added docs/Modelica.Blocks.Math.FeedbackD.png
Binary file added docs/Modelica.Blocks.Math.FeedbackI.png
Binary file added docs/Modelica.Blocks.Math.GainD.png
Binary file added docs/Modelica.Blocks.Math.GainI.png
Binary file added docs/Modelica.Blocks.Math.SinD.png
Binary file added docs/Modelica.Blocks.Math.SinI.png
Binary file added docs/Modelica.Blocks.Nonlinear.FixedDelayD.png
Binary file added docs/Modelica.Blocks.Nonlinear.FixedDelayI.png
Binary file added docs/Modelica.Blocks.Nonlinear.LimiterD.png
Binary file added docs/Modelica.Blocks.Nonlinear.LimiterI.png
Binary file added docs/Modelica.Blocks.Sources.BooleanStepD.png
Binary file added docs/Modelica.Blocks.Sources.BooleanStepI.png
Binary file added docs/Modelica.Blocks.Sources.ConstantD.png
Binary file added docs/Modelica.Blocks.Sources.ConstantI.png
Binary file added docs/Modelica.Blocks.Sources.RampD.png
Binary file added docs/Modelica.Blocks.Sources.RampI.png
Binary file added docs/Modelica.Blocks.Sources.RealExpressionD.png
Binary file added docs/Modelica.Blocks.Sources.RealExpressionI.png
Binary file added docs/Modelica.Blocks.Sources.SawToothD.png
Binary file added docs/Modelica.Blocks.Sources.SawToothI.png
Binary file added docs/Modelica.Blocks.Sources.SineD.png
Binary file added docs/Modelica.Blocks.Sources.SineI.png
Binary file added docs/Modelica.Blocks.Sources.StepD.png
Binary file added docs/Modelica.Blocks.Sources.StepI.png
Binary file added docs/Modelica.Blocks.TypesI.png
Binary file added docs/Modelica.Electrical.Analog.Basic.GroundD.png
Binary file added docs/Modelica.Electrical.Analog.Basic.GroundI.png
Binary file added docs/Modelica.Icons.ExampleI.png
Binary file added docs/Modelica.Icons.UnderConstructionI.png
Binary file added docs/Modelica.SIunits.AngleS.png
Binary file added docs/Modelica.SIunits.ComplexCurrentI.png
Binary file added docs/Modelica.SIunits.ComplexCurrentS.png
Binary file added docs/Modelica.SIunits.Conversions.NonSIunitsI.png
Binary file added docs/Modelica.SIunits.Conversions.NonSIunitsS.png
Binary file added docs/Modelica.SIunits.Conversions.from_AhI.png
Binary file added docs/Modelica.SIunits.Conversions.from_AhS.png
Binary file added docs/Modelica.SIunits.Conversions.from_WhI.png
Binary file added docs/Modelica.SIunits.Conversions.from_WhS.png
Binary file added docs/Modelica.SIunits.Conversions.from_dayI.png
Binary file added docs/Modelica.SIunits.Conversions.from_dayS.png
Binary file added docs/Modelica.SIunits.Conversions.from_degCI.png
Binary file added docs/Modelica.SIunits.Conversions.from_degCS.png
Binary file added docs/Modelica.SIunits.Conversions.from_degFI.png
Binary file added docs/Modelica.SIunits.Conversions.from_degFS.png
Binary file added docs/Modelica.SIunits.Conversions.from_degRkI.png
Binary file added docs/Modelica.SIunits.Conversions.from_degRkS.png
Binary file added docs/Modelica.SIunits.Conversions.from_hourI.png
Binary file added docs/Modelica.SIunits.Conversions.from_hourS.png
Binary file added docs/Modelica.SIunits.Conversions.from_kWhI.png
Binary file added docs/Modelica.SIunits.Conversions.from_kWhS.png
Binary file added docs/Modelica.SIunits.Conversions.from_minuteI.png
Binary file added docs/Modelica.SIunits.Conversions.from_minuteS.png
Binary file added docs/Modelica.SIunits.Conversions.to_AhI.png
Binary file added docs/Modelica.SIunits.Conversions.to_AhS.png
Binary file added docs/Modelica.SIunits.Conversions.to_WhI.png
Binary file added docs/Modelica.SIunits.Conversions.to_WhS.png
Binary file added docs/Modelica.SIunits.Conversions.to_barI.png
Binary file added docs/Modelica.SIunits.Conversions.to_barS.png
Binary file added docs/Modelica.SIunits.Conversions.to_dayI.png
Binary file added docs/Modelica.SIunits.Conversions.to_dayS.png
Binary file added docs/Modelica.SIunits.Conversions.to_degCI.png
Binary file added docs/Modelica.SIunits.Conversions.to_degCS.png
Binary file added docs/Modelica.SIunits.Conversions.to_degFI.png
Binary file added docs/Modelica.SIunits.Conversions.to_degFS.png
Binary file added docs/Modelica.SIunits.Conversions.to_degI.png
Binary file added docs/Modelica.SIunits.Conversions.to_degRkI.png
Binary file added docs/Modelica.SIunits.Conversions.to_degRkS.png
Binary file added docs/Modelica.SIunits.Conversions.to_degS.png
Binary file added docs/Modelica.SIunits.Conversions.to_hourI.png
Binary file added docs/Modelica.SIunits.Conversions.to_hourS.png
Binary file added docs/Modelica.SIunits.Conversions.to_kWhI.png
Binary file added docs/Modelica.SIunits.Conversions.to_litreI.png
Binary file added docs/Modelica.SIunits.Conversions.to_litreS.png
Binary file added docs/Modelica.SIunits.Conversions.to_minuteI.png
Binary file added docs/Modelica.SIunits.Conversions.to_minuteS.png
Binary file added docs/Modelica.SIunits.Conversions.to_unit1I.png
Binary file added docs/Modelica.SIunits.Conversions.to_unit1S.png
Binary file added docs/Modelica.SIunits.ConversionsI.png
Binary file added docs/Modelica.SIunits.ConversionsS.png
Binary file added docs/Modelica.SIunits.Icons.ConversionI.png
Binary file added docs/Modelica.SIunits.Icons.ConversionS.png
Binary file added docs/Modelica.SIunits.IconsI.png
Binary file added docs/Modelica.SIunits.IconsS.png
Binary file added docs/Modelica.SIunits.UsersGuide.ContactI.png
Binary file added docs/Modelica.SIunits.UsersGuide.ContactS.png
Binary file added docs/Modelica.SIunits.UsersGuide.LiteratureI.png
Binary file added docs/Modelica.SIunits.UsersGuide.LiteratureS.png
Binary file added docs/Modelica.SIunits.UsersGuideI.png
Binary file added docs/Modelica.SIunits.UsersGuideS.png
Binary file added docs/Modelica.SIunitsI.png
411 changes: 411 additions & 0 deletions docs/Modelica_Blocks_Continuous.html

Large diffs are not rendered by default.

91 changes: 91 additions & 0 deletions docs/Modelica_Blocks_Icons.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Modelica.Blocks.Icons.Block</title>
<meta name="HTML-Generator" content="Dymola">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="&quot;Basic graphical layout of input/output block&quot;">
<style type="text/css">
* { font-size: 100%; font-family: Arial, sans-serif; }
.modelica, .modelica * { font-size: 90%; font-family: Courier, monospace; white-space: pre; } /* For the Modelica code (in exported html). */
h4 { font-size: 100%; font-weight: bold; color: green; }
h3 { font-size: 110%; font-weight: bold; color: green; }
h2 { font-size: 130%; font-weight: bold; color: green; }
address { font-weight: normal; }
td { padding: 2px; border: 1px solid #808080; vertical-align: top; }
th { padding: 2px; border: 1px solid #808080; vertical-align: top; font-weight: bold; }
table { border: 1px solid #808080; border-collapse: collapse; }
pre, code {font-family: "Courier New", monospace;}
pre {white-space: pre; overflow-x : hidden;}
.ModelicaDescription {font-weight: bold;} /* For the description string of the class. */
.ModelicaBaseClass {} /* For the list of base-classes at the of the description. */
.ModelicaKeyword { color: blue; font-weight: normal; font-style: normal; } /* Keywords in Modelica. */
.ModelicaComment { color: #006400; font-weight: normal; font-style: normal;} /* All three variants of comments in Modelica. */
.ModelicaString { color: #006400; font-weight: normal; font-style: normal;} /* String constants. */
.ModelicaClass { color: red; font-weight: normal; font-style: normal;} /* Formatting the names of referenced classes (for base-class and components). */
.ModelicaFunction { color: red; font-weight: normal; font-style: normal;} /* Formatting for called functions. */
.ModelicaTablePackageContent { } /* The table of contents for each package. */
.ModelicaTableCrossReference { } /* The optional cross-reference table. */
.ModelicaTableInputs {} /* The table of inputs for a function. */
.ModelicaTableOutputs {} /* The table of outputs for a function. */
.ModelicaTableParameters {} /* The table of parameters for a model/block. */
.ModelicaTableConnectors {} /* The table of connectors for a model/block. */
.ModelicaTableContents {} /* The table of contents for a connector. */
.ModelicaStartAttribute { font-weight: bold; } /* The formatting used for start-attribute in the table of parameters, to separate them from parameter values. */
.ModelicaParameterTab { background-color: #c0c0c0; font-weight: bold; } /* The tab-heading in the table of parameters */
.ModelicaParameterGroup { background-color: #e0e0e0; } /* The group-heading in the table of parameters */
</style>
</head>
<body>
<!--[if supportFields]><span style="mso-element:field-begin"></span>
<span style="mso-spacerun:yes"></span>XE Block<![endif]-->
<!--[if supportFields]><span style="mso-element:field-end"></span><![endif]-->
<h2><img src="Modelica.Blocks.Icons.BlockI.png" alt="Modelica.Blocks.Icons.Block" align="right" style="border: 1px solid" width="80" height="80">
<a name="Modelica.Blocks.Icons.Block"></a>Modelica.Blocks.Icons.Block</h2>
<p>
<span class="ModelicaDescription">Basic graphical layout of input/output block</span>
</p>
<h3>Information</h3>

<p>
Block that has only the basic icon for an input/output
block (no declarations, no equations). Most blocks
of package Modelica.Blocks inherit directly or indirectly
from this block.
</p>

<h3>Modelica definition</h3>
<div class="modelica"><span class="ModelicaKeyword">partial </span><span class="ModelicaKeyword">block</span> Block <span class="ModelicaComment">&quot;Basic graphical layout of input/output block&quot;</span>


<span class="ModelicaKeyword">end </span>Block;
</div>
<hr>
<!--[if supportFields]><span style="mso-element:field-begin"></span>
<span style="mso-spacerun:yes"></span>XE PartialBooleanBlock<![endif]-->
<!--[if supportFields]><span style="mso-element:field-end"></span><![endif]-->
<h2><img src="Modelica.Blocks.Icons.Parcacc44aa79dcf4bdBlockI.png" alt="Modelica.Blocks.Icons.PartialBooleanBlock" align="right" style="border: 1px solid" width="80" height="80">
<a name="Modelica.Blocks.Icons.PartialBooleanBlock"></a>Modelica.Blocks.Icons.PartialBooleanBlock</h2>
<p>
<span class="ModelicaDescription">Basic graphical layout of logical block</span>
</p>
<h3>Information</h3>

<p>
Block that has only the basic icon for an input/output,
Boolean block (no declarations, no equations) used especially
in the Blocks.Logical library.
</p>

<h3>Modelica definition</h3>
<div class="modelica"><span class="ModelicaKeyword">partial </span><span class="ModelicaKeyword">block</span> PartialBooleanBlock <span class="ModelicaComment">
&quot;Basic graphical layout of logical block&quot;</span>

<span class="ModelicaKeyword">end </span>PartialBooleanBlock;
</div>
<hr>
<address>
<a href="http://www.3ds.com/">Automatically generated</a> Sun Apr 02 18:12:04 2017.
</address>
</body>
</html>
Loading

0 comments on commit dbfd490

Please sign in to comment.