Feature/openqxd

[chaoos]

• Adds interface openQxD <--> QUDA
• Adds capability for C* boundaries in 1,2 or 3 spatial directions
• Fixed CPU reordering
• Adds openQCD gamma matrix basis (and basis transformations)
• Adds order class for spinors
• Adds order class for clover field (U(1) clover field is transfered from openQxD)
• Adds order class for gauge field
• Changed all the comments in quda.h to C89 style comments
• Rebased on your current develop branch

[maddyscientist]

@Jenkins test this please

[maddyscientist]

Thanks for this contribution @chaoos. This looks like a great PR and it will be great to OpenQCD support plumbed into QUDA 😄

@mathiaswagner and I are traveling at the moment, so reviewing this will likely take longer than normal. In the meantime, can you fix the broken builds in the CI matrix? (click on the Details link next to the failed build, and you should be able to find the reason for the failure). Also, please add your name to the README under the list of contributors.

[havogt]

cscs-ci run

[chaoos]

@maddyscientist Could you trigger the pipeline again? Locally I fixed the problems. Thank you, Roman

[mathiaswagner]

@Jenkins test this please.

[chaoos]

Thank you for this PR, this is a great contribution to QUDA. I have done an initial visual review at this point, and left a bunch of comments. My only real concern of note is the demotion of the interface to being C89 instead of C99, but those concerns may be unwarranted.

Outside of those comments, somethings that will need to be done:

* [ ]  Apply clang-format (see [here](https://github.com/lattice/quda/wiki/Coding-Conventions-and-Style#coding-style-and-clang-format))

* [ ]  Create a wiki page of how to use OpenQ*D with QUDA, similar for example to what we have for [MILC}(https://github.com/lattice/quda/wiki/MILC-with-QUDA)

Is there any specific functionality that is added to QUDA that we should be adding to the internal tests?

Dear Kate,

I dealt with the two points:

• see commit https://github.com/lattice/quda/pull/1414/commits/568dd3734e4aa20b99e0e18bd1f7d344e5e5bb9a for the clang-formatting
• The page for the wiki is written, but I cannot commit it, permission issue. I attach the patch here openqxd.zip

Best, Roman

[maddyscientist]

Hi Roman,

I've added you to the lattice github group, so you should have permission to edit the wiki now (and push to branches in the lattice org).

Thx

[maddyscientist]

@Jenkins ok to test

[chaoos]

I was able to commit to the wiki, thanks for giving me access! The CI/CD also seems to be fixed.

[havogt]

cscs-ci run

[chaoos]

The C89 changes are of concern, since we will be embracing a C99 interface, e.g., use of bool.

Dear Kate,

• The C99 thing is ok from our side. Should I just revert all changes I made in quda.h regarding this?
• We are currently in the phase of documenting, so give me some days for this. Do you want more comments in the code (I think every function/method has a javadoc-decoration), or conceptual things in the wiki?
• Regarding testing of openqxd functionality; we have some testing on the side of openqxd. If you want to test this in this repo, then you need to clone and compile the openqxd repo and run the tests from there. We are working on making this repo public, but there is still some politics going on: that's not in my power.

[maddyscientist]

@chaoos apologies for the slow reply at my end. GTC and other travel got in the way.....

If you can revert the C99 -> C89 changes that would be great. It would also narrow the scope of the PR which would also be helpful.

Regarding documentation, the basic rule is that all new functions should have doxygen markup next to their declarations, together with overall conceptual documentation in the wiki. If you can write up the documentation to include cloning the openq*d and compiling the code to work with QUDA that would be great. Understood that the repo isn't public yet, and that's fine for now. Does that sound ok to you?