Language-specific API examples

[trevorhardy]

I’ve been thinking today about how we can better advertise the Pythonic (and the other) APIs and here’s what I propose:

1. To the extent that we have budget, we re-implement the User Guide examples (or a subset) using the most language-specific API we have. These would still be stored in the HELICS-examples repo alongside the all other implementations. We could like to them individually from the User Guide but any inline code snippets we show would be from the Python-C interface.

   Though this sounds like a lot of work, most of the examples are very similar to each other and don’t require huge amounts of rework (especially since whoever is doing this will have the working Python-C examples to work from).

2. As an alternative, lower effort approach, we could define a super-example that utilizes as large a feature set as possible and implement that example in each of the APIs. We could write some supporting content in the User Guide and link to those files.

As things sit right now, we have the following unique APIs to demonstrate:

• C++
• C++98
• C
• Python
• Nim
• MATLAB (very soon, I’m hoping)
• Julia

Any thoughts, particularly from @phlptp and/or @kdheepak ?

[trevorhardy]

Discussion never caught on here so I'm going to end this discussion.