commit 5f32d5d751f98c5eb2bbe42ae70501f900c6e3cc
parent 392cf344598f6ad2a7b3e112dc2bca03cc67ccbc
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Mon, 4 May 2020 12:09:20 +0200
Write the 0.1 release note
Diffstat:
| M | README.md | | | 32 | ++++++++++++++++++++++---------- |
1 file changed, 22 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
@@ -25,24 +25,18 @@ subsequent initialisation steps of the same sky. We point out that this file is
valid as long as the provided HTGOP, HTCP and HTMie files are the ones used to
build the cached structures. If not, an error is returned on sky creation.
-Note that this library provides functions compatible with the
-[Star-MTL](https://gitlab.Com/meso-star/star-mtl/) specification. Consequently,
-HTSky can be used as it, to describe a semi-transparent inhomogeneous medium in
-a Star-MTL file.
-
## How to build
This library is compatible GNU/Linux 64-bits. It relies on the
[CMake](http://www.cmake.org) and the
-[RCMake](https://gitlab.com/vaplv/rcmake/) packages to build. It also depends
-on the [HTCP](https://gitlab.com/meso-star/htcp/),
+[RCMake](https://gitlab.com/vaplv/rcmake/) packages to build.
+It also depends on the
+[HTCP](https://gitlab.com/meso-star/htcp/),
[HTGOP](https://gitlab.com/meso-star/htgop/),
[HTMie](https://gitlab.com/meso-star/htmie/),
[RSys](https://gitlab.com/vaplv/rsys/) and
[Star-VX](https://gitlab.com/meso-star/star-vx/) libraries, and on
-[OpenMP](http://www.openmp.org) 1.2 to parallelize its computations. If the
-[Star-MTL](https://gitlab.com/meso-star/star-mtl) library is found, HTSky
-will provide functions compatible with the Star-MTL specification.
+[OpenMP](http://www.openmp.org) 1.2 to parallelize its computations.
First ensure that CMake is installed on your system. Then install the RCMake
package as well as the aforementioned prerequisites. Finally generate the
@@ -52,6 +46,24 @@ resulting project can be edited, built, tested and installed as any CMake
project. Refer to the [CMake documentation](https://cmake.org/documentation)
for further informations on CMake.
+## Release notes
+
+### Version 0.1
+
+- Add the support of long waves. 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.
+- Add the
+ `htsky_fetch_per_wavelength_particle_phase_function_asymmetry_parameter` that
+ returns the Henyey-Greenstein phase function parameter for a given
+ wavelength.
+
## License
Copyright (C) 2018, 2019, 2020 [|Meso|Star](http://www.meso-star.com)
