pyRinexpro.process

ProcessStatus

class pyRinexpro.ProcessStatus

Bases: enum.Enum

The process status

PROC_WAITING = 100
PROC_RUNNING = 101
PROC_RETRY = 102
PROC_ERROR = 103
PROC_SUCCESS = 104

AProcess

class pyRinexpro.AProcess(client, id)

Bases: object

An abstract class that containt the minimal Process data to request the api

Parameters:
  • client (Client) – The client to request the api
  • id (int) – The process id
getLog()

Get the process log data

Returns:The log data depending on the process algorithm
Return type:LogRineqc, LogRinexnav, LogPPP or LogDiff
export(path_or_buf=None)

Export the pdf report file

Parameters:path_or_buf (str or file) – The path or the file-like object to save the file (default is None)
Returns:The content of the file if save_to is ‘’ or self
Return type:list(byte) or None

Process

class pyRinexpro.Process(json_obj, client)

Bases: pyRinexpro.process.AProcess

A process

Parameters:
  • json_obj (object) – The parsed json
  • client (Client) – The client to request the api
update()

Update the object data

Returns:self
Return type:Process
wait(refresh_rate=10)

Wait for the process to finsh

Parameters:refresh_rate (int) – The time in second between each update (default is 10)
Returns:self
Return type:Process

ProcessList

class pyRinexpro.ProcessList(json_obj, client)

Bases: collections.UserList

A list of Processes

Parameters:
  • json_obj (object) – The parsed json
  • client (Client) – The client to request the api

SessionOverview

class pyRinexpro.SessionOverview(json_obj, client)

Bases: pyRinexpro.session.ASession

The session overview

Parameters:
  • json_obj (object) – The parsed json
  • client (Client) – The client to request the api
get()

Get the actual session

Returns:The actual session
Return type:Session

Params

class pyRinexpro.Params

Bases: object

ParamsRineqc

class pyRinexpro.ParamsRineqc(format=None, antenna_height=None)

Bases: pyRinexpro.process.Params

The parameters for the diff algorithm

Parameters:
  • format (str) – The session file format (default is None)
  • antenna_height (float) – The antenna height (default is None)

ParamsDiff

class pyRinexpro.ParamsDiff(mode=None, bases=None, bases_source=None, n=None, m=None, reject=None)

Bases: pyRinexpro.process.Params

The parameters for the diff algorithm

Parameters:
  • mode (str) – The mode parameter (default is None)
  • bases (str) – The base parameter (default is None)
  • bases_source (str or list(str)) – The bases source parameter. If parameter is string the separator is ‘|’ (default is None)
  • n (int) – The n parameter (default is None)
  • m (int) – The m parameter (default is None)
  • reject (str or list(str)) – The reject parameter. If parameter is string the separator is ‘|’ (default is None)
to_dict()

Repsent the object as a dict

Returns:the dict
Return type:dict(str,object)

ParamsPPP

class pyRinexpro.ParamsPPP(mode=None)

Bases: pyRinexpro.process.Params

The parmaeters for the ppp algorithm

Parameters:mode (str) – The mode parameter (default is None)
to_dict()

Repsent the object as a dict

Returns:the dict
Return type:dict(str,object)

ParamsVrs

class pyRinexpro.ParamsVrs(name, lat, lg, first_epoch, last_epoch, rate, h=None, hq=None, reject=None, session_id=None)

Bases: pyRinexpro.process.Params

The parameters for the vrs algorithm

Parameters:
  • name (str) – The name of the virtual session
  • lat (float) – The latitude parameter
  • lg (float) – The longitude parameter
  • first_epoch (datetime or str) – The first epoch. If the paramter is a string the format should be “%Y%m%d%H%M” or “%Y-%m-%d %H:%M:%S”
  • last_epoch (datetime or str) – The last epoch. If the paramter is a string the format should be “%Y%m%d%H%M” or “%Y-%m-%d %H:%M:%S”
  • rate (int) – The rate parameter
to_dict()

Repsent the object as a dict

Returns:The dict
Return type:dict(str,object)