Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@olemke
olemke committed Jul 6, 2023
1 parent 5716cad commit aa216c3
Show file tree
Hide file tree
Showing 8,879 changed files with 971,624 additions and 320,339 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
2 changes: 1 addition & 1 deletion docserver/agendas.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ <h2>Agendas</h2>
</div>
</table>
</div>
<div class="footer">Page generated by arts-2.5.11 (git: 6827797f)</div>
<div class="footer">Page generated by arts-2.5.11 (git: 82a799d5)</div>

</body>
</html>
4 changes: 2 additions & 2 deletions docserver/agendas/dobatch_calc_agenda.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ <h2>Agenda dobatch_calc_agenda</h2>
<pre>
Calculations to perform for each batch case.

See further <a href="../methods/DOBatchCalc.html">DOBatchCalc</a>.
See also: <a href="../methods/DOBatchCalc.html">DOBatchCalc</a>

</pre>

Expand Down Expand Up @@ -79,7 +79,7 @@ <h3>Agendas that require dobatch_calc_agenda</h3>

</ul>
</div>
<div class="footer">Page generated by arts-2.5.11 (git: 6827797f)</div>
<div class="footer">Page generated by arts-2.5.11 (git: 82a799d5)</div>

</body>
</html>
14 changes: 7 additions & 7 deletions docserver/agendas/doit_conv_test_agenda.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ <h2>Agenda doit_conv_test_agenda</h2>
which are to be defined in this agenda.

Possible workspace methods are:
<a href="../methods/doit_conv_flagAbs.html">doit_conv_flagAbs</a>: Calculates the absolute differences
for each Stokes component separately.
<a href="../methods/doit_conv_flagAbsBT.html">doit_conv_flagAbsBT</a>: Same as above, but the convergence limit
can be specified in Kelvin BT (Rayleigh Jeans).
<a href="../methods/doit_conv_flagLsq.html">doit_conv_flagLsq</a>: Least square convergence test. Not recommended
because result can be inaccurate.
- <a href="../methods/doit_conv_flagAbs.html">doit_conv_flagAbs</a>: Calculates the absolute differences
for each Stokes component separately.
- <a href="../methods/doit_conv_flagAbsBT.html">doit_conv_flagAbsBT</a>: Same as above, but the convergence limit
can be specified in Kelvin BT (Rayleigh Jeans).
- <a href="../methods/doit_conv_flagLsq.html">doit_conv_flagLsq</a>: Least square convergence test. Not recommended
because result can be inaccurate.

</pre>

Expand Down Expand Up @@ -91,7 +91,7 @@ <h3>Agendas that require doit_conv_test_agenda</h3>

</ul>
</div>
<div class="footer">Page generated by arts-2.5.11 (git: 6827797f)</div>
<div class="footer">Page generated by arts-2.5.11 (git: 82a799d5)</div>

</body>
</html>
9 changes: 5 additions & 4 deletions docserver/agendas/doit_mono_agenda.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,14 @@ <h2>Agenda doit_mono_agenda</h2>
<pre>
Performs monochromatic DOIT calculation.
This agenda includes for example the following methods:
1. <a href="../methods/DoitScatteringDataPrepare.html">DoitScatteringDataPrepare</a>
2. <a href="../methods/cloudbox_field_monoIterate.html">cloudbox_field_monoIterate</a>

1. <a href="../methods/DoitScatteringDataPrepare.html">DoitScatteringDataPrepare</a>
2. <a href="../methods/cloudbox_field_monoIterate.html">cloudbox_field_monoIterate</a>

The result of the agenda is the radiation field inside the
cloudbox and on the cloudbox boundary, which can be used
as radiative background for a clearsky radiative transfer
calculation.
calculation.

See the Arts online documentation
for more information about the methods.
Expand Down Expand Up @@ -86,7 +87,7 @@ <h3>Agendas that require doit_mono_agenda</h3>

</ul>
</div>
<div class="footer">Page generated by arts-2.5.11 (git: 6827797f)</div>
<div class="footer">Page generated by arts-2.5.11 (git: 82a799d5)</div>

