Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix wrong remark for radiance/transmittanceSpectrum, clarify, typos #43

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Fix wrong remark for radiance/transmittanceSpectrum, clarify, typos #43

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5e2e9a4
fix error in help which confuses radiance and transmittance (and the …
berthubert Aug 7, 2023
917519a
clarify that fetch() does not look at your table name to pick the rig…
berthubert Aug 7, 2023
726ded8
fix some typos
berthubert Aug 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions hapi/hapi.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4117,7 +4117,7 @@ def print_data_tutorial():
HITRAN molecule-isotopologue notation, T - definition of temperature
range.

Usecase 1: temperatuer is defined by a list:
Usecase 1: temperature is defined by a list:
>>> Q = partitionSum(1,1,[70,80,90])

Usecase 2: temperature is defined by bounds and the step:
Expand Down Expand Up @@ -4171,6 +4171,9 @@ def print_data_tutorial():
# get data on CO2 main isotopologue in the range 2000-2100 cm-1
>>> fetch('CO2',2,1,2000,2100)

Note that CO2 was selected as molecule number 2, isotopologue 1. The table
name 'CO2' is arbitrary and does not select a specific molecule.

OK, now we're ready to run a fast example of how to calculate an
absorption coefficient cross section:

Expand Down Expand Up @@ -4279,7 +4282,7 @@ def print_data_tutorial():

This is the name of broadening parameter to consider a "Lorentzian"
part in the Voigt profile. In the current 160-char format there is
a choise between "gamma_air" and "gamma_self".
a choice between "gamma_air" and "gamma_self".
NOTE: If the table has custom columns with a broadening coefficients,
the user can specify the name of this column in GammaL. This
would let the function calculate an absorption with custom
Expand All @@ -4288,7 +4291,7 @@ def print_data_tutorial():
HITRAN_units: (optional parameter)

Logical flag for units, in which the absorption coefficient shoould be
calculated. Currently, the choises are: cm^2/molec (if True) and
calculated. Currently, the choices are: cm^2/molec (if True) and
cm-1 (if False).
NOTE: to calculate other spectral functions like transmitance,
radiance and absorption spectra, user should set HITRAN_units to False.
Expand Down Expand Up @@ -4350,7 +4353,7 @@ def print_data_tutorial():
This parameter is a bit specific for each of functions:
For absorptionSpectrum() and transmittanceSpectrum() the default
value is as follows: Environment={'l': 100.0}
For transmittanceSpectrum() the default value, besides path length,
For radianceSpectrum() the default value, besides path length,
contains a temperature: Environment={'T': 296.0, 'l': 100.0}
NOTE: temperature must be equal to that which was used in
absorptionCoefficient_ routine!
Expand Down Expand Up @@ -4436,7 +4439,7 @@ def print_data_tutorial():
1) Quality of a convolution depends on many things: quality of calculated
spectra, width of AF_wing and WavenumberRange, Resolution, WavenumberStep etc ...
Most of these factors are taken from previus stages of spectral calculation.
Right choise of all these factors is crucial for the correct computation.
Right choice of all these factors is crucial for the correct computation.
2) Dispersion, Diffraction and Michelson AF's don't work well in narrow
wavenumber range because of their broad wings.
3) Generally one must consider WavenumberRange and AF_wing as wide as possible.
Expand Down Expand Up @@ -35356,7 +35359,7 @@ def getDefaultValuesForXsect(Components,SourceTables,Environment,OmegaRange,
Calculate absorption coefficient using {profile}.
Absorption coefficient is calculated at arbitrary temperature and pressure.
User can vary a wide range of parameters to control a process of calculation.
The choise of these parameters depends on properties of a particular linelist.
The choice of these parameters depends on properties of a particular linelist.
Default values are a sort of guess which gives a decent precision (on average)
for a reasonable amount of cpu time. To increase calculation accuracy,
user should use a trial and error method.
Expand Down