schain Commit - r1329:16056ee07511 · Jicamarca Repository

Add license, update setup and changelog

Juan C. Espinoza -

r1329:16056ee07511

parent child

Context file:

r1329:16056ee07511

Collapse all files

LICENSE created 644 +28 0

@@ -0,0 +1,28
	1	This software, unless otherwise noted, is licensed under the BSD 3-clause.
	2
	3	Copyright (c) 2012-2020 Jicamarca Radio Observatory
	4
	5	Redistribution and use in source and binary forms, with or without
	6	modification, are permitted provided that the following conditions are met:
	7
	8	* Redistributions of source code must retain the above copyright notice, this
	9	list of conditions and the following disclaimer.
	10
	11	* Redistributions in binary form must reproduce the above copyright notice,
	12	this list of conditions and the following disclaimer in the documentation
	13	and/or other materials provided with the distribution.
	14
	15	* Neither the name of the copyright holder nor the names of its
	16	contributors may be used to endorse or promote products derived from
	17	this software without specific prior written permission.
	18
	19	THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
	20	AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	21	IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
	22	DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
	23	FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	24	DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
	25	SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
	26	CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
	27	OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
	28	OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

.gitignore 0 -12

@@ -100,15 +100,3 ENV/
100	# eclipse	100	# eclipse
101	.project	101	.project
102	.pydevproject	102	.pydevproject
103	# vscode
104
105	.vscode
106
107	schaingui/node_modules/
108	schainpy/scripts/
109	.svn/
110	*.png
111	*.pyc
112	.vscode
113	trash
114	*.log

CHANGELOG.md +29 -7

-            # CHANGELOG:
+            # CHANGELOG
+            ## 3.0.0
-            ## 3.0
             * Python 3.x & 2.X compatible
             * New architecture with multiprocessing support
             * Add @MPDecorator for multiprocessing Operations (Plots, Writers and Publishers)
             * Added new type of operation `external` for non-locking operations
             * New plotting architecture with buffering/throttle capabilities to speed up plots
             * Clean controller to optimize scripts (format & optype are no longer required)
+            * Replace ParamReader and ParamWriter with new flexible HDFReader and HDFWriter
             * New GUI with dinamic load of Units and operations (use Kivy framework)
+            * Clean code
             ## 2.3
             * Added support for Madrigal formats (reading/writing).
             * Added support for reading BLTR parameters (*.sswma).
             * Added support for reading Julia format (*.dat).
             * Added two new Processing Units `PublishData` and `ReceiverData` for receiving and sending dataOut through multiple ways (tcp, ipc, inproc).
             * Added a new graphics Processing Unit `PlotterReceiver`. It is decoupled from normal processing sequence with support for data generated by multiprocessing scripts.
             * Added support for sending realtime graphic to web server.
             * GUI command `schain` is now `schainGUI`.
             * Added a CLI tool named `schain`.
