PyPLUTO - Revision history

Lothar.brendel: /* Usage */ warning, +members

2025-05-27T06:50:24Z

Usage: warning, +members

← Older revision		Revision as of 08:50, 27 May 2025
Line 20:		Line 20:
	(Unfortunately, <code>pload()</code>'s verbosity cannot be turned off, but in JupyterLab you can put <code>%%capture --no-display</code> as the first line of the cell.)		(Unfortunately, <code>pload()</code>'s verbosity cannot be turned off, but in JupyterLab you can put <code>%%capture --no-display</code> as the first line of the cell.)

	Now, <code>data</code> contains all the information of the given timestep. To obtain a specific variable, e.g. <code>vx1</code>, you can use <code>data.vx1</code> to get a numpy array with all the values in that timestep. Moreover, <code>x1</code>, <code>x2</code> and <code>x3</code>, as well as <code>dx1</code>, <code>dx2</code> and <code>dx3</code>, contain the grid and its spacings, respectively.		Now, <code>data</code> contains all the information of the given timestep. To obtain a specific variable, e.g. <code>vx1</code>, you can use <code>data.vx1</code> to get a numpy array with all the values in that timestep. Moreover, <code>x1</code>, <code>x2</code> and <code>x3</code>, as well as <code>dx1</code>, <code>dx2</code> and <code>dx3</code>, contain the grid and its spacings, respectively. For a list of all members see below.

	~~Note~~: Up to version 4.1 it used to be ~~not~~ <code>import pyPLUTO~~.pload~~ as pp</code> ~~but~~ <code>import pyPLUTO as pp</code>~~, which still~~ may ~~appear~~ in documentations.		Notes:
			* Upon import, there may be a warning about ''invalid escape sequence '\h''', which can be ignored. (It stems from a <code>$\hat{y}$</code> in the docstring of the function <code>myfieldlines()</code>).
			* Up to version 4.1 it used to be <code>import pyPLUTO as pp</code> rather than <code>import pyPLUTO'''.pload''' as pp</code>. You may encounter the old way in documentations.

			Members of an object of type <code>pyPLUTO.pload.pload</code> (besides the physical fields listed in <code>vars</code>) are: <code>DataScan()</code>, <code>DataScanHDF5()</code>, <code>DataScanVTK()</code>, <code>Dt</code>, <code>NStep</code>, <code>NStepStr</code>, <code>ReadDataFile()</code>, <code>ReadGridFile()</code>, <code>ReadMultipleFiles()</code>, <code>ReadSingleFile()</code>, <code>ReadTimeInfo()</code>, <code>ReadVarFile()</code>, <code>'''SimTime'''</code>, <code>Slice</code>, <code>datatype</code>, <code>dx1</code>, <code>dx2</code>, <code>dx3</code>, <code>endianess</code>, <code>filetype</code>, <code>geometry</code>, <code>irange</code>, <code>jrange</code>, <code>krange</code>, <code>level</code>, <code>n1</code>, <code>n1_tot</code>, <code>n2</code>, <code>n2_tot</code>, <code>n3</code>, <code>n3_tot</code>, <code>nshp</code>, <code>vars</code>, <code>wdir</code>, <code>x1</code>, <code>x1r</code>, <code>x1range</code>, <code>x2</code>, <code>x2r</code>, <code>x2range</code>, <code>x3</code>, <code>x3r</code>, <code>x3range</code>

Lothar.brendel: /* Usage */ %%capture

2025-05-21T08:46:48Z

Usage: %%capture

← Older revision		Revision as of 10:46, 21 May 2025
Line 18:		Line 18:
	data=pp.pload(timestep, w_dir=wdir) # timestep = int, e.g. 1		data=pp.pload(timestep, w_dir=wdir) # timestep = int, e.g. 1

	(Unfortunately, <code>pload()</code>'s verbosity cannot be turned off.)		(Unfortunately, <code>pload()</code>'s verbosity cannot be turned off, but in JupyterLab you can put <code>%%capture --no-display</code> as the first line of the cell.)

	Now, <code>data</code> contains all the information of the given timestep. To obtain a specific variable, e.g. <code>vx1</code>, you can use <code>data.vx1</code> to get a numpy array with all the values in that timestep. Moreover, <code>x1</code>, <code>x2</code> and <code>x3</code>, as well as <code>dx1</code>, <code>dx2</code> and <code>dx3</code>, contain the grid and its spacings, respectively.		Now, <code>data</code> contains all the information of the given timestep. To obtain a specific variable, e.g. <code>vx1</code>, you can use <code>data.vx1</code> to get a numpy array with all the values in that timestep. Moreover, <code>x1</code>, <code>x2</code> and <code>x3</code>, as well as <code>dx1</code>, <code>dx2</code> and <code>dx3</code>, contain the grid and its spacings, respectively.

	Note: Up to version 4.1 it used to be not <code>import pyPLUTO.pload as pp</code> but <code>import pyPLUTO as pp</code>, which still may appear in documentations.		Note: Up to version 4.1 it used to be not <code>import pyPLUTO.pload as pp</code> but <code>import pyPLUTO as pp</code>, which still may appear in documentations.

