<filename>Python/examples/write_extended.py
# write_extended.py: Example of writing an extended pradformat HDF5 file
#   That is, adding your own non-pradformat datasets and attributes to the
#       pradformat HDF5 file

import os
import h5py
import numpy as np
import pradformat as prf

## Construct pradformat object
fld = prf.SimpleFields()

## Create some 3D test matrices
nx = 100
ny = 150
nz = 125
x = np.linspace(-10.0, 10.0, nx)
y = np.linspace(-15.0, 15.0, ny)
z = np.linspace(-12.5, 12.5, nz)
[X,Y,Z] = np.meshgrid(x,y,z)

## Set pradformat datasets and attributes
fld.X = X # required | X values | meters
fld.Y = Y # required | Y values | meters
fld.Z = Z # required | Z values | meters
fld.Ex = X**2 + Y**2 # required | Electric field, x-component | Volts/meter
fld.Ey = 0.0 # required | Electric field, y-component | Volts/meter
fld.Ez = 5.823 * X**2 + Z**2 # required | Electric field, z-component | Volts/meter
fld.Bx = X**4 + Z**2 # required | Magnetic field, x-component | Tesla
fld.By = 2.191 + Y + Z**2 # required | Magnetic field, y-component | Tesla
fld.Bz = 8.123 # required | Magnetic field, z-component | Tesla
fld.rho = X + Y + Z # optional | Mass density | kg / m**3

# print(fld.object_type) # already-set | Specification of the HDF5 object type | "fields" (always this value)
# print(fld.fields_type) # already-set | Specification of the fields sub-type | "simple" (always this value)
# print(fld.pradformat_version) # already-set | HDF5 pradformat file format version followed | e.g. "0.1.0"

fld.rho_description = "Six-ionized CH plasma and chamber walls"
fld.label = "Fields_10" # optional | Short, identifying label for this file (with no spaces or crazy characters). This can be stamped onto plots, etc.
fld.description = "Fields test example with lots of X, Y, and Z dependence." # optional | Longer description of this file. This can be read by people trying to figure out where this file came from.
# print(fld.file_date) # automatically-set | Date the (future) file will be created, in the format "YYYY-MM-DD" | You don't need to set this, it will be set automatically
# fld.raw_data_filename = "SimulationMain/DISC_OMEGA/chk0013" # optional | Filename of the raw data file (e.g. simulation output) from which this derivative file was created, if applicable.

## Create some custom, non-pradformat datasets and attributes
nele = X**3 # electron density
nion = Y + Z**2 # ion density
run_number = 5 # simulation run number for this dataset

## Save pradformat object to HDF5 file
if not os.path.isdir("outs"):
    os.mkdir("outs")
h5filename = os.path.join('outs', 'myextendedfields.h5')
fld.save(h5filename)

## Append your custom, non-pradformat datasets and attributes to the HDF5 file
with h5py.File(h5filename, 'a') as f:
    f.create_dataset('nele', data=nele, compression="gzip", compression_opts=4)
    f.create_dataset('nion', data=nion, compression="gzip", compression_opts=4)
    f.attrs['run_number'] = run_number
<filename>Python/examples/write_extended.py
# write_extended.py: Example of writing an extended pradformat HDF5 file
#   That is, adding your own non-pradformat datasets and attributes to the
#       pradformat HDF5 file

import os
import h5py
import numpy as np
import pradformat as prf

## Construct pradformat object
fld = prf.SimpleFields()

## Create some 3D test matrices
nx = 100
ny = 150
nz = 125
x = np.linspace(-10.0, 10.0, nx)
y = np.linspace(-15.0, 15.0, ny)
z = np.linspace(-12.5, 12.5, nz)
[X,Y,Z] = np.meshgrid(x,y,z)