</body>
</html>
24 changes: 13 additions & 11 deletions docserver/agendas/doit_rte_agenda.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,21 +21,23 @@ <h2>Agenda doit_rte_agenda</h2>
This agenda is called repeatedly in each DOIT iteration.

Normally one should use
<a href="../methods/cloudbox_fieldUpdateSeq1D.html">cloudbox_fieldUpdateSeq1D</a> or <a href="../methods/cloudbox_fieldUpdateSeq3D.html">cloudbox_fieldUpdateSeq3D</a>:
Seqential update of the radiation field.
This method is the fastest and most accurate method.

- <a href="../methods/cloudbox_fieldUpdateSeq1D.html">cloudbox_fieldUpdateSeq1D</a> or <a href="../methods/cloudbox_fieldUpdateSeq3D.html">cloudbox_fieldUpdateSeq3D</a>:
Seqential update of the radiation field.
This method is the fastest and most accurate method.

A very similar method in plane parallel approximation is
<a href="../methods/cloudbox_fieldUpdateSeq1DPP.html">cloudbox_fieldUpdateSeq1DPP</a>:
This method also includes the sequential update and is slightly
faster than the above one. The drawback is that it is less
accurate, especially for limb geometries and large off-nadir
viewing angles.
- <a href="../methods/cloudbox_fieldUpdateSeq1DPP.html">cloudbox_fieldUpdateSeq1DPP</a>:
This method also includes the sequential update and is slightly
faster than the above one. The drawback is that it is less
accurate, especially for limb geometries and large off-nadir
viewing angles.

The following method was used before the sequential update
was invented. It is very slow and should therefore only
be used for test cases.
<a href="../methods/cloudbox_fieldUpdate1D.html">cloudbox_fieldUpdate1D</a>: Old method.
be used for test cases:

- <a href="../methods/cloudbox_fieldUpdate1D.html">cloudbox_fieldUpdate1D</a>: Old method.

</pre>

Expand Down Expand Up @@ -95,7 +97,7 @@ <h3>Agendas that require doit_rte_agenda</h3>

</ul>
</div>
<div class="footer">Page generated by arts-2.5.11 (git: 6827797f)</div>
<div class="footer">Page generated by arts-2.5.11 (git: 82a799d5)</div>

</body>
</html>
22 changes: 11 additions & 11 deletions docserver/agendas/doit_scat_field_agenda.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,17 @@ <h2>Agenda doit_scat_field_agenda</h2>
The following methods can be used for calculating the
scattering integral field:

<a href="../methods/doit_scat_fieldCalc.html">doit_scat_fieldCalc</a>: This method calculates the scattering
integral field by using the angular grids <a href="../variables/za_grid.html">za_grid</a>
and <a href="../variables/aa_grid.html">aa_grid</a>, which are also used in the update of the
radiation field (<a href="doit_rte_agenda.html">doit_rte_agenda</a>).
- <a href="../methods/doit_scat_fieldCalc.html">doit_scat_fieldCalc</a>: This method calculates the scattering
integral field by using the angular grids <a href="../variables/za_grid.html">za_grid</a>
and <a href="../variables/aa_grid.html">aa_grid</a>, which are also used in the update of the
radiation field (<a href="doit_rte_agenda.html">doit_rte_agenda</a>).

<a href="../methods/doit_scat_fieldCalcLimb.html">doit_scat_fieldCalcLimb</a>: This method calculates the scattering
integral field. The difference to the previous method is that
the data is interpolated on equidistant angular grids.
Especially for limb, where a very fine zenith angle grid
resolution is required for the RT transfer part, this method
is much faster than <a href="../methods/doit_scat_fieldCalc.html">doit_scat_fieldCalc</a>.
- <a href="../methods/doit_scat_fieldCalcLimb.html">doit_scat_fieldCalcLimb</a>: This method calculates the scattering
integral field. The difference to the previous method is that
the data is interpolated on equidistant angular grids.
Especially for limb, where a very fine zenith angle grid
resolution is required for the RT transfer part, this method
is much faster than <a href="../methods/doit_scat_fieldCalc.html">doit_scat_fieldCalc</a>.

</pre>

