# Changes
- Bump ABI to v0.1.1
- Add `arb_mechanism` to bundle `type` and `interface`s
- Adjust `generate_catalogue` and `build_catalogue`
- Return `nullptr` for GPU interfaces if not enabled

# Open Questions
- How to tell CMake not to link against `libarbor.a` and only use headers?
- ~~How to get around `#ifdef ARB_GPU_ENABLED`~~ Update: just embrace it.

# Linked Issues
Fixes #1834 

Exports all symbols so arbor can be compiled as set of shared libraries. 

In order to export all symbols correctly, one macro per library and one global macro are added. The content of the macros is determined at configure time depending on build variant (static/shared), compiler, and platforms (linux, mac os) and goes into the library's include directory as `export.hpp` when installed (at build time it resides at cmake's temporary build directory). The per-library macro is named `ARB_LIBNAME_API` and goes in front of to-be-exported symbols. The global macro is `ARB_SYMBOL_VISIBLE`. 

This PR adds the annotation in all of the places where it is required. Most of them are in the public headers (and corresponding sources) but some are also added in internal headers, which were required for the unit tests to link properly.

Fixes #1752

* Consolidate default_concurrency, default_gpu functionality into arborenv/default_env.hpp, .cpp.
* Add new arborenv function `default_allocation()` that uses environment variables ARBENV_NUM_THREADS and ARBENV_GPU_ID to create an `arb::proc_allocation`, with a fallback to `thread_concurrency()`.
* Use arborenv-specific exceptions instead of generic std::runtime_error etc.
* Update examples, docs to suit.

Fixes #988 (except for reworking all the unit tests!)

* Use structured bindings where noted (there are likely other opportunities in the code).
* Use `if constexpr` to simplify some template-dispatched code.
* Remove `arb::uitl::get`, as it is no longer required now that util::variant is replaced.
* Add `_v` utility inline constexpr template values.

Part of the C++17 migration task #1022.

* Substitute `std::optional<T>` for `arb::util::optional<T>` for non-reference types T.
* Remove reference-deducing `util::value_by_key`; replace usages with new function `util::ptr_by_key`.
* Add some missing header includes that were required but included only transitively.
* Remove `operator<<` overload for optional in python/strprintf.hpp; replace with utility wrapper class that catches `std::optional<T>`.
* Wrap some `std::optional` values with `to_string` in ostream output in python lib.

Fixes #1154.

* Update CMake CXX version.
* Make CUDA 10 a minimum requirement and remove CUDA 9 support code.
* Set up g++ Travis tests to use g++ 8.
* Explicitly set C++14 version for nvcc.
* Properly split cuda compilation, including in unit tests.
* Remove unnecessary modcc `SOLVE` warning.
* Update pybind11 module to tag v2.5.0
* Replace `util::size` and `util::data` with `std::` equivalents.

- Add option to compile Arbor for HIP/CUDA backend using Clang. 
- Add new CMake option `ARB_GPU_COMPILE_TYPE` to distinguish between three possible gpu platforms/builds: `cuda-nvcc`; `cuda-clang`; `hip-clang`
- Add gpu wrapper functions in `arbor/backends/gpu/gpu_api.hpp` and `arborenv/gpu_api.hpp` which call HIP/CUDA functions depending on the platform
- Rename functions and files: cuda -> gpu
- Add downgraded warp primitives for HIP
- Implement `uuid` workaround for HIP
- Set correct alignment and warp size for AMD gpus
- Update installation guide and docs.
- Update pip/setuptools to support new gpu targets

Fixes #833

Update the installation guide to reflect the latest supported tool,
compiler and library versions.

Remove the Python docs, because they documented features that have not
been implemented yet. The Python docs can be added incrementally as
features are implemented.

Start work on oupdating the documenetation for hardware interfaces and
domain decomposition.

Sam Yates authored 6 years ago and Benjamin Cumming committed 6 years ago

Make a new installed library `libarborenv.a` covering a subset of the `sup` library functionality, with corresponding installed CMake target `arbor::arborenv`.

* Move NVML or CUDA 10 API decision for GPU UUID discovery to top level CMake.
* Move affinity, concurrency, MPI init guard, and gpu detection and negotiation functionality out of `sup` and into new library `arborenv`.
* Move `include/arbor` in project tree to `arbor/include/arbor` (for consistency across `sup`, `arbor`, and `arborenv` subdirectories.)
* Wrangle more explicit library dependency adding CMake code into the installed `arbor-config.cmake`, to help mitigate [CMake issue #18614](https://gitlab.kitware.com/cmake/cmake/issues/18614).
* Have `arborenv` code throw `std::runtime_exception` instead of `arb::arbor_error`. (We are still using `arb::mpi_error` though for a failure in `with_mpi`.)
* Move `scope_exit` into the `arb::util` namespace.
* Merge `affinity.hpp` into `concurrency.hpp`.
* Rename `gpu.hpp` to `gpu_env.hpp` in `arborenv` includes.

Fixes #647.