coderefinery/mma

Mixed Martial Arts: Interfacing Fortran, C, C++, and Python for Great Good!

mma's Issues

can coloring be added to shell blocks?

some shell blocks are difficult to read since they're long and terminal commands are mixed with long output. Some coloring would help, but I'm not sure if it's possible in markdown

add installation instructions for git

since git is used to clone some repos in CFFI part

We do not seem to mention Cython

It looks like we actually do not discuss Cython. @blindij should I discuss it in part two or will you have preparation and speaker time to talk about it in part 1?

problem with pybind11 and cmake

on macosx 10.11 I get a cmake error trying to compile with pybind11:
"""
Could not find a package configuration file provided by "pybind11" with any
of the following names:

pybind11Config.cmake
pybind11-config.cmake

Add the installation prefix of "pybind11" to CMAKE_PREFIX_PATH or set
"pybind11_DIR" to a directory containing one of the above files. If
"pybind11" provides a separate development package or SDK, be sure it has
been installed.
"""

More explicitly mark what is part of the lesson and what is bonus

Everything after the CFFI part is bonus.

unclear instructions on how to use conda environments

which environments should learners set up and use? when should they be activated and deactivated?

add "from cffi import FFI" to python code sample

maybe add "from cffi import FFI" to python code sample (the get_array_safe function), for clarity

tss_ext library in motivation episode seems to not match the example

Adjust teaching and exercise times in part 1 of the workshop

My feeling is that CMake part might take less time and that there may not be enough time in the overview part. But keep the times if they are correct.

In the motivation part replace Employee example with a more scientific example

I am creating few issues here so that we know what to improve. But feel free to postpone to after the workshop if there is not time @blindij.

Here we need an example that researchers can immediately relate to.

make appearance of terminal commands consistent

sometimes it looks like this:
(boost-example) [lynx@boost]$ mkdir -p boost/src

and sometimes like this:
mkdir -p cython/src

CFFI missing in the overview part

We should at least mention it and refer to later.

Better document required software

write pi with greek letter

in CFFI example

add alternatives to wget (curl, ...)

add installation instructions for swig

On a mac I installed swig via homebrew (into /usr/local/bin), but swig then links to libraries for the system /usr/bin/python, not the anaconda environment python

Compare compile-time and run-time dependencies of different frameworks

There are some `_bv` examples in the SWIG part which seem to have been replaced

CMake part: "We start with our now familiar C++ program"

This program is then actually not familiar at this point. I would also show an example that connects better to what was discussed earlier.

paste code into source files in consistent manner

sometimes "cat > source.file" is used, but sometimes it's recommended to use one's favorite editor

Motivation part ends with "Reference to book"

Looks like something is missing.

Check whether pi is correctly typeset

in CFFI part "import pi" inside pi/ folder imports the pi.py file

Motivate better our choices

For me:

PyBind11

• pros: simplicity, prototyping and testing of C++ code
• cons: only C++11

F2PY

• pros: direct link between Fortran and Python
• cons: restrictive and intrusive

Cython

• pros: very powerful
• cons: complexity

...

leave more steps as exercises

it's difficult to listen to an instructor perform steps (create directories, paste code into files, compiling etc) and have time to type on own laptop at the same time. The instructions are usually clear and could be left to the learners (using stickies as usual)