stardis-green

Post-processing of green functions
git clone git://git.meso-star.fr/stardis-green.git
Log | Files | Refs | README | LICENSE

README.md (2197B)

      1 # Stardis Green
      2 
      3 Stardis Green is a postprocess of Green function binary files, as
      4 produced by the [Stardis](https://gitlab.com/meso-star/stardis) program.
      5 Its main purpose is to compute Monte Carlo results by applying Green
      6 functions to new settings, enabling ultra-fast Monte Carlo computations.
      7 
      8 ## Requirements
      9 
     10 - C compiler with OpenMP support
     11 - POSIX make
     12 - pkg-config
     13 - [RSys](https://gitlab.com/vaplv/rsys)
     14 - [Stardis](https://gitlab.com/meso-star/stardis)
     15 
     16 ## Installation
     17 
     18 Edit config.mk as needed, then run:
     19 
     20     make clean install
     21 
     22 ## Release notes
     23 
     24 ### Version 0.5.1
     25 
     26 Fix incorrect installation directory for license and README files.
     27 
     28 ### Version 0.5
     29 
     30 - Write the man pages directly in mdoc's roff macros, instead of using
     31   the intermediate asciidoc source.
     32 - Replace CMake by Makefile as build system.
     33 - Update compiler and linker flags to increase the security and
     34   robustness of generated binaries.
     35 - Provide a pkg-config file to link the library as an external
     36   dependency.
     37 
     38 ### Version 0.4
     39 
     40 - Change input file format to cope with stardis changes.
     41 - Now depends on the stardis-green-types.h header file, that is
     42   installed when building stardis and describes the types used to read
     43   and write Green function binary files. Currently depends on version 4.
     44 
     45 ### Version 0.3
     46 
     47 - Change input file format to cope with stardis changes.
     48 
     49 ### Version 0.2.1
     50 
     51 Fix a bug that could cause a crash.
     52 
     53 ### Version 0.2
     54 
     55 - Add connections to html output.
     56 - Add compute time information to output.
     57 - Adapt to new file format from stardis.
     58 
     59 ### Version 0.1.1
     60 
     61 - Check binary Green file format version (this require stardis 0.5.1).
     62 - Man improvement.
     63 - Ensure C89 compatibility.
     64 
     65 ### Version 0.1
     66 
     67 - Compatible with stardis v0.5.0 binary Green function files.
     68 - Can produce a summary of a Green function in HTML format.
     69 - Can apply a Green function to new settings and output the
     70   corresponding Monte Carlo results.
     71 
     72 ## License
     73 
     74 Copyright (C) 2020-2022, 2024 |Méso|Star> (contact@meso-star.com).
     75 
     76 Stardis-Green is free software released under the GPL v3+ license: GNU
     77 GPL version 3 or later.  You are welcome to redistribute it under
     78 certain conditions; refer to the COPYING file for details.