README.md (1843B)
1 # Star Geometric Sensitivity 2 3 Example of geometric sensitivity calculation. The entire program is written in 4 plain ANSI C, with the exception of the Monte Carlo solver, which is written in 5 noweb using French as the literate language and in the comments, to make the 6 source code easier to read for French-speaking readers. 7 8 ## Requirements 9 10 In order to build the `sgs` program, you need the RSys Star-3D, Star-MC and 11 Star-SamPling headers and libraries as well as the noweb literate programming 12 tool. 13 14 ## Build 15 16 Build the `sgs` program: 17 18 make 19 20 Generate the pdf of the noweb sources: 21 22 make pdf 23 24 Note that the pdf contains graphics generated from the `results.fd` file, which 25 is a results file generated by the `sgs` program. Calculating these results 26 can be time-consuming, which is why this file is not re-generated every time 27 the sources are updated, even though it should be. Instead, pre-calculated 28 results are supplied with the sources, allowing you to generate the pdf without 29 running `sgs`. You can, however, force the generation of results by executing 30 the following command: 31 32 make results.fd 33 34 ## Copyright notice 35 36 Copyright © 2021-2023 Centre National de la Recherche Scientifique 37 Copyright © 2021-2023 INSA Lyon 38 Copyright © 2021-2023 Institut Mines Télécom Albi-Carmaux 39 Copyright © 2021-2023 |Méso|Star> (contact@meso-star.com) 40 Copyright © 2021-2023 Institut Pascal 41 Copyright © 2021-2023 PhotonLyX (info@photonlyx.com) 42 Copyright © 2021-2023 Université de Lorraine 43 Copyright © 2021-2023 Université Paul Sabatier 44 Copyright © 2021-2023 Université Toulouse - Jean Jaurès 45 46 ## License 47 48 Star Geometric Sensitivity is free software released under the GPL v3+ license: 49 GNU GPL version 3 or later. You are welcome to redistribute them under certain 50 conditions; refer to the COPYING file for details.