Skip to content

Create initial TriBITS tutorial #190

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
Open
bartlettroscoe opened this issue May 10, 2017 · 5 comments
Open

Create initial TriBITS tutorial #190

bartlettroscoe opened this issue May 10, 2017 · 5 comments
Assignees
@fryeguy52
Labels
component: documentation type: enhancement
Milestone
Improve documenat...

Comments

@bartlettroscoe
Copy link
Member

Description:

This story will track the creation of a new TriBITS tutorial.

ToDo: Fill in more scope ...

@fryeguy52 will primarily work on this as part of learning TriBITS.
@bartlettroscoe
Copy link
Member Author

Need to decide on a few things:

  1. What format to use (e.g. RST, MarkDown, Latex, etc.)? => RST (use TriBITS Developers Guide as tempate)
  2. What the outline should look like? => Just try something and we can talk

@bartlettroscoe
Copy link
Member Author

@fryeguy52,

Create branch tribits-tutorial-190 and put in our GitHub fork using:

$ git clone git@github.com:TriBITSPub/TriBITS.git
$ cd TriBITS/  # This is on 'master' tracking 'origin/master'
$ git remote add fryeguy52 git@github.com:fryeguy52/TriBITS.git
$ git fetch fryeguy52  # Just make sure you have this right
$ git checkout -b tribits-tutorial-190 origin/master
$ git push -u fryeguy52 tribits-tutorial-190

Then just make all of your changes on your local tribits-tutorial-190 branch and push to your remote tracking branch to backup and show progress with:

[frye??  (tribits-tutorial-190)$] git push  # to fryeguy52

And, please put #190 in all of your commit messages (e.g. in the Summary line blah blah blah (#190)).