Expand Down Expand Up @@ -89,7 +89,7 @@ <h3>Agendas that require doit_scat_field_agenda</h3>

</ul>
</div>
<div class="footer">Page generated by arts-2.5.11 (git: 6827797f)</div>
<div class="footer">Page generated by arts-2.5.11 (git: 82a799d5)</div>

</body>
</html>
2 changes: 1 addition & 1 deletion docserver/agendas/forloop_agenda.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ <h3>Agendas that require forloop_agenda</h3>

</ul>
</div>
<div class="footer">Page generated by arts-2.5.11 (git: 6827797f)</div>
<div class="footer">Page generated by arts-2.5.11 (git: 82a799d5)</div>

</body>
</html>
2 changes: 1 addition & 1 deletion docserver/agendas/g0_agenda.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ <h3>Agendas that require g0_agenda</h3>

</ul>
</div>
<div class="footer">Page generated by arts-2.5.11 (git: 6827797f)</div>
<div class="footer">Page generated by arts-2.5.11 (git: 82a799d5)</div>

</body>
</html>
2 changes: 1 addition & 1 deletion docserver/agendas/gas_scattering_agenda.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ <h3>Agendas that require gas_scattering_agenda</h3>

</ul>
</div>
<div class="footer">Page generated by arts-2.5.11 (git: 6827797f)</div>
<div class="footer">Page generated by arts-2.5.11 (git: 82a799d5)</div>

</body>
</html>
2 changes: 1 addition & 1 deletion docserver/agendas/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ <h2>Agendas</h2>
</div>
</table>
</div>
<div class="footer">Page generated by arts-2.5.11 (git: 6827797f)</div>
<div class="footer">Page generated by arts-2.5.11 (git: 82a799d5)</div>

</body>
</html>
2 changes: 1 addition & 1 deletion docserver/agendas/inversion_iterate_agenda.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ <h3>Agendas that require inversion_iterate_agenda</h3>

</ul>
</div>
<div class="footer">Page generated by arts-2.5.11 (git: 6827797f)</div>
<div class="footer">Page generated by arts-2.5.11 (git: 82a799d5)</div>

</body>
</html>
2 changes: 1 addition & 1 deletion docserver/agendas/iy_cloudbox_agenda.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ <h3>Agendas that require iy_cloudbox_agenda</h3>

</ul>
</div>
<div class="footer">Page generated by arts-2.5.11 (git: 6827797f)</div>
<div class="footer">Page generated by arts-2.5.11 (git: 82a799d5)</div>

</body>
</html>
4 changes: 2 additions & 2 deletions docserver/agendas/iy_independent_beam_approx_agenda.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ <h3>Variables</h3>
<tr><td>IN</td><td class="right"><a href="../variables/iy_agenda_call1.html">iy_agenda_call1</a></td><td>(<a href="../groups/Index.html">Index</a>)</td><td>
Flag to handle recursive calls of <a href="iy_main_agenda.html">iy_main_agenda</a> The agenda <a href="iy_main_agenda.html">iy_main_agenda</a>
can be used recursively and this flag is used to tell the methods inside the
agenda which is the primary call.</td></tr>
agenda which is the primary call.</td></tr>
<tr><td>IN</td><td class="right"><a href="../variables/iy_unit.html">iy_unit</a></td><td>(<a href="../groups/String.html">String</a>)</td><td>
Selection of output unit for radiative transfer methods.</td></tr>
<tr><td>IN</td><td class="right"><a href="../variables/iy_transmittance.html">iy_transmittance</a></td><td>(<a href="../groups/Tensor3.html">Tensor3</a>)</td><td>
Expand Down Expand Up @@ -134,7 +134,7 @@ <h3>Agendas that require iy_independent_beam_approx_agenda</h3>

</ul>
</div>
<div class="footer">Page generated by arts-2.5.11 (git: 6827797f)</div>
<div class="footer">Page generated by arts-2.5.11 (git: 82a799d5)</div>

