Improve cfg files and add TBG variable doc #153

f-schmitt · 2014-01-24T12:27:49Z

simplify .cfg files (only include used variables)
create central TBG cfg file and variable documentation

fixes issue #117

f-schmitt · 2014-01-24T12:28:13Z

please wait with pull until documentation for --radiation is updated

ax3l · 2014-01-27T12:39:01Z

Thank you for the clean-up and documentation. The TBG_Makro.cfg looks very useful, would you mind writing a little page on TBG with @psychocoderHPC about the workflow for PIConGPU users?

(Not about the TBG internals, we should write a general TBG documentation in the developer section of the wiki, but that is actually @psychocoderHPC 's job :P )

Maybe add a new page, starting from here? https://github.com/ComputationalRadiationPhysics/picongpu/wiki/PIConGPU-User-Documentation

f-schmitt · 2014-01-27T12:55:19Z

@ax3l as you said, @psychocoderHPC should write this. please open a new issue for that since it doesn't block this pull but should not be forgotten.

ax3l · 2014-01-27T13:31:11Z

Done, goes here in #158

psychocoderHPC · 2014-01-27T13:52:52Z

examples/KelvinHelmholtz/submit/0004gpus.cfg


-TBG_programParams="--periodic 1 1 1 \


This is the wrong section for periodic

integrated now

- simplify .cfg files (only include used variables) - create central TBG cfg file and variable documentation

- added var for periodic - added radiation plugin doc - fixed typos

ax3l · 2014-01-28T14:16:57Z

Looks good to me 👍

psychocoderHPC · 2014-01-29T10:49:06Z

examples/KelvinHelmholtz/submit/0004gpus.cfg

+TBG_eBin="--bin_e.period 100 --bin_e.binCount 1024 --bin_e.minEnergy 0 --bin_e.maxEnergy 5000"
+TBG_iBin="--bin_i.period 100 --bin_i.binCount 1024 --bin_i.minEnergy 0 --bin_i.maxEnergy 2000000"
+
+TBG_periodic="--periodic 1 1 1"


@ax3l
Is this an optional variable. I think "periodic" must moved to required variables, because this example makes no sense without periodic enabled.

It's in optional vars since it is optional for the example to use/require it. In contrast, required variables are necessary for every example. You could also say png is required here because otherwise, you may compute something but won't get any results.

That's ok for me. I think @f-schmitt-zih was aiming for "required" == will not start without it and "optional" == sets options.

Anyway, you could still move it to the top of optional vars, since it is quite important as @psychocoderHPC stated correctly.

psychocoderHPC · 2014-01-29T19:23:32Z

I will checkout this branch tomorrow and move periodic and add moving window to lwfa. This lwfa example needs moving window.

- move --periodic to required variables - change grid sizes and timesteps to reasonable values

psychocoderHPC · 2014-01-30T09:37:31Z

@f-schmitt-zih You have a pull request in your branch.

psychocoderHPC · 2014-01-30T09:54:03Z

I have seen that we call one variable in the cfgs TBG_analyser, should we rename this variable to TBG_plugins?

ax3l · 2014-01-30T12:38:15Z

Absolutely, that name is outdated. Well spotted 👍

move parameter, fix example parameter

ax3l · 2014-01-31T08:59:46Z

Please still rename all the TBG_analyser with TBG_plugin so we can merge that branch ✨

psychocoderHPC · 2014-02-01T21:03:56Z

👍 I merge it on monday!

Improve cfg files and add TBG variable doc

e2533d141 Merge pull request ComputationalRadiationPhysics#153 from psychocoderHPC/topic-versionIncrease2.3.1 2723bc13d Merge pull request ComputationalRadiationPhysics#154 from ax3l/topic-cmake312rootHints 60c467ece version increase to 2.3.1 5f57e6d1f CMake: Honor _ROOT Env Hints e0bbb5fdd Merge pull request ComputationalRadiationPhysics#151 from ax3l/merge-v230master 16cd2b9a5 Merge remote-tracking branch 'mainline/master' into merge-v230master 8dbb2dd6e Merge pull request ComputationalRadiationPhysics#150 from psychocoderHPC/fix-warpsPerSM cab1dd5fc fix style, fix wrong used qualifier 5a71062db fix illegal memory access git-subtree-dir: thirdParty/mallocMC git-subtree-split: e2533d14101c9fa7af3d11b9d02277591e06d8e4

f60a0ac72c Merge pull request ComputationalRadiationPhysics#155 from ComputationalRadiationPhysics/dev 4c73dde10d Merge pull request ComputationalRadiationPhysics#152 from psychocoderHPC/topic-changeLogVersionIncreaseTo0.2.0 fc428aa8e9 update release date for 0.2.0 1e32118c80 Merge pull request ComputationalRadiationPhysics#154 from sbastrakov/topic-addInt3Float3 84008fb6ae Add float3 and int3 with make-functions 4d5eace02a Merge pull request ComputationalRadiationPhysics#153 from sbastrakov/topic-finalizeBlackScholes2 bc35f6a822 Add Black-Scholes example 4b1ab5722f Merge pull request ComputationalRadiationPhysics#146 from psychocoderHPC/topic-changeLogVersionIncreaseTo0.2.0 52ddba6b26 changelog and version increase to 0.2.0 aabb8d5339 Merge pull request ComputationalRadiationPhysics#145 from psychocoderHPC/fix-minimalCMakeRequirements 7795e58c0c Merge pull request ComputationalRadiationPhysics#147 from psychocoderHPC/topic-updateAuthorSection 974afe8451 Merge pull request ComputationalRadiationPhysics#150 from sbastrakov/doc-clarifyThreadUnsafety caf4fdda1e Extend the docs with thread unsafety 91d78da7eb Merge pull request ComputationalRadiationPhysics#149 from psychocoderHPC/topic-setTravisCmakeToMinimumRequiredVersion a3bc920dfa use CMake 3.11.4 for travis tests 9ccab281e9 update author section 6bc13a220c Merge pull request ComputationalRadiationPhysics#148 from psychocoderHPC/topic-cuplaLogo 406fb5b93a update minimal CMake requirements to 3.11.4 9c32408da3 add cupla logo cd6b9859d4 Merge pull request ComputationalRadiationPhysics#144 from psychocoderHPC/topic-hipPinnedMemory c9fb7dd047 pin memory allocated with `cuplaMallocHoast` 92f8c82474 Merge pull request ComputationalRadiationPhysics#143 from psychocoderHPC/topic-updateAlpakaTo0.4.0 27f0bca235 Merge commit '0f175188a374a0194145728f2083256e1eb14b13' into topic-updateAlpakaTo0.4.0 0f175188a3 Squashed 'alpaka/' changes from d5e59590f..ab0b8a460 1e4aea9747 Merge pull request ComputationalRadiationPhysics#142 from sbastrakov/fix-typeCastWarnings 8f453a4bf5 Fix warnings concerning type casting 08f80ef24b Merge pull request ComputationalRadiationPhysics#141 from sbastrakov/topic-extendAtomicComments b3d34b28ab Extend comments of atomic functions git-subtree-dir: thirdParty/cupla git-subtree-split: f60a0ac72cb175d4a8a67301882f7a6b1de4c3c3

ghost assigned psychocoderHPC Jan 24, 2014

psychocoderHPC reviewed Jan 27, 2014
View reviewed changes

f-schmitt added 3 commits January 27, 2014 20:44

Improve cfg files and add TBG variable doc

fa9a6b6

- simplify .cfg files (only include used variables) - create central TBG cfg file and variable documentation

Updated cfg files and improved macro doc

59c0f82

- added var for periodic - added radiation plugin doc - fixed typos

Improve header layout and add internal variables

fd9bb68

Add note for multi-use flags

44d71c9

psychocoderHPC reviewed Jan 29, 2014
View reviewed changes

move parameter, fix example parameter

5c59bb2

- move --periodic to required variables - change grid sizes and timesteps to reasonable values

add moving window option to lwfa example

ea3a499

Merge pull request #1 from psychocoderHPC/topic-betterCfgs

10f6528

move parameter, fix example parameter

Rename TBG_analyser to TBG_plugins

cd28753

psychocoderHPC added a commit that referenced this pull request Feb 3, 2014

Merge pull request #153 from f-schmitt-zih/topic-betterCfgs

4b1ef74

Improve cfg files and add TBG variable doc

psychocoderHPC merged commit 4b1ef74 into ComputationalRadiationPhysics:dev Feb 3, 2014

f-schmitt deleted the topic-betterCfgs branch February 3, 2014 10:30

f-schmitt mentioned this pull request Feb 3, 2014

Clarify .cfg files #117

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve cfg files and add TBG variable doc #153

Improve cfg files and add TBG variable doc #153

f-schmitt commented Jan 24, 2014

f-schmitt commented Jan 24, 2014

ax3l commented Jan 27, 2014

f-schmitt commented Jan 27, 2014

ax3l commented Jan 27, 2014

psychocoderHPC Jan 27, 2014

ax3l Jan 28, 2014

ax3l commented Jan 28, 2014

psychocoderHPC Jan 29, 2014

f-schmitt Jan 29, 2014

ax3l Jan 29, 2014

psychocoderHPC commented Jan 29, 2014

psychocoderHPC commented Jan 30, 2014

psychocoderHPC commented Jan 30, 2014

ax3l commented Jan 30, 2014

ax3l commented Jan 31, 2014

psychocoderHPC commented Feb 1, 2014


		TBG_programParams="--periodic 1 1 1 \

Improve cfg files and add TBG variable doc #153

Improve cfg files and add TBG variable doc #153

Conversation

f-schmitt commented Jan 24, 2014

f-schmitt commented Jan 24, 2014

ax3l commented Jan 27, 2014

f-schmitt commented Jan 27, 2014

ax3l commented Jan 27, 2014

psychocoderHPC Jan 27, 2014

Choose a reason for hiding this comment

ax3l Jan 28, 2014

Choose a reason for hiding this comment

ax3l commented Jan 28, 2014

psychocoderHPC Jan 29, 2014

Choose a reason for hiding this comment

f-schmitt Jan 29, 2014

Choose a reason for hiding this comment

ax3l Jan 29, 2014

Choose a reason for hiding this comment

psychocoderHPC commented Jan 29, 2014

psychocoderHPC commented Jan 30, 2014

psychocoderHPC commented Jan 30, 2014

ax3l commented Jan 30, 2014

ax3l commented Jan 31, 2014

psychocoderHPC commented Feb 1, 2014