Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Examples: Readme and runtime tests #7

Closed
8 of 9 tasks
ax3l opened this issue Aug 6, 2013 · 5 comments
Closed
8 of 9 tasks

Examples: Readme and runtime tests #7

ax3l opened this issue Aug 6, 2013 · 5 comments
Assignees
@steindev
Labels
component: tools scripts, python libs and CMake documentation regarding documentation or wiki discussions
Milestone
Future

Comments

@ax3l
Copy link
Member

ax3l commented Aug 6, 2013 •
edited
Loading

Write a Readme file for each example.
The Readme should contain

  • a description
  • tests to run (on a cluster)
  • commands for post processing
  • files to compare (within a separate git repository)

Progress:

documentation / tests
@ax3l ax3l mentioned this issue Aug 23, 2013
Closed
3 tasks
@ax3l
Copy link
Member Author

ax3l commented Jan 27, 2014

Hey guys, I just started writing a template the last days. I will open a pull request soon you can refer to.

I choosed to use YAML syntax, like in travis-ng, since it fits perfect into the requirement that one can read it as a human and can parse it super-easy for run time tests. I keep you posted.

@ghost ghost assigned ax3l Jan 27, 2014
ax3l referenced this issue Jan 27, 2014
@PrometheusPi
Create README.md
e74f384 
create .md file
@ax3l ax3l mentioned this issue Jan 27, 2014
Merged
@ax3l
Copy link
Member Author

ax3l commented Jan 27, 2014

Template added in #160 - feel free to add your own documentation.yml to your example.

@ax3l
Copy link
Member Author

ax3l commented Jan 28, 2014

@Heikman Please document Thermal and SingleParticleCurrent as done by @PrometheusPi in #162 for his example.
If you like you can already add some test afterwards via bash script.

@PrometheusPi PrometheusPi mentioned this issue Feb 4, 2014
Merged
@ax3l ax3l mentioned this issue May 28, 2014
Merged
@f-schmitt f-schmitt mentioned this issue Jun 18, 2014
Closed
3 tasks
ax3l referenced this issue in ax3l/picongpu Feb 17, 2015
@psychocoderHPC
Merge pull request #9 from ax3l/topic-travis
3c41471 
Add first draft of .travis.yml Close #7
@anshumang anshumang mentioned this issue Apr 29, 2015
Closed
ax3l referenced this issue in ax3l/picongpu Jul 23, 2015
@ax3l
Squashed 'thirdParty/cmake-modules/' changes from a47312b..af5d9d4
ac7454a 
af5d9d4 Merge pull request #7 from ComputationalRadiationPhysics/fix-mallocMCListExistence
464cf50 Fix: Undefined List for FindmallocMC
96d3dbd Merge pull request #6 from slizzered/hotfix-regression_from_list_with_spaces
0ec533e changed list creation to reference syntax
4c1a34f Required arguments checked exactly when required
0ad59c9 Hotfix for regression bug from prev commit
01c5d7b Merge pull request #5 from slizzered/issue3-mallocMC-module
eddc3ec Added documentation about MALLOCMC_ROOT variable
6a7ca13 Also use CMake variable MALLOCMC_ROOT
4cd27c9 removed hardcoded path
2cbaa5f Restructure module FindmallocMC.cmake
232cad5 Merge pull request #1 from ComputationalRadiationPhysics/topic-changToISC
779e84e Propose License Change to ISC

git-subtree-dir: thirdParty/cmake-modules
git-subtree-split: af5d9d47c539a8dac53c1e7240465384f86d7081
@ax3l ax3l modified the milestones: Future, 0.2.0: Open Beta Nov 11, 2016
ax3l referenced this issue in ax3l/picongpu Dec 8, 2016
@ax3l
Squashed 'thirdParty/cuda_memtest/' changes from 0e27280..6806362
3b03b9c 
6806362 Remove non-ascii chars
9bddbdf Merge pull request #9 from ComputationalRadiationPhysics/fix-travisCuda55Trusty
cb23b31 Merge pull request #7 from ComputationalRadiationPhysics/fix-closeFiles
2ad4d88 Travis: Migrate to Trusty Image
13e215e Close File Handles (cppcheck)

git-subtree-dir: thirdParty/cuda_memtest
git-subtree-split: 680636204b751c3e16e196ee95dc254ffae737db
ax3l referenced this issue in ax3l/picongpu Dec 8, 2016
@ax3l
Squashed 'thirdParty/cuda_memtest/' changes from 0e27280..6806362
3ee7880 
6806362 Remove non-ascii chars
9bddbdf Merge pull request #9 from ComputationalRadiationPhysics/fix-travisCuda55Trusty
cb23b31 Merge pull request #7 from ComputationalRadiationPhysics/fix-closeFiles
2ad4d88 Travis: Migrate to Trusty Image
13e215e Close File Handles (cppcheck)

git-subtree-dir: thirdParty/cuda_memtest
git-subtree-split: 680636204b751c3e16e196ee95dc254ffae737db
@ax3l
Copy link
Member Author

ax3l commented Feb 22, 2017

@Heikman can you please prepare a README.rst for ThermalTest? :)

@ax3l ax3l removed the feature label Nov 13, 2017
@steindev steindev assigned steindev and unassigned ax3l Mar 24, 2021
@steindev steindev mentioned this issue Apr 22, 2021
Closed
@steindev
Copy link
Member

steindev commented Sep 2, 2022

ThermalTest does not exist anymore. There is a new benchmark 'Thermal' which has a README. Can be closed.

@steindev steindev closed this as completed Sep 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@steindev steindev

Labels
component: tools scripts, python libs and CMake documentation regarding documentation or wiki discussions
Projects
None yet
Milestone
Future
Development

No branches or pull requests
2 participants
@ax3l @steindev