Submission rules - Revision history

Saak at 14:28, 25 March 2024

2024-03-25T14:28:39Z

← Older revision		Revision as of 14:28, 25 March 2024
Line 1:		Line 1:
	~~[[Category:Benchmarks]]~~

	<!-- __NUMBEREDHEADINGS__ -->		<!-- __NUMBEREDHEADINGS__ -->

Lund: /* File standard */ will --> may

2022-09-02T16:12:46Z

File standard: will --> may

← Older revision		Revision as of 16:12, 2 September 2022
Line 81:		Line 81:
	A single benchmark instance should be saved in the .mat (https://de.mathworks.com/help/matlab/import_export/mat-file-versions.html) file format. To accommodate multiple languages, features, and the benchmark comparison tool (currently under development), we recommend v7.2 (https://docs.scipy.org/doc/scipy-0.14.0/reference/generated/scipy.io.loadmat.html). For example, the file associated to [[CD Player]] contains three matrices <math>A</math>, <math>B</math>, <math>C</math>.		A single benchmark instance should be saved in the .mat (https://de.mathworks.com/help/matlab/import_export/mat-file-versions.html) file format. To accommodate multiple languages, features, and the benchmark comparison tool (currently under development), we recommend v7.2 (https://docs.scipy.org/doc/scipy-0.14.0/reference/generated/scipy.io.loadmat.html). For example, the file associated to [[CD Player]] contains three matrices <math>A</math>, <math>B</math>, <math>C</math>.

	Other file formats are accepted, as long as the naming scheme outlined in [[Models]] is adhered to. The editors reserve the right to adapt any data to fit our standards, and we ~~will~~ additionally add metadata to .mat file.		Other file formats are accepted, as long as the naming scheme outlined in [[Models]] is adhered to. The editors reserve the right to adapt any data to fit our standards, and we may additionally add metadata to .mat file.

	==References==		==References==

Lund: /* Metadata */ update DAE index protocol

2022-09-02T16:12:05Z

Metadata: update DAE index protocol

← Older revision		Revision as of 16:12, 2 September 2022
Line 53:		Line 53:
	* License (see, e.g., https://tldrlegal.com/)		* License (see, e.g., https://tldrlegal.com/)
	* Model components (which should match what is submitted in the data file(s))		* Model components (which should match what is submitted in the data file(s))
	* DAE ~~index (where applicable)~~: 0, 1, 2, etc. 0 indicates an ODE.		* Differentiation index of DAE: 0, 1, 2, etc. (0 indicates ODE)
	* DAE index type (where applicable)
	* Is the system... (boolean responses only)		* Is the system... (boolean responses only)
			** a DAE? (must be 1 if differentiation index is nonzero)
	** affine parametric?		** affine parametric?
	** block structured?		** block structured?

Lund: /* Metadata */ add detail to DAE index

2022-08-25T14:51:11Z

Metadata: add detail to DAE index

← Older revision		Revision as of 14:51, 25 August 2022
Line 53:		Line 53:
	* License (see, e.g., https://tldrlegal.com/)		* License (see, e.g., https://tldrlegal.com/)
	* Model components (which should match what is submitted in the data file(s))		* Model components (which should match what is submitted in the data file(s))
	* DAE index (where applicable)		* DAE index (where applicable): 0, 1, 2, etc. 0 indicates an ODE.
	* DAE index type (where applicable)		* DAE index type (where applicable)
	* Is the system... (boolean responses only)		* Is the system... (boolean responses only)

Lund: /* Metadata */ fix sublist

2022-08-25T14:49:56Z

Metadata: fix sublist

← Older revision		Revision as of 14:49, 25 August 2022
Line 56:		Line 56:
	* DAE index type (where applicable)		* DAE index type (where applicable)
	* Is the system... (boolean responses only)		* Is the system... (boolean responses only)
	* affine parametric?		** affine parametric?
	* block structured?		** block structured?
	* bilinear?		** bilinear?
	* control affine?		** control affine?
	* dissipative?		** dissipative?
	* nonlinear?		** nonlinear?
	* passive?		** passive?
	* Port-Hamiltonian?		** Port-Hamiltonian?
	* square?		** square?
	* stable?		** stable?
	* state-space symmetric?		** state-space symmetric?
	* symmetric?		** symmetric?
	* quadratic bilinear?		** quadratic bilinear?

	Additional metadata will be automatically generated internally for the purposes of searchability and categorization.		Additional metadata will be automatically generated internally for the purposes of searchability and categorization.

Lund: correct internal links

2022-08-25T14:48:50Z

correct internal links

← Older revision		Revision as of 14:48, 25 August 2022
Line 73:		Line 73:
	==Data Files==		==Data Files==

	All the numerical data for the collection is regarded as a list of matrices, a vector being a m x 1 matrix. Consequently, we have implemented a strict naming scheme for matrices corresponding to different models. See [Models].		All the numerical data for the collection is regarded as a list of matrices, a vector being a m x 1 matrix. Consequently, we have implemented a strict naming scheme for matrices corresponding to different models. See [[Models]].

	An author can suggest another naming standard in the case when the templates outlined in [Models] are insufficient. Otherwise exceptions will not be permitted.		An author can suggest another naming standard in the case when the templates outlined in [[Models]] are insufficient. Otherwise exceptions will not be permitted.

	===File standard===		===File standard===
	A single benchmark instance should be saved in the .mat (https://de.mathworks.com/help/matlab/import_export/mat-file-versions.html) file format. To accommodate multiple languages, features, and the benchmark comparison tool (currently under development), we recommend v7.2 (https://docs.scipy.org/doc/scipy-0.14.0/reference/generated/scipy.io.loadmat.html). For example, the file associated to [CD Player] contains three matrices <math>A</math>, <math>B</math>, <math>C</math>.		A single benchmark instance should be saved in the .mat (https://de.mathworks.com/help/matlab/import_export/mat-file-versions.html) file format. To accommodate multiple languages, features, and the benchmark comparison tool (currently under development), we recommend v7.2 (https://docs.scipy.org/doc/scipy-0.14.0/reference/generated/scipy.io.loadmat.html). For example, the file associated to [[CD Player]] contains three matrices <math>A</math>, <math>B</math>, <math>C</math>.

	Other file formats are accepted, as long as the naming scheme outlined in [Models] is adhered to. The editors reserve the right to adapt any data to fit our standards, and we will additionally add metadata to .mat file.		Other file formats are accepted, as long as the naming scheme outlined in [[Models]] is adhered to. The editors reserve the right to adapt any data to fit our standards, and we will additionally add metadata to .mat file.

	==References==		==References==

Lund: /* Additional Content */ add section about metadata

2022-08-25T14:46:58Z

Additional Content: add section about metadata

@@ Line 46: / Line 46: @@
 # Description of any other related results.
 # We stress the importance of describing the software employed as well as its related options.
 ==Data Files==

Lund: /* Data Files */ Overhaul of standards

2022-08-25T14:38:32Z

Data Files: Overhaul of standards

@@ Line 49: / Line 49: @@
 ==Data Files==
-All the numerical data for the collection can be considered as a list of matrices, a vector being a m x 1 matrix. As a result, there should be a naming convention for the matrices.
+All the numerical data for the collection is regarded as a list of matrices, a vector being a m x 1 matrix.  Consequently, we have implemented a strict naming scheme for matrices corresponding to different models.  See [Models].
-===Naming convention===
+An author can suggest another naming standard in the case when the templates outlined in [Models] are insufficient.  Otherwise exceptions will not be permitted.
-Below <math>x</math> is a state vector, <math>\mu</math> is a vector of parameters in the system, if any.
+===File standard===
-For the two cases of a linear system of first and second differential order, the naming convention should be written as follows
+Other file formats are accepted, as long as the naming scheme outlined in [Models] is adhered to.  The editors reserve the right to adapt any data to fit our standards, and we will additionally add metadata to .mat file.
 ==References==

Lund: /* Content Rules */ Add section about choosing a good name

2022-08-25T14:28:11Z

Content Rules: Add section about choosing a good name

← Older revision		Revision as of 14:28, 25 August 2022
Line 12:		Line 12:

	The supplementary documents as well as the wikipage may be written by different authors, however each individual document should be written according to conventional scientific practice; that is, it should describe the subject in such a way that, at least in principle, anyone could reproduce the results presented. The authors should understand that the document may be read by people from quite different disciplines. Hence, abbreviations should be avoided or at least explained and references to the background ideas should be provided.		The supplementary documents as well as the wikipage may be written by different authors, however each individual document should be written according to conventional scientific practice; that is, it should describe the subject in such a way that, at least in principle, anyone could reproduce the results presented. The authors should understand that the document may be read by people from quite different disciplines. Hence, abbreviations should be avoided or at least explained and references to the background ideas should be provided.

			===Page Name===
			Be careful to choose a unique, concise name, around 2-3 words. This name will become a permanent attribute of the benchmark and will be used internally for downstream purposes.

	===Content Requirement===		===Content Requirement===
Line 43:		Line 46:
	# Description of any other related results.		# Description of any other related results.
	# We stress the importance of describing the software employed as well as its related options.		# We stress the importance of describing the software employed as well as its related options.


	==Data Files==		==Data Files==

Lund: Heavily edited style grammar

2022-08-25T14:20:28Z

Heavily edited style grammar

← Older revision		Revision as of 14:20, 25 August 2022
Line 1:		Line 1:
	[[Category:~~Miscellaneous~~]]		[[Category:Benchmarks]]

	<!-- __NUMBEREDHEADINGS__ -->		<!-- __NUMBEREDHEADINGS__ -->
	The ~~MOR Wiki~~ [[:Category:Benchmark\|benchmark collection]] contains benchmarks related to model order reduction. Its goal is to supply ~~the~~ dynamical systems in a computer-readable format to researchers from different areas~~. They~~ can then test new algorithms, software, etc.		The MORWiki [[:Category:Benchmark\|benchmark collection]] contains benchmarks related to model order reduction. Its goal is to supply dynamical systems in a computer-readable format to researchers from different areas, who can then test new algorithms, software, etc.

	The collection contains documents and wikipages that are ~~supposed to be processed by a~~ human ~~being~~ and data files that ~~are supposed to~~ be read automatically by software. As a result, with minor exceptions, the rules concerning ~~documents have a recommendation status~~, ~~and the rules~~ concerning data files are obligatory.		The collection contains documents and wikipages that are human-readable and data files that can be read automatically by software. As a result, with minor exceptions, the rules concerning page preparation are recommended, while those concerning data files are considered obligatory (with exceptions, for example, for new types of nonlinear models).

	~~We start~~ with ~~describing the benchmark creation process~~, ~~then we present the description~~ of ~~what content is needed on the wikipages as well as the supplement documents, and finally we describe the data files~~.

	==Benchmark Creation==		==Benchmark Creation==
	Anyone who has an example that could be relevant for ~~this MOR~~ benchmark collection can add it ~~to the collection,~~ after the editors ~~decide that~~ it ~~is suitable for our collection~~. ~~In order to be allowed to create a benchmark, one has to~~ write an email to the editors ~~asking for access to the wiki~~ describing the benchmark to be created. If the editors accept the benchmark they grant access to the ~~authors~~ and create an empty page for the benchmark~~. The~~ submitter ~~needs to~~ then edit the ~~created wikipage~~, ~~upload the~~ data files and supplementary documents ~~and link them~~ within the page. See 2.1 for the content requirement.		Anyone who has an example that could be relevant for the benchmark collection can add it after the editors have approved it. Simply write an email to the editors describing the benchmark to be created. Ideally, one should be able to point to an existing data set and publication. If the editors accept the benchmark, they then grant access to the submitter and create an empty page for the benchmark, which the submitter must then edit with a description of the benchmark, uploaded data files, and any supplementary documents, all of which should be linked within the page itself. See 2.1 for the content requirement.


	==Content Rules==		==Content Rules==

	The supplementary documents as well as the wikipage may be written by different authors, however each individual document should be written according to conventional scientific practice, that is, it ~~describes~~ the ~~matters~~ in such a way that, at least in principle, anyone could reproduce the results presented. The authors should understand that the document may be read by people from quite different disciplines. Hence, abbreviations should be avoided or at least explained and references to the background ideas should be ~~made~~.		The supplementary documents as well as the wikipage may be written by different authors, however each individual document should be written according to conventional scientific practice; that is, it should describe the subject in such a way that, at least in principle, anyone could reproduce the results presented. The authors should understand that the document may be read by people from quite different disciplines. Hence, abbreviations should be avoided or at least explained and references to the background ideas should be provided.

	===Content Requirement===		===Content Requirement===
	Most of this content can be included in the wiki page directly. However, this is not necessary.		Most of this content can be included in the wiki page directly. However, this is not necessary.
	One should describe the origin of the ~~dynamic~~ system and its relevance to the application area. It is important to present the mathematical model, the meaning of the inputs and outputs, and the desired behavior from the application viewpoint.		One should describe the origin of the dynamical system and its relevance to the application area. It is important to present the mathematical model, the meaning of the inputs and outputs, and the desired behavior from the application viewpoint.

	The following points should be considered and if possible included in ~~your~~ benchmark:		The following points should be considered and if possible included in the benchmark description:

	* The purpose of the model should be explained clearly. (For instance, simulation, iterative system design, feedback control design, ...)		* The purpose of the model should be explained clearly. (For instance, simulation, iterative system design, feedback control design, ...)
	* Why should the model be reduced at all? (For instance, reducing simulation time, reducing implementation effort in observers, controllers...)		* Why should the model be reduced at all? (For instance, reducing simulation time, reducing implementation effort in observers, controllers...)
	* What are the QUALITATIVE requirements to the reduced model? What variables are to be approximated well? Is the step response to be approximated or is it the ~~bode~~ plot? What are typical input signals? (Some systems are driven by a step function and nothing else, others are driven by a wide variety of input signals, others are used in closed loops and can cause instabilities, although being stable themselves.)		* What are the QUALITATIVE requirements to the reduced model? What variables are to be approximated well? Is the step response to be approximated or is it the Bode plot? What are typical input signals? (Some systems are driven by a step function and nothing else, others are driven by a wide variety of input signals, others are used in closed loops and can cause instabilities, although being stable themselves.)
	* What are the QUANTITATIVE requirements to the reduced model? Best would be if the authors of any individual model can suggest some cost functions (performance indices) to be used for the comparison. These can be in time domain, or in frequency domain (including bandwidth), or both.		* What are the QUANTITATIVE requirements to the reduced model? Best would be if the authors of any individual model can suggest some cost functions (performance indices) to be used for the comparison. These can be in time domain, or in frequency domain (including bandwidth), or both.
	* Are there limits of input and state variables known? (application related or generally)? What are the physical limits where the model becomes useless/false? If known a-priori: Out of the technically typical input signals, which one will cause "the most nonlinear" behavior?		* Are there limits of input and state variables known? (application related or generally)? What are the physical limits where the model becomes useless/false? If known a-priori: Out of the technically typical input signals, which one will cause "the most nonlinear" behavior?
Line 30:		Line 27:
	* Is the system linear or nonlinear? Is it a first or a second order system?		* Is the system linear or nonlinear? Is it a first or a second order system?
	* When the model is used to test, e.g. an algorithm, can some of the parameters in the model be fixed, such that the model includes fewer parameters, which makes the testing easier?		* When the model is used to test, e.g. an algorithm, can some of the parameters in the model be fixed, such that the model includes fewer parameters, which makes the testing easier?
	* If possible, the source code ~~which generates~~ the model ~~is encouraged to~~ be provided.		* If possible, the source code generating the model should be provided.
			* We stress the importance of describing the software employed, as well as its related options. For example, if the model is generated from ANSYS, the software ANSYS better be mentioned. If necessary, please also describe some related options like boundary conditions, initial conditions, and other parameters which need to be assigned when generating the model. Please go to the benchmark webpage [[Silicon nitride membrane]] for a reference.
	* We stress the importance ~~to describe~~ the software employed, as well as its related options. For example, if the model is generated from ANSYS, the software ANSYS is better to be mentioned. If necessary, please also describe some related options like boundary conditions, initial conditions, and other parameters which need to be assigned when generating the model. Please go to the benchmark webpage [[Silicon nitride membrane]] for a reference.		* If the dynamical system is obtained from partial differential equations, then the information about material properties, geometrical data, and initial and boundary conditions should be given. The exception to this rule is the case when the original model comes from industry. In this case, if trade secrets are tied with the information mentioned, it may be kept hidden.
			* The authors are encouraged to produce several dynamical models of different dimensions in order to provide an opportunity to apply different software and to research scalability issues. If an author has an interactive page on their server to generate benchmarks, a link to this page is welcome.
	* If the ~~dynamic~~ system is obtained from partial differential equations, then the information about material properties, geometrical data, initial and boundary conditions should be given. The exception to this rule is the case when the original model comes from industry. In this case, if trade secrets are tied with the information mentioned, it may be kept hidden.		* The dynamical system may be obtained by means of compound matrices, for example, when the second-order system is converted to first-order. In this case, the document should describe such a transformation but in the data file the original and not the compound matrices should be given. This allows for researching other ways of model reduction of the original system.

	* The authors are encouraged to produce several ~~dynamic~~ models of different dimensions in order to provide an opportunity to apply different software and to research scalability issues. If an author has an interactive page on ~~his/her~~ server to generate benchmarks, a link to this page is welcome.

	* The ~~dynamic~~ system may be obtained by means of compound matrices, for example, when the second-order system is converted to first-order. In this case, the document should describe such a transformation but in the data file the original and not the compound matrices should be given. This allows ~~to research~~ other ways of model reduction of the original system.

	The above information is in a general sense. Therefore, some items may not be applicable to certain benchmarks. However, it is recommended that the items that apply to the benchmark provided ~~should~~ be fully considered.		The above information is in a general sense. Therefore, some items may not be applicable to certain benchmarks. However, it is recommended that the items that apply to the benchmark provided be fully considered.

	===Additional Content===		===Additional Content===