Add fastscapelib (C++) integration

CMakeLists.txt

@@ -231,6 +231,29 @@ if(ASPECT_WITH_FASTSCAPE)
 endif()
 
 
+# Fastscapelib (C++)
+set(ASPECT_WITH_FASTSCAPELIB OFF CACHE BOOL "Whether the user wants to compile ASPECT with the landscape evolution C++ code Fastscape(lib), or not.")
+message(STATUS "Using ASPECT_WITH_FASTSCAPELIB = '${ASPECT_WITH_FASTSCAPE}'")
+if(ASPECT_WITH_FASTSCAPELIB)
+  find_package(fastscapelib CONFIG)
+  if(${fastscapelib_FOUND})
+    set(FS_WITH_HEALPIX OFF CACHE BOOL "Turn off Fastscapelib support of Healpix grid" FORCE)
+    message(STATUS "Using ASPECT_WITH_FASTSCAPELIB = '${ASPECT_WITH_FASTSCAPELIB}'")
+    message(STATUS "  fastscapelib_INCLUDE_DIR: ${fastscapelib_INCLUDE_DIRS}")
+    message(STATUS "  fastscapelib_VERSION: ${fastscapelib_VERSION}")
+    # fastscapelib dependencies
+    find_package(xtensor REQUIRED)
+    message(STATUS "  xtensor_INCLUDE_DIR: ${xtensor_INCLUDE_DIRS}")
+    message(STATUS "  xtensor_VERSION: ${xtensor_VERSION}")
+  else()
+    message(STATUS "Fastscapelib not found. Disabling ASPECT_WITH_FASTSCAPELIB. You can specify a hint to your installation directory with fastscapelib_DIR.")
+    set(ASPECT_WITH_FASTSCAPELIB OFF CACHE BOOL "" FORCE)
+  endif()
+else()
+  message(STATUS "Using ASPECT_WITH_FASTSCAPELIB = 'OFF'")
+endif()
+
+
 # NetCDF (c including parallel)
 set(ASPECT_WITH_NETCDF ON CACHE BOOL "Check if the user wants to compile ASPECT with the NetCDF libraries.")
 
@@ -358,6 +381,7 @@ if(ASPECT_WITH_WORLD_BUILDER)
 endif()
 message(STATUS "")
 
+#include "datatypes.h"
 
 #
 # Other stuff about external tools and how we interact with the system:
@@ -882,6 +906,15 @@ if (FASTSCAPE)
   endforeach()
 endif()
 
+# Fastscapelib
+if (${fastscapelib_FOUND})
+  message(STATUS "Linking ASPECT against Fastscapelib (header-only)")
+  foreach(_T ${TARGET_EXECUTABLES})
+    target_include_directories(${_T} PRIVATE ${fastscapelib_INCLUDE_DIRS})
+    target_include_directories(${_T} PRIVATE ${xtensor_INCLUDE_DIRS})
+  endforeach()
+endif()
+
 # NetCDF
 if(${NETCDF_FOUND})
   message(STATUS "Linking ASPECT against NetCDF")

WITH_FASTSCAPELIB.md

@@ -0,0 +1,117 @@
+# Using Aspect with Fastscapelib (C++)
+
+## Install Fastscapelib using conda
+
+You can use conda to install fastscapelib and all of its dependencies (we assume
+that you are familiar with managing conda environments):
+
+```
+conda install fastscapelib -c conda-forge
+```
+
+## Install Fastscapelib from source
+
+You can follow the steps below to install Fastscapelib and its dependencies from
+source.
+
+### Set the installation prefix path for Fastscapelib and its dependencies
+
+Choose a common location where you want to download the source files of
+Fastscapelib and its dependencies:
+
+```
+$ export FS_SOURCE_PATH=/path/to/fastscapelib/source
+```
+
+Choose a common location where you want to install Fastscapelib and its
+dependencies:
+
+```
+export CMAKE_INSTALL_PREFIX=/path/to/fastscapelib/install/dir
+```
+
+### Install xtl and xtensor
+
+Download the `xtl` git repository and checkout the last stable version:
+
+```
+$ cd $FS_SOURCE_PATH
+$ git clone https://github.com/xtensor-stack/xtl
+$ cd xtl
+$ git checkout 0.7.7 
+```
+
+Build and install `xtl`:
+
+```
+$ cmake -S. -Bbuild
+$ cmake --install build
+```
+
+Download the `xtensor` git repository and checkout the last stable version:
+
+```
+$ cd $FS_SOURCE_PATH
+$ git clone https://github.com/xtensor-stack/xtensor
+$ cd xtensor
+$ git checkout 0.25.0 
+```
+
+Build and install `xtensor`:
+
+```
+$ cmake -S. -Bbuild
+$ cmake --install build
+```
+
+### Install Fastscapelib
+
+Download the `fastscapelib` git repository and checkout the last stable version:
+
+```
+$ cd $FS_SOURCE_PATH
+$ git clone https://github.com/fastscape-lem/fastscapelib
+$ cd fastscapelib
+$ git checkout v0.2.2
+```
+
+IMPORTANT: edit the `cmake/fastscapelibConfig.cmake` file with the editor of
+your choice and add the following line just below `@PACKAGE_INIT@` (this will be
+required every time you checkout another version or branch and re-install
+Fastscapelib, but this won't be required for Fastscapelib version >0.2.2):
+
+```
+include(CMakeFindDependencyMacro)
+```
+
+Build and install `fastscapelib`:
+
+```
+$ cmake -S. -Bbuild
+$ cmake --install build
+```
+
+## Compile Aspect with Fastscapelib enabled
+
+If you have installed Fastscapelib using conda, don't forget to activate the
+environment where you have installed Fastscapelib. Once activated, configuring
+`aspect` with CMake should then find Fastscapelib automatically.
+
+If you have installed Fastscapelib from source like described above, you can
+help CMake find the Fastscapelib installation path using:
+
+```
+export CMAKE_PREFIX_PATH=/path/to/fastscapelib/install/dir
+```
+
+where the given path corresponds to the path that you set during installation
+via the `CMAKE_INSTALL_PREFIX` environment variable (see instructions above).
+
+Configuring `aspect` should then find Fastscapelib. Check the output of the
+following command run from aspect's source root directory (note: you might need
+to set additional arguments or run extra commands in order to find the other
+dependencies of `aspect`, we skipped it here):
+
+```
+cmake -S. -Bbuild -DASPECT_WITH_FASTSCAPELIB=ON
+```

