commit dc169bee850c3b1ae230d2909791c4bbbbb6f948 parent 6c0027c4484695de150618eabd70c2005032240e Author: Eduardo Fontana Lazzari <edufonlaz@gmail.com> Date: Sat, 1 Mar 2025 11:08:02 +0100 Improve README Diffstat:
| M | README.md | | | 34 | ++++++++++++++++++++++++---------- |
1 file changed, 24 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md @@ -1,6 +1,20 @@ # star-phor-input -Format file describing photoreactors as input to the star-phor solver +**star-phor-input** is a C library designed to parse input files compatible +with the [star-phor](star-phor) solver. It loads the corresponding data into +memory as a scene that describes a photoreactive system. + +The library has the following properties: + +- **Unified Data Representation** +The library abstracts all data formats on disk while loading the data. For +example, geometries are all stored in a consistent structure—primarily using +one-dimensional arrays—regardless of their original file format. + +- **Unstructured Scene Description** +The scene representation is independent of any specific numerical method used +for solving the system. This makes the library solver-agnostic, while still +providing all the necessary geometries and physical properties for computation. ## Requirements @@ -17,18 +31,18 @@ Edit config.mk as needed. Then run: ## Copyright notice -Copyright (C) 2024 Centre National de la Recherche Scientifique -Copyright (C) 2024 Clermont Auvergne INP -Copyright (C) 2024 INSA Lyon -Copyright (C) 2024 Institut Mines Télécom Albi-Carmaux +Copyright (C) 2024 Centre National de la Recherche Scientifique +Copyright (C) 2024 Clermont Auvergne INP +Copyright (C) 2024 INSA Lyon +Copyright (C) 2024 Institut Mines Télécom Albi-Carmaux Copyright (C) 2024 Institut National Polytechnique de Toulouse -Copyright (C) 2024 |Méso|Star> (contact@meso-star.com) -Copyright (C) 2024 PhotonLyX (info@photonlyx.com) -Copyright (C) 2024 Université de Lorraine -Copyright (C) 2024 Université Paul Sabatier +Copyright (C) 2024 |Méso|Star> (contact@meso-star.com) +Copyright (C) 2024 PhotonLyX (info@photonlyx.com) +Copyright (C) 2024 Université de Lorraine +Copyright (C) 2024 Université Paul Sabatier Copyright (C) 2024 Université Toulouse - Jean Jaurès -## License +## License This is free software released under the GPL v3+ license: GNU GPL version 3 or later. You are welcome to redistribute them under certain conditions;