schain Files · README.md · Jicamarca Repository

Fix python 2 compatibility

Juan C. Espinoza - - Load All Authors

File last commit:

r1329:16056ee07511


                r1333:ac63616fef28

v3.0.0b2

Download file

             README.md
        
                    102 lines
            
             | 2.4 KiB
            
                | text/x-minidsrc
            
             |
                MarkdownLexer
            
             / README.md
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        jespinoza
    
Update README and restore parallel script

              r887
            
      # Signal Chain

        Juan C. Espinoza
    
Add license, update setup and changelog

              r1329
            
      Signal Chain is a radar data processing library wich includes modules to read,

      and write different files formats, besides modules to process and visualize the

      data.

        jespinoza
    
Update README and restore parallel script

              r887
            
        Juan C. Espinoza
    
Add license, update setup and changelog

              r1329
            
      ## Dependencies

        jespinoza
    
Update README and restore parallel script

              r887
            
        Juan C. Espinoza
    
Update README

              r1289
            
      - GCC (gcc or gfortran)

      - Python.h (python-dev or python-devel)

      - Python-TK (python-tk)

      - HDF5 libraries (libhdf5-dev)

        Juan C. Espinoza
    
Add license, update setup and changelog

              r1329
            
      ## Installation

        jespinoza
    
Update README and restore parallel script

              r887
            
        Juan C. Espinoza
    
