Skip to content

Commit

Permalink
Add more info to README
Browse files Browse the repository at this point in the history
  • Loading branch information
mirenradia committed Apr 25, 2022
1 parent 7250df5 commit fa7d634
Showing 1 changed file with 20 additions and 3 deletions.
23 changes: 20 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,24 @@
# paraview-build
A repository with a GitHub action to build and package
A repository with a GitHub action to build and package[^1]
[ParaView](https://github.com/Kitware/ParaView) using the
[Superbuild](https://gitlab.kitware.com/paraview/paraview-superbuild)
with the following options:
[Superbuild](https://gitlab.kitware.com/paraview/paraview-superbuild) on the
Ubuntu 20.04 GitHub action runners.

The build is/will be used in the GitHub action which tests the [ParaView
Catalyst](https://www.paraview.org/in-situ/) instrumentation in GRChombo. It is
built against the Ubuntu 20.04 system libraries so is unlikely to work on other
Linux distributions with different library/package versions.

The build has the following features:
* Catalyst Rendering edition
* OSMesa rendering
* Python 3 support
* MPI
* LLVM support
* Release build with debugging info

[^1]: Note that as the Superbuild `cpack` targets do not currently include the
paraview-config script which is required for building GRChombo with ParaView
Catalyst in-situ support, the packaging in this action is rudimentary and just
makes a tarball from the relevant build directory. This is another reason why
the builds in this repository are even less likely to be portable.

0 comments on commit fa7d634

Please sign in to comment.