pyPLUTO.pyPLUTO Namespace Reference

Classes
class	Image
class	pload
class	Tools

Functions
def	curdir ()
def	get_nstepstr (ns)
def	nlast_info

Variables
	hasH5 = True

Function Documentation

def pyPLUTO.pyPLUTO.curdir

(

)

Get the current working directory.

Definition at line 19 of file pyPLUTO.py.

def curdir():
    """ Get the current working directory.
    """
        curdir = os.getcwd()+'/'
        return curdir

Here is the caller graph for this function:

def pyPLUTO.pyPLUTO.get_nstepstr

(

ns

)

Convert the float input *ns* into a string that would match the data file name.

**Inputs**:

 ns -- Integer number that represents the time step number. E.g., The ns for data.0001.dbl is 1.\n

**Outputs**:

 Returns the string that would be used to complete the data file name. E.g., for data.0001.dbl, ns = 1 and pyPLUTO.get_nstepstr(1) returns '0001'

Definition at line 25 of file pyPLUTO.py.

def get_nstepstr(ns):
    """ Convert the float input *ns* into a string that would match the data file name.

    **Inputs**:

     ns -- Integer number that represents the time step number. E.g., The ns for data.0001.dbl is 1.\n

    **Outputs**:

     Returns the string that would be used to complete the data file name. E.g., for data.0001.dbl, ns = 1 and pyPLUTO.get_nstepstr(1) returns '0001'
     """
    nstepstr = str(ns)
    while len(nstepstr) < 4:
           nstepstr= '0'+nstepstr
    return nstepstr

def pyPLUTO.pyPLUTO.nlast_info	(		w_dir = None,
			datatype = None
	)

Prints the information of the last step of the simulation as obtained from out files

**Inputs**:

  w_dir -- path to the directory which has the dbl.out(or flt.out) and the data\n
  datatype -- If the data is of 'float' type then datatype = 'float' else by default the datatype is set to 'double'.

    **Outputs**:

  This function returns a dictionary with following keywords - \n

  nlast -- The ns for the last file saved.\n
  time -- The simulation time for the last file saved.\n
  dt -- The time step dt for the last file. \n
  Nstep -- The Nstep value for the last file saved.


**Usage**:

  In case the data is 'float'.

  ``wdir = /path/to/data/directory``\n
  ``import pyPLUTO as pp``\n
  ``A = pp.nlast_info(w_dir=wdir,datatype='float')``    

Definition at line 41 of file pyPLUTO.py.

def nlast_info(w_dir=None,datatype=None):
    """ Prints the information of the last step of the simulation as obtained from out files

    **Inputs**:
    
      w_dir -- path to the directory which has the dbl.out(or flt.out) and the data\n
      datatype -- If the data is of 'float' type then datatype = 'float' else by default the datatype is set to 'double'.

        **Outputs**:
    
      This function returns a dictionary with following keywords - \n

      nlast -- The ns for the last file saved.\n
      time -- The simulation time for the last file saved.\n
      dt -- The time step dt for the last file. \n
      Nstep -- The Nstep value for the last file saved.


    **Usage**:
    
      In case the data is 'float'.

      ``wdir = /path/to/data/directory``\n
      ``import pyPLUTO as pp``\n
      ``A = pp.nlast_info(w_dir=wdir,datatype='float')``    
    """
    if w_dir is None: w_dir=curdir()
    if datatype == 'float':
        fname_v = w_dir+"flt.out"
    elif datatype == 'vtk':
        fname_v = w_dir+"vtk.out"
    else:
        fname_v = w_dir+"dbl.out"
    last_line = file(fname_v,"r").readlines()[-1].split()
    nlast = int(last_line[0])
    SimTime =  float(last_line[1])
    Dt = float(last_line[2])
    Nstep = int(last_line[3])
        
    print "------------TIME INFORMATION--------------"
    print 'nlast =',nlast
    print 'time  =',SimTime
    print 'dt    =', Dt
    print 'Nstep =',Nstep
    print "-------------------------------------------"
        
    return {'nlast':nlast,'time':SimTime,'dt':Dt,'Nstep':Nstep}
    

Here is the call graph for this function:

Variable Documentation

pyPLUTO.pyPLUTO.hasH5 = True

Definition at line 15 of file pyPLUTO.py.