Commit 7d6eff7849f1e878d8c50b7be530038779693602
1 parent
512b446c
Exists in
master
Updated the readme
Showing
1 changed file
with
4 additions
and
8 deletions
Show diff stats
README.md
| @@ -11,7 +11,7 @@ pip install matplotlib | @@ -11,7 +11,7 @@ pip install matplotlib | ||
| 11 | **radiation_fields.py** : | 11 | **radiation_fields.py** : |
| 12 | *Description* : | 12 | *Description* : |
| 13 | This program calculates the scaling factor of the radiation field G0 relative | 13 | This program calculates the scaling factor of the radiation field G0 relative |
| 14 | -to the data of an object or a set of objects radiating for given distances | 14 | +to the spectrum of an object or a set of objects radiating for given distances |
| 15 | A file containing my G0 values with the associated distance will then be created | 15 | A file containing my G0 values with the associated distance will then be created |
| 16 | 16 | ||
| 17 | *Input parameters* : | 17 | *Input parameters* : |
| @@ -35,8 +35,7 @@ the part of the program executed will be independent of them | @@ -35,8 +35,7 @@ the part of the program executed will be independent of them | ||
| 35 | 35 | ||
| 36 | **three_levels_model.py** : | 36 | **three_levels_model.py** : |
| 37 | *Description* : | 37 | *Description* : |
| 38 | -This program seeks to calculate how a neutral gas subjected to a radiation field | ||
| 39 | -is heated, involving PAHs in the ionization of the gas. The expressions used are based on the model with 3 energy levels of the molecule, going from the neutral molecule (charge state Z=0) to the dication (charge state Z=2) by ionization. | 38 | +This main program computes the photoelectric heating rate and efficiency by PAHs. The expressions used are based on the model with 4 charge states of the molecule, going from the anion molecule (charge state Z=-1) to the dication (charge state Z=2) by ionization. |
| 40 | 39 | ||
| 41 | *Input parameters* : | 40 | *Input parameters* : |
| 42 | filename : str, | 41 | filename : str, |
| @@ -56,12 +55,9 @@ is heated, involving PAHs in the ionization of the gas. The expressions used are | @@ -56,12 +55,9 @@ is heated, involving PAHs in the ionization of the gas. The expressions used are | ||
| 56 | ISRF : bool, | 55 | ISRF : bool, |
| 57 | Interstellar Radiation Field; if true, then the filename is a file for ISRF | 56 | Interstellar Radiation Field; if true, then the filename is a file for ISRF |
| 58 | if false, the radiation field of a star is studied (default: False) | 57 | if false, the radiation field of a star is studied (default: False) |
| 59 | - | ||
| 60 | -**four_levels_model.py** : | ||
| 61 | -*Description* : | ||
| 62 | -This program does the same thing and has the same parameters as the program three_levels_model.py, the difference being that we add expressions related to the 4 energy levels model. This model consists in taking into account the anions, i.e. the PAHs in a charge state Z = -1. | 58 | + |
| 59 | + This program uses radiations_fields.py. | ||
| 63 | 60 | ||
| 64 | -These last two programs use the parameters returned by radiations_fields.py in its calculations | ||
| 65 | 61 | ||
| 66 | ## Useful files | 62 | ## Useful files |
| 67 | 63 |