star-phor-input

File format for describing photoreactor configurations
git clone https://www.edstar.cnrs.fr/git/star-phor-input.git
Log | Files | Refs | README | LICENSE

README.md (2039B)

      1 # star-phor-input
      2 
      3 **star-phor-input** is a file format convention for describing photoreactor
      4 configurations in the field of photoreactive system engineering. It comes with a
      5 dedicated C library and a linter. The star-phor-input file format specification
      6 is used as the input for the star-phor solver, which depends on the sphin
      7 library.
      8 
      9 **sphin** is a C library designed to parse star-phor-input configuration files
     10 and to access the associated data. Thanks to an unstructured scene description,
     11 the memory representation is independent of any specific numerical method used
     12 to solve the system. This makes the library solver-agnostic while still
     13 providing all necessary geometries and physical properties for computation.
     14 
     15 **sphin-lint** is an executable that flags syntactic errors, bugs, stylistic
     16 issues, and suspicious constructs in star-phor-input configuration files.
     17 
     18 ## Requirements
     19 
     20 - POSIX make
     21 - C compiler (C99)
     22 - pkg-config
     23 - [RSys](https://meso-star.com/git/rsys/log.html)
     24 - [star-stl](https://meso-star.com/git/star-stl/log.html)
     25 - scdoc
     26 
     27 ## Installation
     28 
     29 Edit config.mk as needed. Run:
     30 
     31 	make all
     32 
     33 Then run:
     34 
     35 	make install
     36 
     37 with appropriate privileges.
     38 
     39 ## Uninstallation
     40 
     41 Run:
     42 
     43 	make uninstall
     44 
     45 with appropriate privileges.
     46 
     47 ## Copyright notice
     48 
     49 Copyright (C) 2024-2026 Centre National de la Recherche Scientifique  
     50 Copyright (C) 2024-2026 Clermont Auvergne INP  
     51 Copyright (C) 2024-2026 INSA Lyon  
     52 Copyright (C) 2024-2026 Institut Mines Télécom Albi-Carmaux  
     53 Copyright (C) 2024-2026 Institut National Polytechnique de Toulouse  
     54 Copyright (C) 2024-2026 |Méso|Star> (contact@meso-star.com)  
     55 Copyright (C) 2024-2026 PhotonLyX (info@photonlyx.com)  
     56 Copyright (C) 2024-2026 Université de Lorraine  
     57 Copyright (C) 2024-2026 Université Paul Sabatier  
     58 Copyright (C) 2024-2026 Université Toulouse - Jean Jaurès
     59 
     60 ## License
     61 
     62 This is free software released under the GPL v3+ license: GNU GPL version
     63 3 or later. You are welcome to redistribute them under certain conditions;
     64 refer to the COPYING file for details.