Metadata-Version: 2.1
Name: python-unsiotools
Version: 0.0.8
Summary: Python wrapper to unsiotools
Home-page: https://projets.lam.fr/projects/uns_projects
Author: Jean-Charles LAMBERT
Author-email: jean-charles.lambert@lam.fr
License: CeCILL2.1 (https://opensource.org/licenses/CECILL-2.1)
Description: 
        ## ABOUT
        UNSIOTOOLS contains a collection of [unsio](https://projets.lam.fr/projects/unsio) based programs and depends of the [Nemo](https://teuben.github.io/nemo/) package.
        You have access to [falcON](https://iopscience.iop.org/article/10.1086/312724/pdf) algorithm to compute density and 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)
        ```
        - In this more simple example, we compute density on random data. Note that data must be in **float32** format
        ```python
        import unsiotools.simulations.cfalcon as falcon
        import numpy as np
        
        pos=np.float32(np.random.random_sample((300,)))
        mass=np.float32(np.random.random_sample((100,)))
        
        cf=falcon.CFalcon()
        
        ok,rho,hsml=cf.getDensity(pos,mass)
        
        print(ok,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)
        - [UNSIO Python reading manual](https://projets.lam.fr/projects/unsio/wiki/PythonReadDataNew)
        - [UNSIO Python writing manual](https://projets.lam.fr/projects/unsio/wiki/PythonWriteDataNew)
        - [UNSIO Pypi page](https://pypi.org/project/python-unsio/)
        - [NEMO home page](https://teuben.github.io/nemo/)
        
        ## Copyright
        **Copyright Jean-Charles LAMBERT**     
        **Jean-Charles.Lambert_at_lam.fr**     
        
Platform: Linux
Platform: Mac OS-X
Platform: Unix
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: C
Classifier: Programming Language :: C++
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Software Development
Requires-Python: >=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*
Description-Content-Type: text/markdown
