diff --git a/README.md b/README.md index d4d1d48a2db75899467ba4d773dbb6ab0a88ce1c..65aa4d19b947b863a10eea8a58a0feb6ba655743 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,21 @@ -Open R-matrix (ORM) -============================ +Direct CAPture (DCAP) +===================== -This an implementation of R-matrix theory as summarized by [Lane and Thomas][LT]. -The emphasis of this implementation is on beta- and gamma decay experiments. - -ORM provides the following capabilities: - + A commandline interface - + A library for performing R-matrix calculations - + An open code structure that encourages extension - + Fast routines for calculating the penetrability and shift function. See [this note][Approx]. - + Accurate calculations of the penetrability and shift function using the Mitchel routines. - + Implementation for gamma-decays to unbound states. - + Extensive unit tests of all functionality +This is an implementation of the direct capture model of [Rolfs (1973)](res/rolfs1973.pdf) +for calculating capture cross sections in light nuclei. The various formulas and their +implementation are summarized in [this note](res/dcap_note.pdf). Structure -------------------------- The directory structure is -+ include/source contains the library code -+ test contains the unit tests of the library -+ bench contains benchmark code -+ runner contains the executable ++ [include](include/)/[source](source/) contain the library code ++ [test](test/) contains the unit tests of the library ++ [main.cpp](main.cpp) contains a usage example Installation -------------------------- -ORM depends on the following packages +DCAP depends on the following packages + CMake + GSL + readLine @@ -32,19 +23,19 @@ ORM depends on the following packages + ROOT + AUSAlib ([Install guide][AUSAguide]) + log-ft ([Repo][log-ft]) + + ORM ([Repo][ORM]) + + sim3a ([Repo][sim3a]) -Except for the last two packages, the remaining libraries should be available in your package manager. +Except for the last four packages, the remaining libraries should be available in your package manager. When you have installed these package, execute: ```bash -mkdir build -cd build -cmake <ORM-directory> -make +cmake ./ +make -jN ``` This will compile the library and executable -[LT]: https://doi.org/10.1103/RevModPhys.30.257 "A. M. Lane and R. G. Thomas, Rev. Mod. Phys. __30__ 257 (1958)" -[Approx]: https://wiki.kern.phys.au.dk/interpolation.pdf "Jonas Refsgaard, Efficient and accurate approximation of R-matrix functions" [AUSAguide]: https://git.kern.phys.au.dk/ausa/ausalib/wikis/Getting-AUSAlib "AUSAlib install guide" -[log-ft]: https://git.kern.phys.au.dk/Munken/log-ft "log-ft git repo" \ No newline at end of file +[log-ft]: https://git.kern.phys.au.dk/Munken/log-ft "log-ft git repo" +[ORM]: https://git.kern.phys.au.dk/Munken/ORM "ORM git repo" +[sim3a]: https://git.kern.phys.au.dk/ausa/sim3a "sim3a git repo" \ No newline at end of file diff --git a/res/dcap_notes.pdf b/res/dcap_notes.pdf new file mode 100644 index 0000000000000000000000000000000000000000..d31e2034e4ca32fcf43f4141f63f3b84f44db516 Binary files /dev/null and b/res/dcap_notes.pdf differ diff --git a/res/rolfs1973.pdf b/res/rolfs1973.pdf new file mode 100644 index 0000000000000000000000000000000000000000..0f6fc4b9961a007207e0b69d827c7ace5d1658e9 Binary files /dev/null and b/res/rolfs1973.pdf differ