-            	* Scripts templates can be now generated with `schain generate`.
+              * Scripts templates can be now generated with `schain generate`.
-            	* Now it is possible to search Processing Units and Operations with `schain search [module]` to get the right name and its allowed parameters.
+              * Now it is possible to search Processing Units and Operations with `schain search [module]` to get the right name and its allowed parameters.
-            	* `schain xml` to run xml scripts.
+              * `schain xml` to run xml scripts.
             * Added suggestions when parameters are poorly written.
             * `Controller.start()` now runs in a different process than the process calling it.
             * Added `schainpy.utils.log` for log standarization.
             * Setup now installs numpy.
             ## 2.2.6
             * Graphics generated by the GUI are now the same as generated by scripts. Issue #1074.
             * Added support for C extensions.
             * Function `hildebrand_sehkon` optimized with a C wrapper.
             * Migration to GIT.
             ## 2.2.5:
             * splitProfiles and combineProfiles modules were added to VoltageProc and Signal Chain GUI.
             * nProfiles of USRP data (hdf5) is the number of profiles thera are in one second.
             * jroPlotter works directly with data objects instead of dictionaries
             * script "schain" was added to Signal Chain installer
             ## 2.2.4.1:
             * jroIO_usrp.py is update to read Sandra's data
             * decimation in Spectra and RTI plots is always enabled.
             * time* window option added to GUI
             ## 2.2.4:
             * jroproc_spectra_lags.py added to schainpy
             * Bug fixed in schainGUI: ProcUnit was created with the same id in some cases.
             * Bug fixed in jroHeaderIO: Header size validation.
             ## 2.2.3.1:
             * Filtering block by time has been added.
             * Bug fixed plotting RTI, CoherenceMap and others using xmin and xmax parameters. The first day worked
             properly but the next days did not.
             ## 2.2.3:
             * Bug fixed in GUI: Error getting(reading) Code value
             * Bug fixed in GUI: Flip option always needs channelList field
             * Bug fixed in jrodata: when one branch modified a value in "dataOut" (example: dataOut.code) this value
             * Bug fixed in jroproc_voltage.profileSelector(): rangeList replaces to profileRangeList.
             ## 2.2.2:
             * VoltageProc: ProfileSelector, Reshape, Decoder with nTxs!=1 and getblock=True was tested
             * Rawdata and testRawdata.py added to Signal Chain project
             ## 2.2.1:
             * Bugs fixed in GUI
             * Views were improved in GUI
             * Support to MST* ISR experiments
             * handleError added to jroplotter.py
             ## 2.2.0:
             * GUI: use of external plotter
             * Compatible with matplotlib 1.5.0
             ## 2.1.5:
             * serializer module added to Signal Chain
             * jroplotter.py added to Signal Chain
             ## 2.1.4.2:
             * A new Plotter Class was added
             * Project.start() does not accept filename as a parameter anymore
             ## 2.1.4.1:
             * Send notifications when an error different to ValueError is detected
             ## 2.1.4:
             * Sending error notifications to signal chain administrator
             * Login to email server added
             ## 2.1.3.3:
             * Colored Button Icons were added to GUI
             ## 2.1.3.2:
             * GUI: user interaction enhanced
             * controller_api.py: Safe access to ControllerThead
             ## 2.1.3.1:
             * GUI: every icon were resized
             * jroproc_voltage.py: Print a message when "Read from code" option is selected and the code is not defined inside data file
             ## 2.1.3:
             * jroplot_heispectra.py: SpectraHeisScope was not showing the right channels
             * jroproc_voltage.py: Bug fixed selecting profiles (self.nProfiles took a wrong value),
             					 Bug fixed selecting heights by block (selecting profiles instead heights)
             * jroIO_heispectra.py: Channel index list does not exist.
             ## 2.1.2:
             * jroutils_ftp.py: Bug fixed, Any error sending file stopped the Server Thread
             				  Server thread opens and closes remote server each time file list is sent
             * jroplot_spectra.py: Noise path was not being created when noise data is saved.

README.md +38 -94

@@ -1,48 +1,50
1	# Signal Chain	1	# Signal Chain
2		2
3	## Introduction	3	Signal Chain is a radar data processing library wich includes modules to read,
		4	and write different files formats, besides modules to process and visualize the
		5	data.
