BlueM.Sim Development: Difference between revisions

From BlueM
Jump to navigation Jump to search
(added section for testing)
m (→‎Compilation: formatting)
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{BlueM_nav}}
{{BlueM.Sim_nav}}
<div style="float: right; margin-left: 20px;">__TOC__</div>
<div style="float: right; margin-left: 20px;">__TOC__</div>


==Code==
==Source code==
{{SVN_Hilfe}}
The source code consists of the following individual projects:  
Der Quellcode besteht aus den folgenden Projekten:  
* '''[[BlueM.Win]]:''' .NET desktop app
* '''[[BlueM.Win]]:''' GUI
* '''[[BlueM.Sim Code|BlueM.Sim]]:''' Fortran simulation engine
* '''[[BlueM.Sim Code|BlueM.Sim]]:''' Fortran Rechenkern
* '''[[BlueM.DLLAdapter]]:''' .NET wrapper for communication between BlueM.Win and BlueM.Sim
* '''[[BlueM.DLLAdapter]]:''' .NET Wrapper zum Ansprechen des BlueM.Sim Rechenkerns
* '''[[Gütemodell|BlueM.LaPipe]]:''' component for water quality calculations
* '''[[Wave]]:''' Tool zur Zeitreihendarstellung und -analyse
* '''[[BlueM.Wave]]:''' Tool for time series display and analysis


Es gibt zwei Möglichkeiten, um sich den erforderlichen Code zusammenzustellen:
All source code and issues are managed on GitHub: https://github.com/bluemodel
* Man nutzt per SVN die 'Meta'-Repository, die bereits Projektmappendateien enthält und in der die erforderlichen Projekte mittels svn:externals bereits vordefiniert sind: <br/>http://svn.bluemodel.org/Meta/BlueM.Win/
:''oder''
* Die einzelnen Projekte müssen manuell heruntergeladen/ausgecheckt werden (Zugriff siehe Tabelle) und dann in einer Projektmappe integriert werden.


:{| cellpadding="5" cellspacing="0" border="0" class="standard stripes"
Most individual BlueM components are configured to build to a common parent output folder <code>..\bin\<Platform>\<Configuration></code>. The recommended folder structure is thus to have all individual components in one single parent folder as follows:
! Projekt !! SVN-Zugriff !! WebSVN
<pre>
|-
BlueM
| BlueM.Win || http://svn.bluemodel.org/BlueM.Win/ || [http://websvn.bluemodel.org/listing.php?repname=BlueM.Win&path=%2F&sc=1 BlueM.Win]
- BlueM.DLLAdapter
|-
- BlueM.LaPipe
| BlueM.Sim || http://svn.bluemodel.org/BlueM.Sim/ || [http://websvn.bluemodel.org/listing.php?repname=BlueM.Sim&path=%2F&sc=1 BlueM.Sim]
- BlueM.Sim
|-
- BlueM.Wave
| BlueM.DLLAdapter || http://svn.bluemodel.org/BlueM.DLLAdapter/ || [http://websvn.bluemodel.org/listing.php?repname=BlueM.DLLAdapter&path=%2F&sc=1 BlueM.DLLAdapter]
- BlueM.Win
|-
</pre>
| Wave || http://svn.bluemodel.org/Wave/ || [http://websvn.bluemodel.org/listing.php?repname=Wave&path=%2F&sc=1 Wave]
This also ensures that references between projects work out of the box.
|}


==Compilation==
==Compilation==
:&rarr; ''see [[BlueM.Sim compilation]]''
:&rarr; ''see [[BlueM.Sim compilation]]''
BlueM.Win includes BlueM.Wave which uses [https://www.steema.com/product/net TeeChart .NET] for all charts. To compile a fully functional version of BlueM.Win, you need a valid TeeChart .NET Pro license file located at both <code>BlueM.Win\source\My Project\TeeChart.licenses</code> and <code>BlueM.Wave\source\My Project\TeeChart.licenses</code>.
For testing purposes, you can use the evaluation version of TeeChart by creating empty text files in place of the license files or by excluding the corresponding entries from the BlueM.Win and Wave projects in Visual Studio. This will allow you to compile, but any charts will be displayed with a watermark.
==Debugging==
[[File:BlueM.Win debug setting.png|thumb|right|Screenshot of debug setting in BlueM.Win required for debugging BlueM.Sim]]
In order to be able to debug BlueM.Sim, you need to activate the option ''Enable native code debugging'' in the ''Debug'' section of the project properties of the startup-application (i.e. BlueM.Win).
This is a per-user-setting and needs to be activated for every individual build setup.


==Testing==
==Testing==
Line 34: Line 40:


==Docs==
==Docs==
'''BlueM .NET API Documentation''' (für [[BlueM.DLLAdapter]] und [[OpenMI|BlueM.OpenMI]]):
* [http://130.83.196.154/BlueM/docs/BlueM_API/Html/R_Project.htm HTML] / [http://130.83.196.154/BlueM/docs/BlueM_API/BlueM_API.chm CHM] <small>(erstellt mit [http://130.83.196.154/svn/BlueM.Docs DocProject])</small>
'''BlueM.Sim''':<br/>
'''BlueM.Sim''':<br/>
:&rarr; ''siehe [[BlueM.Sim Code]]''
:&rarr; ''siehe [[BlueM.Sim Code]]''

Latest revision as of 13:05, 14 September 2023

BlueM_icon.png BlueM.Sim | Downloads | Application | Theory | Development

Source code

The source code consists of the following individual projects:

All source code and issues are managed on GitHub: https://github.com/bluemodel

Most individual BlueM components are configured to build to a common parent output folder ..\bin\<Platform>\<Configuration>. The recommended folder structure is thus to have all individual components in one single parent folder as follows:

BlueM
 - BlueM.DLLAdapter
 - BlueM.LaPipe
 - BlueM.Sim
 - BlueM.Wave
 - BlueM.Win

This also ensures that references between projects work out of the box.

Compilation

see BlueM.Sim compilation

BlueM.Win includes BlueM.Wave which uses TeeChart .NET for all charts. To compile a fully functional version of BlueM.Win, you need a valid TeeChart .NET Pro license file located at both BlueM.Win\source\My Project\TeeChart.licenses and BlueM.Wave\source\My Project\TeeChart.licenses.

For testing purposes, you can use the evaluation version of TeeChart by creating empty text files in place of the license files or by excluding the corresponding entries from the BlueM.Win and Wave projects in Visual Studio. This will allow you to compile, but any charts will be displayed with a watermark.

Debugging

Screenshot of debug setting in BlueM.Win required for debugging BlueM.Sim

In order to be able to debug BlueM.Sim, you need to activate the option Enable native code debugging in the Debug section of the project properties of the startup-application (i.e. BlueM.Win).

This is a per-user-setting and needs to be activated for every individual build setup.

Testing

see BlueM.DLLAdapterTest

Docs

BlueM.Sim:

siehe BlueM.Sim Code

Style

siehe Code-Formatierung