Clone wiki

KROME / Home

Welcome to the KROME's documentation

This guide contains useful information on "how to" use the KROME's options and build your own chemical framework.

KROME is a nice and friendly package to include chemistry and microphysics in a wide range of astrophysical numerical models.
Given a chemical network (in a CSV-like format) and a series of physical processes (cooling, heating, dust) it automatically generates all the FORTRAN routines needed to solve the time-dependent evolution (chemical and thermal) of the system.
It provides different options which make it unique and flexible. 
The present user-guide is aimed at explaining the main features of the package.
Any suggestions and comments are welcomed.
KROME is an open-source package, GNU-licensed, and any improvement or comment provided by the users is welcomed.

"The job's not over until the paperwork's done" (Anonymous)

To search in the wiki use this page (beta).

We give support also on SLACK: send an email to krome@kromepackage.org to receive an invitation.

1. Getting started

  1. Prerequisities
  2. Getting started with KROME
  3. Makefile

2. Basic operations with different modules

  1. Prepare a chemical network
  2. How to run KROME
  3. Include KROME into your code
  4. Adding thermal processes (cooling/heating)
  5. Add a custom cooling function from the network file
  6. Photochemistry, photoheating, and opacity
  7. List of photochemistry user functions
  8. Dust bins (and solver-friendly freeze-out)
  9. Some caveats with hydrocodes (consistent advection and adiabatic index)

3. KROME options

  1. ALL OPTIONS
  2. Solver related options
  3. Thermal and dust evolution related options
  4. Additional options
  5. The krome_user module

4. Patches

  1. Enzo
  2. Flash
  3. Ramses
  4. Gizmo

5. Something about physics

  1. Cooling processes (Multi-level cooling)
  2. Adiabatic index
  3. X-rays physics

6. Additional features

  1. KIDA->KROME converter
  2. Network check
  3. Network with Graphviz
  4. Thread safety and OpenMP
  5. C and Python interfaces
  6. Consistent advection of species
  7. Automatic HTML documentation, aka DOCMAKE
  8. Time-dependent network explorer (prototype)

7. Be part of the community

  1. KROME & Bitbucket
  2. Developer, Stable, and Tested version
  3. Participate to the development of KROME

Updated