4		6
5	Signal Chain (SCh) is a radar data processing library developed using [Python](www.python.org) at JRO. SCh provides modules to read, write, process and plot data.	7	## Dependencies
6		8
7	## Installation
8
9	Install system dependencies, clone the latest version from [here](http://jro-dev.igp.gob.pe/rhodecode/schain/) and install it as a normal python package, we strongly recommend to use Anaconda or a virtual environment for the installation.
10
11	### Dependencies
12	- GCC (gcc or gfortran)	9	- GCC (gcc or gfortran)
13	- Python.h (python-dev or python-devel)	10	- Python.h (python-dev or python-devel)
14	- Python-TK (python-tk)	11	- Python-TK (python-tk)
15	- HDF5 libraries (libhdf5-dev)	12	- HDF5 libraries (libhdf5-dev)
16		13
17	### Linux based system (e.g. ubuntu)	14	## Installation
18	```
19	$ git clone http://jro-dev.igp.gob.pe/rhodecode/schain/
20	$ cd schain
21	$ git checkout `schain-branch` (optional)
22	$ sudo pip install ./
23	```
24		15
25	### MAC Os	16	To get started the easiest way to install it is through [PyPI](https://pypi.org/project/schainpy/) with pip:
26	```	17
27	$ brew install python	18	```bash
28	$ git clone http://jro-dev.igp.gob.pe/rhodecode/schain/	19	pip install schainpy
29	$ cd schain
30	$ git checkout `schain-branch` (optional)
31	$ sudo pip install ./
32	```	20	```
33		21
34	### Docker	22	### From source
35		23
36	Download Dockerfile from the repository, and create a docker image	24	First, ensure that you have the above-listed dependencies installed, then clone
		25	the repository and install as normal python package:
37		26
		27	```bash
		28	git clone https://github.com/JRO-Peru/schain.git
		29	cd schain
		30	git checkout `branch-name` (optional)
		31	sudo pip install ./
38	```	32	```
39	$ docker build -t schain .
40	```
41		33
42	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	34	### Using Docker
		35
		36	Download Dockerfile from the repository, and create a docker image:
		37
		38	```bash
		39	docker build -t schain .
43	```	40	```
44	$ docker run -it --rm --volume /path/to/host/data:/data schain xml /data/test.xml	41
45	$ docker run -it --rm --volume /path/to/host/data:/data --entrypoint /urs/local/bin/python schain /data/test.py	42	You can run a container using an xml file or a schain script also you need to
		43	mount a volume for the data input and for the output files/plots:
		44
		45	```bash
		46	docker run -it --rm --volume /path/to/host/data:/data schain xml /data/test.xml
		47	docker run -it --rm --volume /path/to/host/data:/data --entrypoint /urs/local/bin/python schain /data/test.py
46	```	48	```
47		49
48	## CLI (command line interface)	50	## CLI (command line interface)
@@ -52,12 +54,10 Signal Chain provides the following commands:
52	- schainGUI: Open the GUI	54	- schainGUI: Open the GUI
53	- schain: Signal chain command line	55	- schain: Signal chain command line
54		56
		57	## Example
55		58
56	## First Script	59	Here you can find an script to read Spectra data (.pdata), remove dc and plot
57		60	self-spectra & RTI:
58	Here you can find an script to read Spectra data (.pdata), remove dc and plot spectra & RTI
59
60	First import SCh and creating a project
61		61
62	```python	62	```python
63	#!/usr/bin/python	63	#!/usr/bin/python
@@ -65,16 +65,7 First import SCh and creating a project
65	from schainpy.controller import Project	65	from schainpy.controller import Project
66		66
67	prj = Project()	67	prj = Project()
68	prj.setup(
69	id = '100',
70	name='test',
71	description='Basic experiment'
72	)
73	```
74		68
75	Add read unit and operations
76
77	```python
78	read_unit = prj.addReadUnit(	69	read_unit = prj.addReadUnit(
79	datatype='Spectra',	70	datatype='Spectra',
80	path='/path/to/pdata/',	71	path='/path/to/pdata/',
@@ -86,57 +77,10 read_unit = prj.addReadUnit(
86	walk=0	77	walk=0
87	)	78	)
88		79
89	proc_unit = prj.addProcUnit(datatype='Spectra', inputId=read_unit.getId())	80	proc_unit = prj.addProcUnit(
90		81	datatype='Spectra',
91	op = proc_unit.addOperation(name='selectChannels')	82	inputId=read_unit.getId()
92	op.addParameter(name='channelList', value='0,1')	83	)
93
94	op = proc_unit.addOperation(name='selectHeights')
95	op.addParameter(name='minHei', value='80')
96	op.addParameter(name='maxHei', value='200')
97
98	op = proc_unit.addOperation(name='removeDC')
99
100	```
101
102	Plot data & start project
103
104	```python
105	op = proc_unit.addOperation(name='SpectraPlot')
106	op.addParameter(name='id', value='1')
107	op.addParameter(name='wintitle', value='Spectra')
108
109	op = procUnitConfObj1.addOperation(name='RTIPlot')
110	op.addParameter(name='id', value='2')
111	op.addParameter(name='wintitle', value='RTI')
112
113	prj.start()
114
115	```
116
117	Full script
118
119
120	```python
121	#!/usr/bin/python
122
123	from schainpy.prj import Project
124
125	prj = Project()
126	prj.setup(id = '100',
127	name='test',
128	description='Basic experiment')
129	read_unit = prj.addReadUnit(datatype='Spectra',
130	path='/path/to/pdata/',
131	startDate='2014/01/31',
132	endDate='2014/03/31',
133	startTime='00:00:00',
134	endTime='23:59:59',
135	online=0,
136	walk=0)
137
138	proc_unit = prj.addProcUnit(datatype='Spectra',
139	inputId=read_unit.getId())
140		84
141	op = proc_unit.addOperation(name='selectChannels')	85	op = proc_unit.addOperation(name='selectChannels')
142	op.addParameter(name='channelList', value='0,1')	86	op.addParameter(name='channelList', value='0,1')
@@ -155,4 +99,4 op.addParameter(name='wintitle', value='RTI', format='str')
155		99
156	prj.start()	100	prj.start()
157		101
158	``` No newline at end of file	102	```

schainpy/__init__.py +4 -6

@@ -1,7 +1,5
1	'''	1	"""Signal chain python package"""
2	Created on Jul 3, 2018
3		2
4	@author $Author$	3	from .controller import Project
5	@version $Id$	4
6	'''	5	__version__ = '3.0.0'
7	__version__ = '3.0'

schainpy/controller.py +13 -5

-            '''
+            # Copyright (c) 2012-2020 Jicamarca Radio Observatory
-            Main routines to create a Signal Chain project
+            # All rights reserved.
-            '''
+            # Distributed under the terms of the BSD 3-clause license.
+            """API to create signal chain projects
+            The API is provide through class: Project
+            """
             import re
             import sys
             class Project(Process):
+                """API to create signal chain projects"""
                 ELEMENTNAME = 'Project'
                 def __init__(self):
-                    Process.__init__(self)
+                    Process.__init__(self, name='')
-                    self.id = None
+                    self.id = '1'
+                    if name:
+                        self.name = '{} ({})'.format(Process.__name__, name)
                     self.filename = None
                     self.description = None
                     self.email = None

setup.py +32 -9

@@ -1,15 +1,21
1	'''	1	# Copyright (c) 2012-2020 Jicamarca Radio Observatory
2	Created on Jul 16, 2014	2	# All rights reserved.
		3	#
		4	# Distributed under the terms of the BSD 3-clause license.
		5	"""schainpy is an open source library to read, write and process radar data
3		6
4	@author: Miguel Urco	7	Signal Chain is a radar data processing library wich includes modules to read,
5	@author: Juan C. Espinoza	8	and write different files formats, besides modules to process and visualize the
6	'''	9	data.
		10	"""
7		11
8	import os	12	import os
9	from setuptools import setup, Extension	13	from setuptools import setup, Extension
10	from setuptools.command.build_ext import build_ext as _build_ext	14	from setuptools.command.build_ext import build_ext as _build_ext
11	from schainpy import __version__	15	from schainpy import __version__
12		16
		17	DOCLINES = __doc__.split("\n")
		18
13	class build_ext(_build_ext):	19	class build_ext(_build_ext):
14	def finalize_options(self):	20	def finalize_options(self):
15	_build_ext.finalize_options(self)	21	_build_ext.finalize_options(self)
@@ -21,10 +27,27 class build_ext(_build_ext):
21	setup(	27	setup(
22	name = "schainpy",	28	name = "schainpy",
23	version = __version__,	29	version = __version__,
24	description = "Python tools to read, write and process Jicamarca data",	30	description = DOCLINES[0],
25	author = "Miguel Urco, Juan C. Espinoza",	31	long_description = "\n".join(DOCLINES[2:]),
26	author_email = "juan.espinoza@jro.igp.gob.pe",	32	url = "https://github.com/JRO-Peru/schain",
27	url = "http://jro-dev.igp.gob.pe/rhodecode/schain",	33	author = "Jicamarca Radio Observatory",
		34	author_email = "jro-developers@igp.gob.pe",
		35	license="BSD-3-Clause",
		36	classifiers=[
		37	"Development Status :: 4 - Beta",
		38	"Environment :: Console",
		39	"Intended Audience :: Science/Research",
		40	"License :: OSI Approved :: BSD License",
		41	"Operating System :: MacOS :: MacOS X",
		42	"Operating System :: POSIX :: Linux",
		43	"Programming Language :: Python :: 2",
		44	"Programming Language :: Python :: 2.7",
		45	"Programming Language :: Python :: 3",
		46	"Programming Language :: Python :: 3.5",
		47	"Programming Language :: Python :: 3.6",
		48	"Programming Language :: Python :: 3.7",
		49	"Topic :: Scientific/Engineering",
		50	],
28	packages = {	51	packages = {
29	'schainpy',	52	'schainpy',
30	'schainpy.model',	53	'schainpy.model',

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	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