</body>
</html>
4 changes: 2 additions & 2 deletions docserver/agendas/iy_loop_freqs_agenda.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ <h3>Variables</h3>
<tr><td>IN</td><td class="right"><a href="../variables/iy_agenda_call1.html">iy_agenda_call1</a></td><td>(<a href="../groups/Index.html">Index</a>)</td><td>
Flag to handle recursive calls of <a href="iy_main_agenda.html">iy_main_agenda</a> The agenda <a href="iy_main_agenda.html">iy_main_agenda</a>
can be used recursively and this flag is used to tell the methods inside the
agenda which is the primary call.</td></tr>
agenda which is the primary call.</td></tr>
<tr><td>IN</td><td class="right"><a href="../variables/iy_transmittance.html">iy_transmittance</a></td><td>(<a href="../groups/Tensor3.html">Tensor3</a>)</td><td>
Transmittance to be included in <a href="../variables/iy.html">iy</a>.</td></tr>
<tr><td>IN</td><td class="right"><a href="../variables/iy_aux_vars.html">iy_aux_vars</a></td><td>(<a href="../groups/ArrayOfString.html">ArrayOfString</a>)</td><td>
Expand Down Expand Up @@ -100,7 +100,7 @@ <h3>Agendas that require iy_loop_freqs_agenda</h3>

</ul>
</div>
<div class="footer">Page generated by arts-2.5.11 (git: 6827797f)</div>
<div class="footer">Page generated by arts-2.5.11 (git: 82a799d5)</div>

</body>
</html>
4 changes: 2 additions & 2 deletions docserver/agendas/iy_main_agenda.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ <h3>Variables</h3>
<tr><td>IN</td><td class="right"><a href="../variables/iy_agenda_call1.html">iy_agenda_call1</a></td><td>(<a href="../groups/Index.html">Index</a>)</td><td>
Flag to handle recursive calls of <a href="iy_main_agenda.html">iy_main_agenda</a> The agenda <a href="iy_main_agenda.html">iy_main_agenda</a>
can be used recursively and this flag is used to tell the methods inside the
agenda which is the primary call.</td></tr>
agenda which is the primary call.</td></tr>
<tr><td>IN</td><td class="right"><a href="../variables/iy_transmittance.html">iy_transmittance</a></td><td>(<a href="../groups/Tensor3.html">Tensor3</a>)</td><td>
Transmittance to be included in <a href="../variables/iy.html">iy</a>.</td></tr>
<tr><td>IN</td><td class="right"><a href="../variables/iy_aux_vars.html">iy_aux_vars</a></td><td>(<a href="../groups/ArrayOfString.html">ArrayOfString</a>)</td><td>
Expand Down Expand Up @@ -133,7 +133,7 @@ <h3>Agendas that require iy_main_agenda</h3>

</ul>
</div>
<div class="footer">Page generated by arts-2.5.11 (git: 6827797f)</div>
<div class="footer">Page generated by arts-2.5.11 (git: 82a799d5)</div>

</body>
</html>
2 changes: 1 addition & 1 deletion docserver/agendas/iy_radar_agenda.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ <h3>Agendas that require iy_radar_agenda</h3>

</ul>
</div>
<div class="footer">Page generated by arts-2.5.11 (git: 6827797f)</div>
<div class="footer">Page generated by arts-2.5.11 (git: 82a799d5)</div>

</body>
</html>
2 changes: 1 addition & 1 deletion docserver/agendas/iy_space_agenda.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ <h3>Agendas that require iy_space_agenda</h3>

</ul>
</div>
<div class="footer">Page generated by arts-2.5.11 (git: 6827797f)</div>
<div class="footer">Page generated by arts-2.5.11 (git: 82a799d5)</div>