Lothar.brendel: +spacing

2025-05-21T08:40:36Z

+spacing

← Older revision		Revision as of 10:40, 21 May 2025
Line 20:		Line 20:
	(Unfortunately, <code>pload()</code>'s verbosity cannot be turned off.)		(Unfortunately, <code>pload()</code>'s verbosity cannot be turned off.)

	Now, <code>data</code> contains all the information of the given timestep. To obtain a specific variable, e.g. <code>vx1</code>, you can use <code>data.vx1</code> to get a numpy array with all the values in that timestep. Moreover, <code>x1</code>, <code>x2</code> and <code>x3</code>, as well as <code>dx1</code>, <code>dx2</code> and <code>dx3</code>, contain the grid.		Now, <code>data</code> contains all the information of the given timestep. To obtain a specific variable, e.g. <code>vx1</code>, you can use <code>data.vx1</code> to get a numpy array with all the values in that timestep. Moreover, <code>x1</code>, <code>x2</code> and <code>x3</code>, as well as <code>dx1</code>, <code>dx2</code> and <code>dx3</code>, contain the grid and its spacings, respectively.

	Note: Up to version 4.1 it used to be not <code>import pyPLUTO.pload as pp</code> but <code>import pyPLUTO as pp</code>, which still may appear in documentations.		Note: Up to version 4.1 it used to be not <code>import pyPLUTO.pload as pp</code> but <code>import pyPLUTO as pp</code>, which still may appear in documentations.

Lothar.brendel: /* Usage */ vx, x ,dx

2024-12-01T10:31:38Z

Usage: vx, x ,dx