bartlettroscoe added a commit that referenced this issue May 18, 2017
@bartlettroscoe
Set default for Fortran to OFF unconditionally (#190)
f01ac64 
With the old setup, it was ignoring the setting of
${PROJECT_NAME}_ENABLE_Fortran_DEFAULT to OFF and was trying to find Fortran
anyway.  We found this while working on #190.

I added an automated test to make sure that TribitsHelloWorld (which sets the
default to OFF) is not trying to find Fortran.

This is a break in backward compatibility but about the only project affected
will be Trilinos.  When I snapshot TriBITS into Trilinos, I will add back the
logic to the Trilinos/CMakeLists.txt file to disable Fortran on Windows
(without Cygwin).

Build/Test Cases Summary
Enabled Packages:
Enabled all Packages
0) MPI_DEBUG => passed: passed=239,notpassed=0 (0.41 min)
1) SERIAL_RELEASE => passed: passed=239,notpassed=0 (0.36 min)
bartlettroscoe added a commit to bartlettroscoe/Trilinos that referenced this issue May 18, 2017
@bartlettroscoe
Disable Fortran by default on Windows (TriBITSPub/TriBITS#190)
959cb9e 
This maintains backward compatibility for Trilinos given the TriBITS refactoring that removed this logic.

Projects should provide their own logic for if and when they want to try to
default enable Fortran or not.  Trilinos is a bit unique in this reguard.
Other TriBITS projects like CASL VERA, COBRA-TF, MPACT, SCALE, and
TribitsHelloWorld, have a more straightforward default in all cases.

Also see trilinos#1338.
@bartlettroscoe
Copy link
Member Author

@fryeguy52, note that I just pushed the commit 959cb9e that should fix the behavior of <Project>_ENABLE_Fortran_DEFAULT that we saw yesterday.

@bartlettroscoe bartlettroscoe mentioned this issue Jun 14, 2017
Open
@bartlettroscoe bartlettroscoe mentioned this issue Jul 5, 2017
Closed
@bartlettroscoe
Copy link
Member Author

@fryeguy52, I rebased your branch tribits_tutorial pointed to in PR #192 and pushed it as the branch tribits-tutorial-190. That gets rid of the intermediate merge commits, etc. I tried to build the document and it failed:

$ cd TriBITS/
$ cd tribits/doc/tribits_tutorial/

$ ./generate-tutorial.sh
Generating HTML and PDF files ...
This is pdfTeXk, Version 3.141592-1.40.3 (Web2C 7.5.6)
 %&-line parsing enabled.
entering extended mode
! I can't find file `../TribitsTutorialHelloWorld_0.tex'.
<*> ../TribitsTutorialHelloWorld_0.tex
                                      
(Press Enter to retry, or Control-D to exit)
Please type another input file name:

I updated the script generate-tutorial.sh to fix the paths and got the documents to build.

bartlettroscoe added a commit that referenced this issue Jul 6, 2017
@bartlettroscoe
Ignore generated files from Latex (#190)
657a381
bartlettroscoe added a commit that referenced this issue Jul 6, 2017
@bartlettroscoe
Remove ../ to allow latex docs built in base dir (#190)
1186c31 
Now that the outputs are ignored, it is okay to build these docs in the base
directory.  (And that is standard latex practice.)
bartlettroscoe added a commit that referenced this issue Jul 21, 2017
@bartlettroscoe
Clean up TribitsHelloWorld some, allow TPL_ENABLE_MPI to be undefiend (…
2ac657e 
…#190)

I cleaned up TribitsHelloWorld/CMakeLists.txt to make it shorter and compare
better against RawHelloWorld/CMakeLists.txt.  I removed a lot of the comments.
These comments are better made in the more general documentation.

Hopefully this makes it easier to create simple starter TriBITS projects by.
not having so specify MPI as a TPL or hack setting TPL_ENABLE_MPI off.

I updated the test of TribitsHelloWorld to not set TPL_ENABLE_MPI and updated
TriBITS to set it to FALSE when it is not set already.
fryeguy52 added a commit that referenced this issue Aug 25, 2017
@fryeguy52
WIP - Tribits tutorial draft update (#190)
e37a3e6 
This is just an update to the tutorial it is not finished but I want
toback up what I have tot he remote
fryeguy52 added a commit that referenced this issue Aug 25, 2017
@fryeguy52
remove a configure output file that was accidentally included (#190)
bc161f7
@bartlettroscoe bartlettroscoe mentioned this issue Aug 3, 2018
Open
fryeguy52 pushed a commit that referenced this issue Aug 21, 2018
@bartlettroscoe @fryeguy52
Ignore generated files from Latex (#190)
5a43d35
fryeguy52 pushed a commit that referenced this issue Aug 21, 2018
@bartlettroscoe @fryeguy52
Remove ../ to allow latex docs built in base dir (#190)
278bb69 
Now that the outputs are ignored, it is okay to build these docs in the base
directory.  (And that is standard latex practice.)
fryeguy52 added a commit that referenced this issue Aug 21, 2018
@fryeguy52
WIP - Tribits tutorial draft update (#190)
63cfe39 
This is just an update to the tutorial it is not finished but I want
toback up what I have tot he remote
fryeguy52 added a commit that referenced this issue Aug 21, 2018
@fryeguy52
remove a configure output file that was accidentally included (#190)
73bd98c
fryeguy52 added a commit that referenced this issue Sep 12, 2018
@fryeguy52
Initial commit of the basic HelloWolrd tutorial (#190)
0e8e4bf 
* TribitsTutorialHelloWorld.rst has a nearly complete first draft
of a basic tutorial for TriBITS
* HelloWorldConfigure.output is a file I want to reference in the rst
* generate-tutorial.sh is a copy of the generate-*.py for the
developer's guide and has not been modified at all
fryeguy52 added a commit that referenced this issue Sep 12, 2018
@fryeguy52
Added content to the Tribits helllo world tutorial document (#190)
2a2a2eb
fryeguy52 added a commit that referenced this issue Sep 12, 2018
@fryeguy52
Initial latex format tutorial files (#190)
0938b58
bartlettroscoe added a commit that referenced this issue Sep 12, 2018
@bartlettroscoe
Merge pull request #267 from TriBITSPub/tribits-tutorial-190
c239049 
Tribits tutorial Issue #190
@fryeguy52 fryeguy52 mentioned this issue Sep 12, 2018
Merged
@bartlettroscoe
Copy link
Member Author

@fryeguy52, I just merged PR #267. Let's try to find someone willing to view this material. Otherwise, I will take a look a little later.

bartlettroscoe added a commit that referenced this issue Sep 18, 2018
@bartlettroscoe
Some starting cleanup tutorial (#190)
4f6f4c8 
Since this tutorial is in the tribits/doc/ directory, calling the
'tribits/doc/tribits_tutorial' is redundant.  Therefore, I changed the name to
'tribits/doc/tutorial'.

The driver script was trying to copy files to cupojoe.srn.sandia.gov.  Also,
it was removing output files automatically.  How can you debug problems if you
remove the output files?

Added README.md file to state that this is still in develpment and may not
build (I can't build it on my Linux machine).

This will need some refactoring to make this cleaner, more robust, and easier
to work with.
@bartlettroscoe bartlettroscoe moved this to ToDo in TriBITS Jun 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@fryeguy52 fryeguy52

Labels
component: documentation type: enhancement
Projects
TriBITS
Status: ToDo
Milestone
Improve documenation for TriBITS (Epic)
Development

No branches or pull requests
2 participants
@bartlettroscoe @fryeguy52