</body>
</html>
4 changes: 2 additions & 2 deletions docserver/agendas/iy_surface_agenda.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ <h3>Variables</h3>
<tr><td>IN</td><td class="right"><a href="../variables/jacobian_do.html">jacobian_do</a></td><td>(<a href="../groups/Index.html">Index</a>)</td><td>
Flag to activate (clear-sky) Jacobian calculations.</td></tr>
<tr><td>IN</td><td class="right"><a href="iy_main_agenda.html">iy_main_agenda</a></td><td>(<a href="../groups/Agenda.html">Agenda</a>)</td><td>
Agenda calculating the single monochromatic pencil beam spectrum.</td></tr>
Calculation of a single monochromatic pencil beam spectrum.</td></tr>
<tr><td>IN</td><td class="right"><a href="../variables/f_grid.html">f_grid</a></td><td>(<a href="../groups/Vector.html">Vector</a>)</td><td>
The frequency grid for monochromatic pencil beam calculations.</td></tr>
<tr><td>IN</td><td class="right"><a href="../variables/nlte_field.html">nlte_field</a></td><td>(<a href="../groups/EnergyLevelMap.html">EnergyLevelMap</a>)</td><td>
Expand Down Expand Up @@ -125,7 +125,7 @@ <h3>Agendas that require iy_surface_agenda</h3>

</ul>
</div>
<div class="footer">Page generated by arts-2.5.11 (git: 6827797f)</div>
<div class="footer">Page generated by arts-2.5.11 (git: 82a799d5)</div>

</body>
</html>
2 changes: 1 addition & 1 deletion docserver/agendas/jacobian_agenda.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ <h3>Agendas that require jacobian_agenda</h3>

</ul>
</div>
<div class="footer">Page generated by arts-2.5.11 (git: 6827797f)</div>
<div class="footer">Page generated by arts-2.5.11 (git: 82a799d5)</div>

</body>
</html>
2 changes: 1 addition & 1 deletion docserver/agendas/main_agenda.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ <h3>Agendas that require main_agenda</h3>

</ul>
</div>
<div class="footer">Page generated by arts-2.5.11 (git: 6827797f)</div>
<div class="footer">Page generated by arts-2.5.11 (git: 82a799d5)</div>

</body>
</html>
16 changes: 8 additions & 8 deletions docserver/agendas/met_profile_calc_agenda.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ <h2>Agenda met_profile_calc_agenda</h2>

This agenda can be, for example, set up like this:

<a href="../methods/AtmFieldsCalc.html">AtmFieldsCalc</a>
<a href="../methods/abs_lookupAdapt.html">abs_lookupAdapt</a>
<a href="../methods/DoitInit.html">DoitInit</a>
<a href="../methods/DoitGetIncoming.html">DoitGetIncoming</a>
<a href="../methods/cloudbox_fieldSetClearsky.html">cloudbox_fieldSetClearsky</a>
<a href="../methods/DoitCalc.html">DoitCalc</a>
<a href="../methods/yCalc.html">yCalc</a>
1. <a href="../methods/AtmFieldsCalc.html">AtmFieldsCalc</a>
2. <a href="../methods/abs_lookupAdapt.html">abs_lookupAdapt</a>
3. <a href="../methods/DoitInit.html">DoitInit</a>
4. <a href="../methods/DoitGetIncoming.html">DoitGetIncoming</a>
5. <a href="../methods/cloudbox_fieldSetClearsky.html">cloudbox_fieldSetClearsky</a>
6. <a href="../methods/DoitCalc.html">DoitCalc</a>
7. <a href="../methods/yCalc.html">yCalc</a>

</pre>

Expand Down Expand Up @@ -102,7 +102,7 @@ <h3>Agendas that require met_profile_calc_agenda</h3>

</ul>
</div>
<div class="footer">Page generated by arts-2.5.11 (git: 6827797f)</div>
<div class="footer">Page generated by arts-2.5.11 (git: 82a799d5)</div>

</body>
</html>
2 changes: 1 addition & 1 deletion docserver/agendas/pha_mat_spt_agenda.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ <h3>Agendas that require pha_mat_spt_agenda</h3>

</ul>
</div>
<div class="footer">Page generated by arts-2.5.11 (git: 6827797f)</div>
<div class="footer">Page generated by arts-2.5.11 (git: 82a799d5)</div>

</body>
</html>
2 changes: 1 addition & 1 deletion docserver/agendas/pnd_agenda_array.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ <h3>Agendas that require pnd_agenda_array</h3>

</ul>
</div>
<div class="footer">Page generated by arts-2.5.11 (git: 6827797f)</div>
<div class="footer">Page generated by arts-2.5.11 (git: 82a799d5)</div>

</body>
</html>
Loading

0 comments on commit aa216c3

Please sign in to comment.