contrib/fastscape/fastscape_rewrite_VTK_with_time.py

@@ -33,7 +33,7 @@ def get_times_pvd(filename):
 
         times[i] = float(temp_str)
 
-    return times 
+    return times
 
 
 #%% Get file paths (absolute, not relative paths!)
@@ -54,73 +54,73 @@ def absoluteFilePaths(directory):
 
 # trace generated using paraview version 5.8.0
 #
-# To ensure correct image size when batch processing, please search 
+# To ensure correct image size when batch processing, please search
 # for and uncomment the line `# renderView*.ViewSize = [*,*]`
 
 for File in FileNames:
 
     #### disable automatic camera reset on 'Show'
     paraview.simple._DisableFirstRenderCameraReset()
-    
+
     # create a new 'Legacy VTK Reader'
     topography0000 = LegacyVTKReader(FileNames=File)
-    
+
     # get animation scene
     animationScene1 = GetAnimationScene()
-    
+
     # get the time-keeper
     timeKeeper1 = GetTimeKeeper()
-    
+
     # update animation scene based on data timesteps
     animationScene1.UpdateAnimationUsingDataTimeSteps()
-    
+
     # get active view
     renderView1 = GetActiveViewOrCreate('RenderView')
     # uncomment following to set a specific view size
     # renderView1.ViewSize = [882, 554]
-    
+
     # get layout
     layout1 = GetLayout()
-    
+
     # show data in view
     topography0000Display = Show(topography0000, renderView1, 'StructuredGridRepresentation')
-    
+
     # trace defaults for the display properties.
     topography0000Display.Representation = 'Surface'
-    
+
     # reset view to fit data
     renderView1.ResetCamera()
-    
+
     # get the material library
     materialLibrary1 = GetMaterialLibrary()
-    
+
     # show color bar/color legend
     topography0000Display.SetScalarBarVisibility(renderView1, True)
-    
+
     # update the view to ensure updated data information
     renderView1.Update()
-    
+
     # get color transfer function/color map for 'H'
     hLUT = GetColorTransferFunction('H')
-    
+
     # get opacity transfer function/opacity map for 'H'
     hPWF = GetOpacityTransferFunction('H')
-    
+
     # save data
     SaveData(File[:-4] + '.vts', proxy=topography0000, ChooseArraysToWrite=1,
         PointDataArrays=['HHHHH','basement','catchment','drainage_area','erosion_rate','topography','total_erosion'])
-    
+
     #### saving camera placements for all active views
-    
+
     # current camera placement for renderView1
     renderView1.CameraPosition = [225625.0, 25625.0, 878497.0779980461]
     renderView1.CameraFocalPoint = [225625.0, 25625.0, 1135.7277145385742]
     renderView1.CameraParallelScale = 227077.82689023562
-    
+
     #### uncomment the following to render all views
     # RenderAllViews()
     # alternatively, if you want to write images, you can use SaveScreenshot(...).
-    
+
     Delete(topography0000)
     del topography0000
 
@@ -140,17 +140,9 @@ def absoluteFilePaths(directory):
 
 for n, File in enumerate(FileNames):
     dataset_attributes = {"timestep": str(times[n]), "group": "", "group": "", "file": os.path.basename(File)[:-4]+'.vts'}
-    
+
     ET.SubElement(doc, "DataSet", attrib=dataset_attributes).text="\n"
 
 
 tree = ET.ElementTree(root)
-tree.write('./VTK/topography.pvd', xml_declaration=True, encoding='utf-8', method="xml")   
-
-
-
-
-
-
-
-
+tree.write('./VTK/topography.pvd', xml_declaration=True, encoding='utf-8', method="xml")