Sign in

v1

latestOpenAPI 3.0.02026-07-147042.6 KB
parma

The ambient dose equivalent rate calculated for a single particle type, or accumulated over all particle types.

The ambient dose equivalent, H*(10), is an operational quantity that simulates the human body by measuring the dose equivalent at a depth of 10 mm within a tissue equivalent sphere of 300 mm diameter. It is a measurable quantity that is used to calibrate area monitors (radiation detectors) for mixed radiation fields. Use this endpoint if you are comparing model predictions to measurements.

get/parma/ambient_dose

Query parameters

altitudenumber
Example:11

Altitude (in km). The minimum is 0 m, the maximum is 47 km (the upper limit of the stratosphere).

atmospheric_depthnumber
Example:0.92

Atmospheric depth from the top of the atmosphere (in units of g/cm2). The minimum is 0.913 g/cm2, the maximum is 1032.66 g/cm2. WARNING: you can specify either altitude OR atmospheric depth, not both.

latitudenumber required
Example:30

Latitude. -90 (S) to 90 (N).

longitudenumber required
Example:30

Longitude. -180 (W) to 180 (E).

yearinteger required
Example:2019

Year in YYYY.

monthinteger required
Example:12

Month in MM.

dayinteger required
Example:1

Day in DD.

particle'total' | 'e-' | 'e+' | 'mu+' | 'mu-' | 'gamma' | 'neutron' | 'proton' | 'alpha' required
Example:proton

The particle type as a string. Specifying 'total', only used for the dose calculation, returns the dose for all particle types.

Response

Successful dose read operation

Example response

{
  "dose rate": {
    "units": "uSv/hr",
    "value": 0.26835067168474125
  }
}