Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

Update/documentation #69

Merged
merged 39 commits into from

3 participants

Gihan R. Mudalige Florian Rathgeber Istvan Reguly
Gihan R. Mudalige

I have attempted to get most of the documentation up to date with this branch. The user documentation and distributed memory developer documentation have been updated with the latest features of the OP2 API and library.

I have also added the airfoil documentation that was previously only made available on the OP2 website.

The developer doc is the one that is less up to date, given the extensive changes done to the CUDA back-end and code generator.

If every one can go through these documents and raise any issues, it would really help to continue the maintenance of OP2. This will be particularly important as we are looking forward to integrating OP2 into the production line at RR.

gihanmudalige and others added some commits
Gihan R. Mudalige gihanmudalige Updating readme file 3735661
Gihan R. Mudalige gihanmudalige setting up .gitignore correctly 7e61457
Gihan R. Mudalige gihanmudalige Minor modifications to the ignored directories d0af211
Gihan R. Mudalige gihanmudalige Further additions to .gitignore 5161ab1
Gihan R. Mudalige gihanmudalige Minor changes 489d32e
Gihan R. Mudalige gihanmudalige Adding a table of contents to the user doc 1ee5444
Gihan R. Mudalige gihanmudalige formatting 47ff59c
Gihan R. Mudalige gihanmudalige Further formatting 15bc5fd
Gihan R. Mudalige gihanmudalige Noted about gen_seq in documentation -- needs to be updated further a…
…fter the vectorization branch is mearged
32933c0
Gihan R. Mudalige gihanmudalige Adding airfoil README and build documentation ef4b0d1
Gihan R. Mudalige gihanmudalige changing READEME extension f289ea3
Gihan R. Mudalige gihanmudalige Adding details of Airfoil 3e266af
Gihan R. Mudalige gihanmudalige Cleaning up Airfoil and adding details to README 4141b41
Gihan R. Mudalige gihanmudalige Update to Cmake build as some airfoil versions were removed a491a4b
Istvan Reguly reguly Some update on simplified OpenMP and CUDA, plus AVX 976f808
Gihan R. Mudalige gihanmudalige Format update for airfoil doc 6fccff4
Gihan R. Mudalige gihanmudalige Changed code generation instructions from MATLAB to Python 96333ac
Gihan R. Mudalige gihanmudalige update README for airfoil with code validation details 99fa64d
Gihan R. Mudalige gihanmudalige Add compare bin utility for airfoil 9f3b38f
Gihan R. Mudalige gihanmudalige minor formatting e4041c1
Gihan R. Mudalige gihanmudalige Formatting 722050e
Gihan R. Mudalige gihanmudalige Adding figures for airfoil documentation 62b2970
Gihan R. Mudalige gihanmudalige shell script to make documentation 39e1557
Gihan R. Mudalige gihanmudalige Remove build of docs in c libs 20fe3b2
Gihan R. Mudalige gihanmudalige Minor formatting 0d19441
Gihan R. Mudalige gihanmudalige Updated user guide 9a50b39
Gihan R. Mudalige gihanmudalige Modifications for MPI-dev docs fcd9540
Gihan R. Mudalige gihanmudalige op_fetch_data_hdf5 further clarification to its functionality 9621341
Gihan R. Mudalige gihanmudalige Details on partial halo exchanges 8eb44ab
Gihan R. Mudalige gihanmudalige Adding documentation on fully hibrid execution, this is not included …
…yet in the user documentation as this feature is only supported by the fortran backend.
fe9aab6
Gihan R. Mudalige gihanmudalige Adding breif details on mesh renumbering 83f2a5d
Gihan R. Mudalige gihanmudalige Minor commit d062d7b
Gihan R. Mudalige gihanmudalige Airfoil doc restructured 5406e75
Gihan R. Mudalige gihanmudalige Corrected spelling and minor mistakes in mpi_dev fdd60ec
Gihan R. Mudalige gihanmudalige Update document format ecc2fe1
Florian Rathgeber kynan commented on the diff
apps/c/CMakeLists.txt
@@ -40,8 +40,8 @@ option(OP2_BUILD_ALL_AERO "Build all aero apps" ON)
set(OP2_AIRFOIL_APPS
airfoil/airfoil_plain
airfoil/airfoil_hdf5
- airfoil/airfoil_vector
- airfoil/airfoil_hdf5_vector
+ #airfoil/airfoil_vector
+ #airfoil/airfoil_hdf5_vector
Florian Rathgeber Owner
kynan added a note

Why are these commented?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Florian Rathgeber
Owner

It seems this pull request conflates a number of unrelated changes:

  1. Changes to the airfoil demo:
    • Why were the demos airfoil_hdf5_simple, airfoil_hdf5_vector and airfoil_vector removed?
  2. Documentation changes:
    • I don't think you want to commit the PDFs
    • I don't think you want to commit .sty files either
Gihan R. Mudalige

The only committed PDFs are figures.
The .sty files are needed to build the latex document. If there is another way to do this, please go ahead.

airfoil_simple was using simplified OpenMP But now we do this simplified version every where.
airfoil_hdf5_vector and airfoil_vector are versions with vector maps. I think there are test cases for this in Aero.
We will have a vectorised version of airfoil in a future pull request.

Florian Rathgeber
Owner

Sorry, my bad. I hadn't realised that the PDFs were images.

For the .sty files I would simply document that these latex packages are required and maybe also which Debian package they are part of (e.g. latex-xcolor for xcolor.sty).

I think I'm fine with removing those demos. I'd only have done that in a separate pull request.

Gihan R. Mudalige

Added documentation detailing dependencies for the .sty files while removing the .sty files.
This should enable us to merge this pull request. Let me know if there are further issues

Florian Rathgeber
Owner

I think this is fine overall. You could squash some of the commits e.g. all of those with small formatting changes.

Gihan R. Mudalige gihanmudalige merged commit 97f50f6 into from
Florian Rathgeber kynan deleted the branch
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Dec 12, 2013
  1. Gihan R. Mudalige

    Updating readme file

    gihanmudalige authored
  2. Gihan R. Mudalige
  3. Gihan R. Mudalige
  4. Gihan R. Mudalige
  5. Gihan R. Mudalige

    Minor changes

    gihanmudalige authored
  6. Gihan R. Mudalige
  7. Gihan R. Mudalige

    formatting

    gihanmudalige authored
  8. Gihan R. Mudalige

    Further formatting

    gihanmudalige authored
  9. Gihan R. Mudalige

    Noted about gen_seq in documentation -- needs to be updated further a…

    gihanmudalige authored
    …fter the vectorization branch is mearged
  10. Gihan R. Mudalige
  11. Gihan R. Mudalige
  12. Gihan R. Mudalige
  13. Gihan R. Mudalige
  14. Gihan R. Mudalige
  15. Istvan Reguly Gihan R. Mudalige

    Some update on simplified OpenMP and CUDA, plus AVX

    reguly authored gihanmudalige committed
  16. Gihan R. Mudalige
  17. Gihan R. Mudalige
  18. Gihan R. Mudalige
  19. Gihan R. Mudalige
  20. Gihan R. Mudalige

    minor formatting

    gihanmudalige authored
  21. Gihan R. Mudalige

    Formatting

    gihanmudalige authored
  22. Gihan R. Mudalige
  23. Gihan R. Mudalige
  24. Gihan R. Mudalige
  25. Gihan R. Mudalige

    Minor formatting

    gihanmudalige authored
  26. Gihan R. Mudalige

    Updated user guide

    gihanmudalige authored
  27. Gihan R. Mudalige
  28. Gihan R. Mudalige
  29. Gihan R. Mudalige
  30. Gihan R. Mudalige

    Adding documentation on fully hibrid execution, this is not included …

    gihanmudalige authored
    …yet in the user documentation as this feature is only supported by the fortran backend.
  31. Gihan R. Mudalige
  32. Gihan R. Mudalige

    Minor commit

    gihanmudalige authored
Commits on Dec 18, 2013
  1. Gihan R. Mudalige

    Airfoil doc restructured

    gihanmudalige authored
Commits on Dec 19, 2013
  1. Gihan R. Mudalige
Commits on Dec 20, 2013
  1. Gihan R. Mudalige

    Update document format

    gihanmudalige authored
Commits on Jan 2, 2014
  1. Gihan R. Mudalige
  2. Gihan R. Mudalige
  3. Gihan R. Mudalige
  4. Gihan R. Mudalige
Something went wrong with that request. Please try again.