aerobulk-python

A python wrapper for aerobulk (https://github.com/brodeau/aerobulk)

Installation

Due to the heavy dependencies in this package we recommend installing the package from conda-forge with mamba/conda

mamba install -c conda-forge aerobulk-python

or

conda install -c conda-forge aerobulk-python

aerobulk-python developer guide

These are the steps to install and develop the package locally

1. Set up a development environment.

   mamba create -n aerobulk-python-dev python=3.9 dask numpy gfortran xarray pytest ipython
   conda activate aerobulk-python-dev

2. Clone the repository

Make sure to clone the repo with --recursive to also pull the git submodule!

git clone --recursive git@github.com:xgcm/aerobulk-python.git

3. Compile/Install aerobulk-python (this has to be rerun after every change to the fortran code/wrapper/signature file) Run these commands from within the aerobulk-python folder.

   a. Use pip to install aerobulk locally (this will install the python package and compile).

   pip install -e .

   b. Manual version (you will have to install the python module separately)

   python -m numpy.f2py --verbose -c --f90flags="-fdefault-real-8 -ffree-line-length-200 --std=gnu" ./source/fortran/aerobulk/src/mod_const.f90 ./source/fortran/aerobulk/src/mod_phymbl.f90 ./source/fortran/aerobulk/src/mod_skin_coare.f90 ./source/fortran/aerobulk/src/mod_skin_ecmwf.f90 ./source/fortran/aerobulk/src/mod_blk_andreas.f90 ./source/fortran/aerobulk/src/mod_common_coare.f90 ./source/fortran/aerobulk/src/mod_blk_coare3p0.f90 ./source/fortran/aerobulk/src/mod_blk_coare3p6.f90 ./source/fortran/aerobulk/src/mod_blk_ecmwf.f90 ./source/fortran/aerobulk/src/mod_blk_ncar.f90 ./source/fortran/aerobulk/src/mod_blk_neutral_10m.f90 ./source/fortran/aerobulk/src/mod_aerobulk_compute.f90 ./source/fortran/aerobulk/src/mod_aerobulk.f90   ./source/fortran/mod_aerobulk_wrap_skin.f90 ./source/fortran/mod_aerobulk_wrap_skin.pyf

   and

   python -m numpy.f2py --verbose -c --f90flags="-fdefault-real-8 -ffree-line-length-200 --std=gnu" ./source/fortran/aerobulk/src/mod_const.f90 ./source/fortran/aerobulk/src/mod_phymbl.f90 ./source/fortran/aerobulk/src/mod_skin_coare.f90 ./source/fortran/aerobulk/src/mod_skin_ecmwf.f90 ./source/fortran/aerobulk/src/mod_blk_andreas.f90 ./source/fortran/aerobulk/src/mod_common_coare.f90 ./source/fortran/aerobulk/src/mod_blk_coare3p0.f90 ./source/fortran/aerobulk/src/mod_blk_coare3p6.f90 ./source/fortran/aerobulk/src/mod_blk_ecmwf.f90 ./source/fortran/aerobulk/src/mod_blk_ncar.f90 ./source/fortran/aerobulk/src/mod_blk_neutral_10m.f90 ./source/fortran/aerobulk/src/mod_aerobulk_compute.f90 ./source/fortran/aerobulk/src/mod_aerobulk.f90   ./source/fortran/mod_aerobulk_wrap_noskin.f90 ./source/fortran/mod_aerobulk_wrap_noskin.pyf

4. Make sure things work

   pytest tests/test_fortran.py

   🎉

Local Aerobulk compilation guide

Assumes that you have an environment with a gfortran compiler set up, have aerobulk cloned and that you are in the root aerobulk (not aerobulk-python) directory.

1. Build the aerobulk source

First copy the appropriate macro file to the source directory:

cp arch/make.macro_GnuLinux make.macro

those of us on mac needed to edit make.macro make this change

# These are needed for the C/C++ interface
- FF += -std=gnu -lstdc++
+ FF += -std=gnu

Then you should be able to run make

This will build:

• Object files src/*.o
• Mode files mod/*.mod
• Library file lib/libaerobulk.a
• Binary executables bin/*x

I was able to run one of the binaries with bin/example_call_aerobulk.x