Sync

class pyR2D2.Sync(data)[source]

Bases: object

Class for downloading data from remote server

Methods Summary

`all`(server[, ssh, project, dist])	This method downloads all the data
`check`(n, server[, ssh, project, end_step])	Downloads checkpoint data
`remap_qq`(n, server[, ssh, project])	Downloads full 3D remap data
`select`(xs, server[, n, ssh, project])	Downloads data at certain height
`setup`(server, caseid[, ssh, project, dist])	Downloads setting data from remote server
`slice`(n, server[, ssh, project])	Downloads slice data
`tau`(server[, n, ssh, project])	Downloads data at constant optical depth
`vc`(server[, ssh, project])	Downloads pre analyzed data

Methods Documentation

all(server, ssh='ssh', project='doc', dist='../run/')[source]

This method downloads all the data

Parameters:

server (str) – Name of remote server
ssh (str) – Type of ssh command
project (str) – Name of project such as ‘R2D2’
dist (str) – Destination of data directory

Important

This method is accessible as pyR2D2.Data.sync.all.

check(n, server, ssh='ssh', project='doc', end_step=False)[source]

Downloads checkpoint data

Parameters:

n (int) – Step to be downloaded
server (str) – Name of remote server
ssh (str) – Type of ssh command
project (str) – Name of project such as ‘R2D2’
end_step (bool) – If true, checkpoint of end step is read

Important

This method is accessible as pyR2D2.Data.sync.check.

remap_qq(n, server, ssh='ssh', project='doc')[source]

Downloads full 3D remap data

Parameters:

n (int) – Target time step
server (str) – Name of remote server
project (str) – Name of project such as ‘R2D2’
ssh (str) – Type of ssh command

Important

This method is accessible as pyR2D2.Data.sync.remap_qq.

select(xs, server, n: int | None = None, ssh='ssh', project='doc')[source]

Downloads data at certain height

Parameters:

xs (float) – Height to be downloaded
server (str) – Name of remote server
ssh (str) – Type of ssh command
project (str) – Name of project such as ‘R2D2’

Important

This method is accessible as pyR2D2.Data.sync.select.

static setup(server, caseid, ssh='ssh', project='doc', dist='../run/')[source]

Downloads setting data from remote server

Parameters:

server (str) – Name of remote server
caseid (str) – caseid format of ‘d001’
ssh (str) – Type of ssh command
project (str) – Name of project such as ‘R2D2’
dist (str) – Destination of data directory

Important

This method is accessible as pyR2D2.Data.sync.setup.

slice(n, server, ssh='ssh', project='doc')[source]

Downloads slice data

Parameters:

n (int) – Step to be downloaded
server (str) – Name of remote server
ssh (str) – Type of ssh command
project (str) – Name of project such as ‘R2D2’

Important

This method is accessible as pyR2D2.Data.sync.slice.

tau(server, n: int | None = None, ssh='ssh', project='doc')[source]

Downloads data at constant optical depth

Parameters:

server (str) – Name of remote server
ssh (str) – Type of ssh command
project (str) – Name of project such as ‘R2D2’

Important

This method is accessible as pyR2D2.Data.sync.tau.

vc(server, ssh='ssh', project='doc')[source]

Downloads pre analyzed data

Parameters:

server (str) – Name of remote server
ssh (str) – Type of ssh command
project (str) – Name of project such as ‘R2D2’

Important

This method is accessible as pyR2D2.Data.sync.vc.

__init__(data)[source]

Initialize pyR2D2.Sync

Parameters:: read (pyR2D2.Read) – Instance of pyR2D2.read

Important

This method is accessible as pyR2D2.Data.sync.__init__.