Skip to content

Commit

Permalink
remove individual unit tests from the README.md (#1637)
Browse files Browse the repository at this point in the history
the list is incomplete and we don't break out the subdirectories
for any of the other modules
  • Loading branch information
zingale authored Aug 28, 2024
1 parent b45e502 commit 651d299
Showing 1 changed file with 6 additions and 30 deletions.
36 changes: 6 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,36 +46,12 @@ There are several core types of microphysics routines hosted here:
* `screening/`: the screening routines for nuclear reactions. These
are called by the various networks

* `unit_test/`: code specific to unit tests within this repo. In
particular,
* `unit_test/`: a collection of unit tests that exercise the different
pieces of Microphysics

- `burn_cell` will do a single zone burn given (rho, T)
and a composition

- `burn_cell_sdc` will do a single zone burn in the simplified-SDC
framework.

- `test_eos` will test an equation of state by first calling it with
(rho, T), and then calling it with other inputs to recover rho
and/or T. A cube of data, with rho, T, and X is tested.

- `test_react` will call a reaction network on a cube of
data (rho, T, X).

- `test_rhs` will evaluate the right-hand-side of a network
without integrating it.

- `test_sdc` tests integration using the set of variables for
simplified-SDC.

- `test_jac` evaluates the Jacobian for comparison between the
analytical and numerical Jacobians.

- `test_screening` evaluates the screening routines.

* `util`: linear algebra routines for the integrators
(specifically a linear system solver from LINPACK),
other math routines, and build scripts
* `util`: linear algebra routines for the integrators (specifically a
linear system solver from LINPACK), the hybrid Powell solver, other
math routines, and build scripts


# AMReX-Astro Codes
Expand All @@ -88,7 +64,7 @@ the AMReX-Astro codes, Maestro and Castro.
* MAESTROeX: http://amrex-astro.github.io/MAESTROeX/

* Quokka: https://quokka-astro.github.io/quokka/

To use this repository with AMReX codes, set `MICROPHYSICS_HOME` to
point to the `Microphysics/` directory.

Expand Down

0 comments on commit 651d299

Please sign in to comment.