README.md 1.51 KB
Newer Older
LAMBERT Jean-charles's avatar
LAMBERT Jean-charles committed
1 2 3 4 5 6 7
## ABOUT
**UNSIO** (**U**niversal **N**body **S**napshot **I**nput **O**utput) is an API which perform input/output operations in a generic way,
and on different kind of nbody files format (nemo, Gadget binaries 1 and 2, Gadget hdf5, Ramses). By using this API,
a user could write only one analysis program which will work on all known files format supported by UNSIO.
It's not necessary anymore to know how is implemented a file format, UNSIO will do transparently and automatically
all the hard work for you ! With UNSIO, you will spend less time to develop your analysis program.
UNSIO comes with an integrated sqlite3 database which can be used to retrieve automatically all your data
8 9
among terabytes of hard disks.

LAMBERT Jean-charles's avatar
LAMBERT Jean-charles committed
10 11 12 13 14
## Features

UNSIO can be used from different languages (C,C++,Fortran and Python)

## Supported files format :
LAMBERT Jean-charles's avatar
LAMBERT Jean-charles committed
15 16 17 18 19 20 21 22 23 24 25 26 27
* [**NEMO** (read and write)](https://teuben.github.io/nemo/)
* [**GADGET 1** (read)](http://www.mpa-garching.mpg.de/gadget/)
* **GADGET 2** (read an write)
* **GADGET 3/hdf5** (read and write)
* [**RAMSES** (read)](https://bitbucket.org/rteyssie/ramses)
* **List of files** stored in a file
* Simulations stored in **SQLITE3** database


## Installing python wrapper
```console
pip install python-unsio
```
LAMBERT Jean-charles's avatar
LAMBERT Jean-charles committed
28
## Usage
LAMBERT Jean-charles's avatar
LAMBERT Jean-charles committed
29

LAMBERT Jean-charles's avatar
LAMBERT Jean-charles committed
30 31 32 33 34 35
```python
import unsio.input as unsi

# we instantiate object
x=unsi.CUNS_IN()
```
LAMBERT Jean-charles's avatar
LAMBERT Jean-charles committed
36 37 38
## License
UNSIO is open source and released under the terms of the [CeCILL2 Licence](http://www.cecill.info/licences/Licence_CeCILL_V2-en.html)

LAMBERT Jean-charles's avatar
LAMBERT Jean-charles committed
39
## Webpage
LAMBERT Jean-charles's avatar
LAMBERT Jean-charles committed
40
PLease visit : https://projets.lam.fr/projects/unsio