Add license, update setup and changelog

              r1329
            
      To get started the easiest way to install it is through [PyPI](https://pypi.org/project/schainpy/) with pip:

      ```bash

      pip install schainpy

        José Chávez
    
pyqt4 verification

              r1102
            
      ```

        Juan C. Espinoza
    
Add license, update setup and changelog

              r1329
            
      ### From source

        Juan C. Espinoza
    
Create Dockerfile

              r1118
            
        Juan C. Espinoza
    
Add license, update setup and changelog

              r1329
            
      First, ensure that you have the above-listed dependencies installed, then clone

      the repository and install as normal python package:

        Juan C. Espinoza
    
Create Dockerfile

              r1118
            
        Juan C. Espinoza
    
Add license, update setup and changelog

              r1329
            
      ```bash

      git clone https://github.com/JRO-Peru/schain.git

      cd schain

      git checkout `branch-name` (optional)

      sudo pip install ./

        Juan C. Espinoza
    
Create Dockerfile

              r1118
            
      ```

        Juan C. Espinoza
    
Add license, update setup and changelog

              r1329
            
      ### Using Docker

      Download Dockerfile from the repository, and create a docker image:

      ```bash

      docker build -t schain .

        Juan C. Espinoza
    
Create Dockerfile

              r1118
            
      ```

        Juan C. Espinoza
    
Add license, update setup and changelog

              r1329
            
      You can run a container using an xml file or a schain script also you need to

      mount a volume for the data input and for the output files/plots:

      ```bash

      docker run -it --rm --volume /path/to/host/data:/data schain xml /data/test.xml

      docker run -it --rm --volume /path/to/host/data:/data --entrypoint /urs/local/bin/python schain /data/test.py

        Juan C. Espinoza
    
Create Dockerfile

              r1118
            
      ```

        Juan C. Espinoza
    
Update README

              r1289
            
      ## CLI (command line interface)

      Signal Chain provides the following commands:

      - schainGUI: Open the GUI

      - schain: Signal chain command line

        Juan C. Espinoza
    
Add license, update setup and changelog

              r1329
            
      ## Example

        Juan C. Espinoza
    
Update README

              r1289
            
        Juan C. Espinoza
    
Add license, update setup and changelog

              r1329
            
      Here you can find an script to read Spectra data (.pdata), remove dc and plot

      self-spectra & RTI:

        jespinoza
    
Update README and restore parallel script

              r887
            
      ```python

      #!/usr/bin/python

      from schainpy.controller import Project

        Juan C. Espinoza
    
Update README

              r1289
            
      prj = Project()

        jespinoza
    
Update README and restore parallel script

              r887
            
        Juan C. Espinoza
    
Update README

              r1289
            
      read_unit = prj.addReadUnit(

          datatype='Spectra',

          path='/path/to/pdata/',

          startDate='2014/01/31',

          endDate='2014/03/31',

          startTime='00:00:00',

          endTime='23:59:59',

          online=0,

          walk=0

          )

        Juan C. Espinoza
    
Add license, update setup and changelog

              r1329
            
      proc_unit = prj.addProcUnit(

          datatype='Spectra',

          inputId=read_unit.getId()

          )

        jespinoza
    
Update README and restore parallel script

              r887
            
      op = proc_unit.addOperation(name='selectChannels')

        Juan C. Espinoza
    
Update README

              r1289
            
      op.addParameter(name='channelList', value='0,1')

        jespinoza
    
Update README and restore parallel script

              r887
            
      op = proc_unit.addOperation(name='selectHeights')

        Juan C. Espinoza
    
Update README

              r1289
            
      op.addParameter(name='minHei', value='80')

      op.addParameter(name='maxHei', value='200')

        jespinoza
    
Update README and restore parallel script

              r887
            
      op = proc_unit.addOperation(name='removeDC')

        Juan C. Espinoza
    
Update README

              r1289
            
      op = proc_unit.addOperation(name='SpectraPlot')

        jespinoza
    
Update README and restore parallel script

              r887
            
      op.addParameter(name='wintitle', value='Spectra', format='str')

        Juan C. Espinoza
    
Update README

              r1289
            
      op = procUnitConfObj1.addOperation(name='RTIPlot')

        jespinoza
    
Update README and restore parallel script

              r887
            
      op.addParameter(name='wintitle', value='RTI', format='str')

        Juan C. Espinoza
    
Update README

              r1289
            
      prj.start()

        jespinoza
    
Update README and restore parallel script

              r887
            
        Juan C. Espinoza
    
Add license, update setup and changelog

              r1329
            
      ```

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

jespinoza Update README and restore parallel script	r887	# Signal Chain

Juan C. Espinoza Add license, update setup and changelog	r1329	Signal Chain is a radar data processing library wich includes modules to read,
		and write different files formats, besides modules to process and visualize the
		data.
jespinoza Update README and restore parallel script	r887
Juan C. Espinoza Add license, update setup and changelog	r1329	## Dependencies
jespinoza Update README and restore parallel script	r887
Juan C. Espinoza Update README	r1289	- GCC (gcc or gfortran)
		- Python.h (python-dev or python-devel)
		- Python-TK (python-tk)
		- HDF5 libraries (libhdf5-dev)

Juan C. Espinoza Add license, update setup and changelog	r1329	## Installation
jespinoza Update README and restore parallel script	r887
Juan C. Espinoza Add license, update setup and changelog	r1329	To get started the easiest way to install it is through [PyPI](https://pypi.org/project/schainpy/) with pip:

		```bash
		pip install schainpy
José Chávez pyqt4 verification	r1102	```

Juan C. Espinoza Add license, update setup and changelog	r1329	### From source
Juan C. Espinoza Create Dockerfile	r1118
Juan C. Espinoza Add license, update setup and changelog	r1329	First, ensure that you have the above-listed dependencies installed, then clone
		the repository and install as normal python package:
Juan C. Espinoza Create Dockerfile	r1118
Juan C. Espinoza Add license, update setup and changelog	r1329	```bash
		git clone https://github.com/JRO-Peru/schain.git
		cd schain
		git checkout `branch-name` (optional)
		sudo pip install ./
Juan C. Espinoza Create Dockerfile	r1118	```

Juan C. Espinoza Add license, update setup and changelog	r1329	### Using Docker

		Download Dockerfile from the repository, and create a docker image:

		```bash
		docker build -t schain .
Juan C. Espinoza Create Dockerfile	r1118	```
Juan C. Espinoza Add license, update setup and changelog	r1329
		You can run a container using an xml file or a schain script also you need to
		mount a volume for the data input and for the output files/plots:

		```bash
		docker run -it --rm --volume /path/to/host/data:/data schain xml /data/test.xml
		docker run -it --rm --volume /path/to/host/data:/data --entrypoint /urs/local/bin/python schain /data/test.py
Juan C. Espinoza Create Dockerfile	r1118	```

Juan C. Espinoza Update README	r1289	## CLI (command line interface)

		Signal Chain provides the following commands:

		- schainGUI: Open the GUI
		- schain: Signal chain command line

Juan C. Espinoza Add license, update setup and changelog	r1329	## Example
Juan C. Espinoza Update README	r1289
Juan C. Espinoza Add license, update setup and changelog	r1329	Here you can find an script to read Spectra data (.pdata), remove dc and plot
		self-spectra & RTI:
jespinoza Update README and restore parallel script	r887
		```python
		#!/usr/bin/python

		from schainpy.controller import Project

Juan C. Espinoza Update README	r1289	prj = Project()
jespinoza Update README and restore parallel script	r887
Juan C. Espinoza Update README	r1289	read_unit = prj.addReadUnit(
		datatype='Spectra',
		path='/path/to/pdata/',
		startDate='2014/01/31',
		endDate='2014/03/31',
		startTime='00:00:00',
		endTime='23:59:59',
		online=0,
		walk=0
		)

Juan C. Espinoza Add license, update setup and changelog	r1329	proc_unit = prj.addProcUnit(
		datatype='Spectra',
		inputId=read_unit.getId()
		)
jespinoza Update README and restore parallel script	r887
		op = proc_unit.addOperation(name='selectChannels')
Juan C. Espinoza Update README	r1289	op.addParameter(name='channelList', value='0,1')
jespinoza Update README and restore parallel script	r887
		op = proc_unit.addOperation(name='selectHeights')
Juan C. Espinoza Update README	r1289	op.addParameter(name='minHei', value='80')
		op.addParameter(name='maxHei', value='200')
jespinoza Update README and restore parallel script	r887
		op = proc_unit.addOperation(name='removeDC')

Juan C. Espinoza Update README	r1289	op = proc_unit.addOperation(name='SpectraPlot')
jespinoza Update README and restore parallel script	r887	op.addParameter(name='wintitle', value='Spectra', format='str')

Juan C. Espinoza Update README	r1289	op = procUnitConfObj1.addOperation(name='RTIPlot')
jespinoza Update README and restore parallel script	r887	op.addParameter(name='wintitle', value='RTI', format='str')

Juan C. Espinoza Update README	r1289	prj.start()
jespinoza Update README and restore parallel script	r887
Juan C. Espinoza Add license, update setup and changelog	r1329	```