crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-28 06:05:58 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Add README to custom source example

Browse source
This commit is contained in:
Paul Romano 2020-03-19 07:07:32 -05:00
parent c3ffc2f417
commit 32f5fd8854
1 changed files with 14 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

14
examples/custom_source/README.md Normal file
View file

@ -0,0 +1,14 @@
# Building a Custom Source
To run this example, you first need to compile the custom source library, which
requires headers from OpenMC. A CMakeLists.txt file has been set up for you that
will search for OpenMC and build the custom library. To build the source
library, you can run:
mkdir build && cd build
OPENMC_ROOT=<path_to_openmc_install> cmake ..
make
After this, you can build the model by running `python build_xml.py`. In the XML
files that are created, you should see a reference to build/libsource.so, the
custom source library that was built by CMake.