the serveur will be in maintenance mode Thursday February 25 from 7:00 to 12:00 ( git and registry will be unreacheable)

Commit 9122233c authored by LAMBERT Jean-charles's avatar LAMBERT Jean-charles

new README for pypi

parent 5a9f52b8
## ABOUT
UNSIOTOOLS contains a collection of [unsio](https://projets.lam.fr/projects/unsio) based programs.
You have access to falcON algorithm to compute density and to compute gravity.
## Installing python wrapper
```
pip install python-unsiotools -U
```
## To get some docstring help
```
# Help on falcON class
pydoc unsiotools.simulations.cfalcon
```
## Usage
In the example below, we load a RAMSES simulation, and compute density on HALO particles
```python
import unsio.input as uns_in # unsio reading module
import unsiotools.simulations.cfalcon as falcon
myfile="/home/jcl/output_00004" # input RAMSES simulation
# we instantiate a CUNS_IN object
my_in=uns_in.CUNS_IN(myfile,"halo") # We select components HALO
#
# Reading
#
if my_in.nextFrame(): # load snapshot
# read halo positions
status,pos=my_in.getData("halo","pos")
# read halo mass
status,mass=my_in.getData("halo","mass")
# read time simulation
status,timex=my_in.getData("time")
# we compute density
cf=falcon.CFalcon()
ok,rho,hsml=cf.getDensity(pos,mass)
print("Rho=",rho)
```
## Licence
UNSIOTOOLS is open source and released under the terms of the [CeCILL2 Licence](http://www.cecill.info/licences/Licence_CeCILL_V2-en.html)
## Webpage
PLease visit :
- [UNSIO project home page](https://projets.lam.fr/projects/unsio)
- [Python reading manual](https://projets.lam.fr/projects/unsio/wiki/PythonReadDataNew)
- [Python writing manual](https://projets.lam.fr/projects/unsio/wiki/PythonWriteDataNew)
## Copyright
**Copyright Jean-Charles LAMBERT**
**Jean-Charles.Lambert_at_lam.fr**
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment