ebf_demo.f90

Go to the documentation of this file.

!* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
!* Author: Sanjib Sharma                                                     *
!* Copyright (c) 2012 Sanjib Sharma                                          *
!* All rights reserved.                                                      *
!*                                                                           *
!* This file is part of EBF.  The full EBF copyright notice, including       *
!* terms governing use, modification, and redistribution, is contained in    *
!* the files COPYING and COPYRIGHT, which can be found at the root           *
!* of the source code distribution tree.                                     *
!-----------------------------------------------------------------------------
!     example program to data from an ebf file
!-----------------------------------------------------------------------------





    subroutine ebf_demo
      USE ebf
      IMPLICIT NONE
!------------------------------------------------------------------------------
      ! arrays to be written
      integer (kind=4),dimension(:),allocatable:: x0
      integer (kind=4),dimension(:),allocatable:: x1
      integer (kind=8),dimension(:,:),allocatable:: x2
      integer (kind=8),dimension(:,:,:),allocatable:: x3
      ! arrays in which the data will be read
      real (kind=8),dimension(:),allocatable:: y0
      real (kind=8),dimension(:),allocatable:: y1
      real (kind=8),dimension(:,:),allocatable:: y2
      real (kind=8),dimension(:,:,:),allocatable:: y3
      ! and ebf header and ebffile structure needed for partial I/0
      ! type(ebfheader):: ebfh
      type(ebfdatainfo):: dinfo
      type(ebffile)::efile
      integer (kind=8),dimension(2):: mydims
      ! loop and temporary variables
      character (len=100)::temp,temp1
      integer(kind=4):: i,j,k,l
      logical unitok,unitop

!      OPEN(UNIT=i, FILE="check.txt",STATUS="REPLACE", ACCESS="STREAM", FORM="unformatted",action="READWRITE")

      ! generate 1d array
      allocate(x0(100))
      DO i=1,size(x0)
        x0(i)=i
      end do

      ! generate another 1d array
      allocate(x1(2))
      DO i=1,size(x1)
        x1(i)=i
      end do

      ! generate 2d array
      allocate(x2(2,3))
      l=1
      DO j=1,size(x2,2)
      DO i=1,size(x2,1)
        x2(i,j)=l
        l=l+1
      end do
      end do

      ! generate 3d array
      allocate(x3(2,3,4))
      l=1
      DO k=1,size(x3,3)
      DO j=1,size(x3,2)
      DO i=1,size(x3,1)
        x3(i,j,k)=l
        l=l+1
      end do
      end do
      end do

      ! write a data , type is integer(kind=4)
      call ebf_write("check.ebf","/x1",x1)
      ! append 2d  data  with units, type is integer(kind=8)
      call ebf_write("check.ebf","/x2",x2,"a","m/s")
      ! append 3d data  with units, type is integer(kind=8)
      call ebf_write("check.ebf","/x3",x3,"a","100 km/s")


      ! read data  as double and print data and units
      call ebf_read("check.ebf","/x1",y1,dinfo)
      print *,"y1 units:", dinfo%dataunit
      print *,"y1 data", y1

      ! check before reading
      if(ebf_containskey("check.ebf","/x1")) then
          call ebf_read("check.ebf","/x1",y1,dinfo)
      endif

      ! Also if one wants to query data info before reading
      if(ebf_containskey("check.ebf","/x1",dinfo)) then
          print *,"y1 units:"  , dinfo%dataunit
          print *,"y1 elements", dinfo%elements
          call ebf_read("check.ebf","/x1",y1,dinfo)
      endif

      ! read 2d data as double and print data and units
      call ebf_read("check.ebf","/x2",y2,dinfo)
      print *,"y2 units:", dinfo%dataunit
      print *,"y2 data", y2

      ! read 3d data as double and print data and units
      call ebf_read("check.ebf","/x3",y3,dinfo)
      print *,"y3 units:", dinfo%dataunit
      print *,"y3 data", y3


      ! write data using partial I/O,
      ! a 1d array of size=10+size(x2) will be written
      call ebffile_open(efile,"check1.ebf","/test/x1","w",5,"m/s")
      call ebffile_write(efile,x1(1:10))
      call ebffile_write(efile,x2)
      call ebffile_close(efile)
      ! write 2d data, the last dim is adjusted automatically
      mydims(1)=16
      mydims(2)=0
      print *,size(x1)
      call ebffile_open(efile,"check1.ebf","/test/x2","a",5,"m/s",mydims)
      call ebffile_write(efile,x1)
      call ebffile_close(efile)

      ! print summary of files and check the dimensions
      call ebf_info("check1.ebf")
      call ebf_info("check.ebf")

      ! write a 100 element array for test
      call ebf_write("check.ebf","/x0",x0,"w","km/s")
      ! read elements 11 to 15 into y0(21:25)
      ! and the following elements 16-20 into y(26:30)
      call ebffile_open(efile,"check.ebf","/x0")
      allocate(y0(ebfheader_elements(efile%ebfh)))
      call ebffile_read(efile,y1(21:25),int(11,kind=8))
      call ebffile_read(efile,y1(26:30))
      call ebffile_close(efile)
      print *,y1(21:30)
      ! print data units
      print *,"data units of /x0 are: ",efile%ebfh%dataunit



      ! write and read a string
      call ebf_write('check.ebf','/xstr',"Hello, World!","a")
      call ebf_read('check.ebf','/xstr',temp)
      print *,'string is ',temp


      call ebf_info("check.ebf")

      ! To read write string array write them as character arrays
      ! To convert from string to character array and vice versa
      ! see subroutines estr2char and echar2str


    end subroutine ebf_demo


!  To compile and call as a program uncomment below

!    program demo
!    call ebf_demo()
!    END program demo

---