commit 04b7471607bab171e90f722938c382f5cb06bebf
parent 3cf555ebd6810df394c74ff9d9fbbbcfd373677a
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Tue, 31 Oct 2023 09:00:40 +0100
Wraps the README text in 72 columns
This matches the convention of plain text e-mails. It can therefore be
sent as a publication announcement e-mail without being reformatted.
Diffstat:
| M | README.md | | | 56 | +++++++++++++++++++++++++++++--------------------------- |
1 file changed, 29 insertions(+), 27 deletions(-)
diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
# High-Tune: Sky
-This C library loads and manages the data describing a verticaly stratified
-atmosphere, neglecting Earth's sphericity. The physical properties of 3D clouds
-are also supported.
+This C library loads and manages the data describing a vertically
+stratified atmosphere, neglecting Earth's sphericity. The physical
+properties of 3D clouds are also supported.
## Requirements
@@ -31,36 +31,38 @@ Edit config.mk as needed, then run:
### Version 0.2.1
- Fix the acceleration data structures: the Kmin and Kmax stored in the
- hierarchical trees could be wrong for cloud fields with data irregularly
- structured along the Z axis.
+ hierarchical trees could be wrong for cloud fields with data
+ irregularly structured along the Z axis.
### Version 0.2
-- Make uniform the sky setup in shortwave and in longwave. On sky creation, the
- caller now defines the type of the spectral data to handle (i.e. shortwave
- or longwave) and their wavelength range. The `double wlen_lw_range[2]` member
- variable of the `struct htsky_args` data structure is thus renamed in `double
- wlen_range[2]` and is used in both cases. Finally the new member variable
- `enum htsky_spectral_type spectral_type` defines the type of this spectral
+- Make uniform the sky setup in shortwave and in longwave. On sky
+ creation, the caller now defines the type of the spectral data to
+ handle (i.e. shortwave or longwave) and their wavelength range. The
+ `double wlen_lw_range[2]` member variable of the `struct htsky_args`
+ data structure is thus renamed in `double wlen_range[2]` and is used
+ in both cases. Finally the new member variable `enum
+ htsky_spectral_type spectral_type` defines the type of this spectral
range.
-- Add the `htsky_get_raw_spectral_bounds` function that returns the spectral
- range of the loaded sky data overlapped by the user define wavelength range.
+- Add the `htsky_get_raw_spectral_bounds` function that returns the
+ spectral range of the loaded sky data overlapped by the user define
+ wavelength range.
### Version 0.1
- Add longwave support. Add the `double wlen_lw_range[2]` member
- variable to the `struct htsky_args` data structure that, once correctly
- defined, is used to setup the sky data for the provided long wave range. By
- default this range is degenerated meaning that the sky is setup for the short
- wave range [380, 780] nm.
-- Add the `htsky_find_spectral_band` function: it returns the spectral band
- that includes the submitted wavelength.
-- Remove the `htsky_sample_sw_spectral_data_CIE_1931_<X|Y|Z>` functions that
- explicitly rely on the CIE XYZ color space.
+ variable to the `struct htsky_args` data structure that, once
+ correctly defined, is used to setup the sky data for the provided long
+ wave range. By default this range is degenerated meaning that the sky
+ is setup for the short wave range [380, 780] nm.
+- Add the `htsky_find_spectral_band` function: it returns the spectral
+ band that includes the submitted wavelength.
+- Remove the `htsky_sample_sw_spectral_data_CIE_1931_<X|Y|Z>` functions
+ that explicitly rely on the CIE XYZ color space.
- Add the
- `htsky_fetch_per_wavelength_particle_phase_function_asymmetry_parameter` that
- returns the Henyey-Greenstein phase function parameter for a given
- wavelength.
+ `htsky_fetch_per_wavelength_particle_phase_function_asymmetry_parameter`
+ that returns the Henyey-Greenstein phase function parameter for a
+ given wavelength.
## License
@@ -68,7 +70,7 @@ Copyright (C) 2018, 2019, 2020, 2021 |Méso|Star> (contact@meso-star.com)
Copyright (C) 2018, 2019 Centre National de la Recherche Scientifique (CNRS)
Copyright (C) 2018, 2019 Université Paul Sabatier
-HTSky is free software released under the GPL v3+ license: GNU GPL version 3 or
-later. You are welcome to redistribute it under certain conditions; refer to
-the COPYING file for details.
+HTSky is free software released under the GPL v3+ license: GNU GPL
+version 3 or later. You are welcome to redistribute it under certain
+conditions; refer to the COPYING file for details.