← Older revision		Revision as of 12:31, 1 December 2024
Line 18:		Line 18:
	data=pp.pload(timestep, w_dir=wdir) # timestep = int, e.g. 1		data=pp.pload(timestep, w_dir=wdir) # timestep = int, e.g. 1

	Now, <code>data</code> contains all the information of the given timestep. To obtain a specific variable, e.g. <code>x1</code>, you can use <code>data.x1</code> to get a numpy array with all the values in that timestep.		(Unfortunately, <code>pload()</code>'s verbosity cannot be turned off.)

			Now, <code>data</code> contains all the information of the given timestep. To obtain a specific variable, e.g. <code>vx1</code>, you can use <code>data.vx1</code> to get a numpy array with all the values in that timestep. Moreover, <code>x1</code>, <code>x2</code> and <code>x3</code>, as well as <code>dx1</code>, <code>dx2</code> and <code>dx3</code>, contain the grid.

	Note: Up to version 4.1 it used to be not <code>import pyPLUTO.pload as pp</code> but <code>import pyPLUTO as pp</code>, which still may appear in documentations.		Note: Up to version 4.1 it used to be not <code>import pyPLUTO.pload as pp</code> but <code>import pyPLUTO as pp</code>, which still may appear in documentations.

Lothar.brendel: /* Usage */ slash

2024-12-01T09:46:36Z

Usage: slash

← Older revision		Revision as of 11:46, 1 December 2024
Line 15:		Line 15:

	import pyPLUTO.pload as pp		import pyPLUTO.pload as pp
	wdir='/path/to/data/files'		wdir="/path/to/data/files/" # trailing slash!
	data=pp.pload(timestep, w_dir=wdir) # timestep = int, e.g. 1		data=pp.pload(timestep, w_dir=wdir) # timestep = int, e.g. 1

Lothar.brendel: tidy

2024-03-19T13:13:02Z

tidy

← Older revision		Revision as of 15:13, 19 March 2024
Line 3:		Line 3:
	* https://github.com/bellatrics/pyPLUTO, alpha state from 2011, don't use		* https://github.com/bellatrics/pyPLUTO, alpha state from 2011, don't use
	* https://github.com/coolastro/pyPLUTO, version 1.0 from 2012, don't use		* https://github.com/coolastro/pyPLUTO, version 1.0 from 2012, don't use
	* https://gitlab.mpcdf.mpg.de/sdoetsch/pypluto, modified version 4.4, maintained until 2022 ← use ~~<nowiki>~~''this''~~</nowiki>~~		* https://gitlab.mpcdf.mpg.de/sdoetsch/pypluto, modified version 4.4, maintained until 2022 ← use ''this''

	~~To install:~~		= Installation =

	* Grab the files off of gitlab and unzip them into a local folder		(... as non-administrator)
	* Inside the extracted folder enter your python environment (e.g. ~~conda~~) ~~and enter the command <code>python3 setup.py install</code>~~

	~~To load data~~:		* Grab the files off of gitlab e.g. in [https://gitlab.mpcdf.mpg.de/sdoetsch/pypluto/-/archive/main/pypluto-main.zip ZIP format] and unzip them into a local folder.
			* Inside the extracted folder, enter your python environment (e.g. conda) and run <code>python3 setup.py install</code>.

	* <code>import pyPLUTO.pload as pp</code>		= Usage =
	* <code>wdir=~~'/path/to/data/files'</code>~~
	* <code>data=~~pp.pload(timestep (e.g. 1), w_dir=wdir)</code>~~

	~~Now~~ 'data' ~~contains all the information of the given timestep. To call a specific variable you can use <code>~~data.~~x1</code> to get a numpy array of all values of the variable x1 in that~~ timestep.		import pyPLUTO.pload as pp
			wdir='/path/to/data/files'
			data=pp.pload(timestep, w_dir=wdir) # timestep = int, e.g. 1

	Note: ~~For versions <~~ 4.1~~: Replace~~ <code>import pyPLUTO.pload as pp</code> ~~with~~ <code>import pyPLUTO as pp</code>		Now, <code>data</code> contains all the information of the given timestep. To obtain a specific variable, e.g. <code>x1</code>, you can use <code>data.x1</code> to get a numpy array with all the values in that timestep.

			Note: Up to version 4.1 it used to be not <code>import pyPLUTO.pload as pp</code> but <code>import pyPLUTO as pp</code>, which still may appear in documentations.

Arthur: Added instruction to install pypluto and how to read data using it

2024-03-19T12:46:54Z

Added instruction to install pypluto and how to read data using it

← Older revision		Revision as of 14:46, 19 March 2024
Line 3:		Line 3:
	* https://github.com/bellatrics/pyPLUTO, alpha state from 2011, don't use		* https://github.com/bellatrics/pyPLUTO, alpha state from 2011, don't use
	* https://github.com/coolastro/pyPLUTO, version 1.0 from 2012, don't use		* https://github.com/coolastro/pyPLUTO, version 1.0 from 2012, don't use
	* https://gitlab.mpcdf.mpg.de/sdoetsch/pypluto, modified version 4.4, maintained until 2022 (← use ''this'')		* https://gitlab.mpcdf.mpg.de/sdoetsch/pypluto, modified version 4.4, maintained until 2022 ← use <nowiki>''this''</nowiki>

	~~Change~~ in ~~API for~~ versions > 4.1: <code>import pyPLUTO.pload as pp</code> ~~instead of~~		To install:
	<code>import pyPLUTO as pp<code>
			* Grab the files off of gitlab and unzip them into a local folder
			* Inside the extracted folder enter your python environment (e.g. conda) and enter the command <code>python3 setup.py install</code>

			To load data:

			* <code>import pyPLUTO.pload as pp</code>
			* <code>wdir='/path/to/data/files'</code>
			* <code>data=pp.pload(timestep (e.g. 1), w_dir=wdir)</code>

			Now 'data' contains all the information of the given timestep. To call a specific variable you can use <code>data.x1</code> to get a numpy array of all values of the variable x1 in that timestep.

			Note: For versions < 4.1: Replace <code>import pyPLUTO.pload as pp</code> with <code>import pyPLUTO as pp</code>

Lothar.brendel: this

2024-03-19T12:31:04Z

this

← Older revision		Revision as of 14:31, 19 March 2024
Line 3:		Line 3:
	* https://github.com/bellatrics/pyPLUTO, alpha state from 2011, don't use		* https://github.com/bellatrics/pyPLUTO, alpha state from 2011, don't use
	* https://github.com/coolastro/pyPLUTO, version 1.0 from 2012, don't use		* https://github.com/coolastro/pyPLUTO, version 1.0 from 2012, don't use
	* https://gitlab.mpcdf.mpg.de/sdoetsch/pypluto, modified version 4.4, maintained until 2022		* https://gitlab.mpcdf.mpg.de/sdoetsch/pypluto, modified version 4.4, maintained until 2022 (← use ''this'')
	* ... ← use ''this''

	Change in API for versions > 4.1: <code>import pyPLUTO.pload as pp</code> instead of		Change in API for versions > 4.1: <code>import pyPLUTO.pload as pp</code> instead of
	<code>import pyPLUTO as pp<code>		<code>import pyPLUTO as pp<code>

Lothar.brendel: versions, API change

2024-03-19T12:25:54Z

versions, API change

← Older revision		Revision as of 14:25, 19 March 2024
Line 1:		Line 1:
	... exists in different versions from different sources:		... exists in different versions from different sources:

	* https://github.com/bellatrics/pyPLUTO is from 2011, don't use		* https://github.com/bellatrics/pyPLUTO, alpha state from 2011, don't use
	* https://github.com/coolastro/pyPLUTO is from 2012, don't use		* https://github.com/coolastro/pyPLUTO, version 1.0 from 2012, don't use
	* https://gitlab.mpcdf.mpg.de/sdoetsch/pypluto ~~was~~ maintained until 2022		* https://gitlab.mpcdf.mpg.de/sdoetsch/pypluto, modified version 4.4, maintained until 2022
	* ... ← use ''this''		* ... ← use ''this''

			Change in API for versions > 4.1: <code>import pyPLUTO.pload as pp</code> instead of
			<code>import pyPLUTO as pp<code>

Lothar.brendel: - header

2024-03-19T11:09:27Z

- header

← Older revision		Revision as of 13:09, 19 March 2024
Line 1:		Line 1:
	~~= pyPLUTO =~~

	... exists in different versions from different sources:		... exists in different versions from different sources: