README.md 2.11 KB
Newer Older
Udo Ziegler's avatar
Udo Ziegler committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
![NIRVANA](./doc/logo/png/logo_short.png)  

 

# NIRVANA - version 4

**Adaptive mesh refinement computer code   
for chemo-gravito-magneto-gasdynamical simulations in astrophysics**

## Udo Ziegler![cover](./doc/logo/AIP/AIP-logo_text_small.png)  
  
 
 
 
  
## License

NIRVANA Copyright (C) 2020  Udo Ziegler, AIP

NIRVANA is free software: you can redistribute it and/or modify it under the 
terms of the GNU General Public License as published by the Free Software 
Foundation, either version 3 of the License, or (at your option) any later 
version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details (https://www.gnu.org/licenses/).

 

## Requirements

**mandatory:**    

* C-compiler

**optional:**    

* MPI-2 library -- needed for distributed-memory parallel simulations.  
* Silo4.8 and/or HDF5 library -- needed for the postprocessing data converter 
  tool CAIVS in order to generate Silo/HDF5 files for visualization purposes.  
* Git -- needed to clone a local version of the code from the GitLab repository.

 

## Download

The public version of the NIRVANA code is distributed on the GitLab repository
<https://gitlab.aip.de/ziegler/NIRVANA>.
A clone of it can be obtained by any Git client typing the git command

``> git clone https://gitlab.aip.de/ziegler/NIRVANA``

Udo Ziegler's avatar
Udo Ziegler committed
55
Alternatively, NIRVANA can be downloaded from the GitLab repository in archived 
Udo Ziegler's avatar
Udo Ziegler committed
56 57 58 59 60 61
form (zip, tar.gz).

&nbsp;

## Documentation

Udo Ziegler's avatar
Udo Ziegler committed
62 63 64
Code documention is provided on the project's 
[Wiki page](https://gitlab.aip.de/ziegler/NIRVANA/-/wikis/Home) 
and as a collection of PDF files in the subdirectory   
Udo Ziegler's avatar
Udo Ziegler committed
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82

> ``/doc/pdf``

A doxygen-generated HTML description of code functions is provided by browsing

> ``file:///$NIRVANA_HOME/doc/html/index.html`` 

where $NIRVANA_HOME has to be replaced by your NIRVANA home path.

&nbsp;

## Code support

Because of limited resources the author generally cannot give support
for usage or modifications of the program.