## Set pradformat datasets and attributes
fld.X = X # required | X values | meters
fld.Y = Y # required | Y values | meters
fld.Z = Z # required | Z values | meters
fld.Ex = X**2 + Y**2 # required | Electric field, x-component | Volts/meter
fld.Ey = 0.0 # required | Electric field, y-component | Volts/meter
fld.Ez = 5.823 * X**2 + Z**2 # required | Electric field, z-component | Volts/meter
fld.Bx = X**4 + Z**2 # required | Magnetic field, x-component | Tesla
fld.By = 2.191 + Y + Z**2 # required | Magnetic field, y-component | Tesla
fld.Bz = 8.123 # required | Magnetic field, z-component | Tesla
fld.rho = X + Y + Z # optional | Mass density | kg / m**3

# print(fld.object_type) # already-set | Specification of the HDF5 object type | "fields" (always this value)
# print(fld.fields_type) # already-set | Specification of the fields sub-type | "simple" (always this value)
# print(fld.pradformat_version) # already-set | HDF5 pradformat file format version followed | e.g. "0.1.0"

fld.rho_description = "Six-ionized CH plasma and chamber walls"
fld.label = "Fields_10" # optional | Short, identifying label for this file (with no spaces or crazy characters). This can be stamped onto plots, etc.
fld.description = "Fields test example with lots of X, Y, and Z dependence." # optional | Longer description of this file. This can be read by people trying to figure out where this file came from.
# print(fld.file_date) # automatically-set | Date the (future) file will be created, in the format "YYYY-MM-DD" | You don't need to set this, it will be set automatically
# fld.raw_data_filename = "SimulationMain/DISC_OMEGA/chk0013" # optional | Filename of the raw data file (e.g. simulation output) from which this derivative file was created, if applicable.

## Create some custom, non-pradformat datasets and attributes
nele = X**3 # electron density
nion = Y + Z**2 # ion density
run_number = 5 # simulation run number for this dataset

## Save pradformat object to HDF5 file
if not os.path.isdir("outs"):
    os.mkdir("outs")
h5filename = os.path.join('outs', 'myextendedfields.h5')
fld.save(h5filename)

## Append your custom, non-pradformat datasets and attributes to the HDF5 file
with h5py.File(h5filename, 'a') as f:
    f.create_dataset('nele', data=nele, compression="gzip", compression_opts=4)
    f.create_dataset('nion', data=nion, compression="gzip", compression_opts=4)
    f.attrs['run_number'] = run_number
# write_extended.py: Example of writing an extended pradformat HDF5 file #   That is, adding your own non-pradformat datasets and attributes to the #       pradformat HDF5 file ## Construct pradformat object ## Create some 3D test matrices ## Set pradformat datasets and attributes # required | X values | meters # required | Y values | meters # required | Z values | meters # required | Electric field, x-component | Volts/meter # required | Electric field, y-component | Volts/meter # required | Electric field, z-component | Volts/meter # required | Magnetic field, x-component | Tesla # required | Magnetic field, y-component | Tesla # required | Magnetic field, z-component | Tesla # optional | Mass density | kg / m**3 # print(fld.object_type) # already-set | Specification of the HDF5 object type | "fields" (always this value) # print(fld.fields_type) # already-set | Specification of the fields sub-type | "simple" (always this value) # print(fld.pradformat_version) # already-set | HDF5 pradformat file format version followed | e.g. "0.1.0" # optional | Short, identifying label for this file (with no spaces or crazy characters). This can be stamped onto plots, etc. # optional | Longer description of this file. This can be read by people trying to figure out where this file came from. # print(fld.file_date) # automatically-set | Date the (future) file will be created, in the format "YYYY-MM-DD" | You don't need to set this, it will be set automatically # fld.raw_data_filename = "SimulationMain/DISC_OMEGA/chk0013" # optional | Filename of the raw data file (e.g. simulation output) from which this derivative file was created, if applicable. ## Create some custom, non-pradformat datasets and attributes # electron density # ion density # simulation run number for this dataset ## Save pradformat object to HDF5 file ## Append your custom, non-pradformat datasets and attributes to the HDF5 file