Commit 58eeecc0 authored by Zolnierczuk, Piotr's avatar Zolnierczuk, Piotr
Browse files

updated readme

parent 951648dd
Loading
Loading
Loading
Loading
+1 −1
Original line number Diff line number Diff line
@@ -35,7 +35,7 @@ install-user: build-ui
uninstall:
	pip uninstall $(PROJNAME)

est:	runtest
test:	runtest

runtest:
	@PYTHONPATH=.  $(PYTHON) -m pytest ./test
+23 −26
Original line number Diff line number Diff line
@@ -2,41 +2,38 @@
pysen
-------

PySEN is a Python package that aids experiment planning, data collection, reduction, and analysis 
``pysen`` is a Python package that aids experiment planning, data collection, reduction, and analysis
at the Neutron Spin Echo instrument (SNS-NSE) located at Beam Line 15
of the First Target Station at the Spallation Neutron Source.

The PySEN software package is written in Python . It grew out of scripts that were written 
The pysen software package is written in Python . It grew out of scripts that were written
to aid instrument staff in planning, executing, and evaluating experiments performed at SNS-NSE spectrometer,
Oak Ridge National Laboratory, but hopefully will be useful for all NSE users.
The source code is available at the ORNL git repository https://code.ornl.gov/zp1/pysen.

## Installation
PySEN requires Python 3.7 or newer. Table below shows Python packages that are required to run PySEN.
pysen requires Python 3.10 or newer. Table below shows Python packages that are required to run pysen.
One of the simplest methods to install Python is to download Anaconda Python (anaconda.com).

|Package     | Minimal version |
|------------|-----------------|
|numpy	     |   1.16          |
|scipy	     |   1.2           |
|matplotlib  |   3.0           |	
|h5py        |   2.9           |
|pandas	     |   0.24          |
|PyQt	     |   5.9           |
|pip	     |  19.0           | 
|Package     | Tested version |
|------------|----------------|
|numpy	     |   1.26         |
|scipy	     |   1.15         |
|matplotlib  |   3.10         |
|h5py        |   3.12         |
|pandas	     |   2.2          |
|qtpy	     |   2.4          |
|PyQt	     |   5.9 (or 6.x) |
|qtconsole   |   5.6.1        |
|pip	     |  25.1          |


### Steps

1. Download PySEN from https://code.ornl.gov/zp1/pysen
1. Download or clone pysen from https://code.ornl.gov/zp1/pysen

2. Open a terminal and navigate to the directory, where PySEN sources reside. 
2. Navigate to the directory, where pysen was unpacked

3. Type the following command:
	
	`pip install .`

	or for a “per-user” installation

	`pip install –user `
3. Use pip to install pysen
	`pip install .`  or

bin/find_deps.sh

0 → 100755
+15 −0
Original line number Diff line number Diff line
#!/bin/bash

topmod="pysen"

deps=$(find ${topmod} -name '*.py' |xargs grep import | cut -f2 -d: | grep -v '^#' | grep -v 'from\s*\.' | cut -f 2 -d\ |sort -u  | cut -f1 -d\. | sort -u |grep -v ${topmod})

for m in $deps; do 
	res=$(python -c "import sys; print('${m}' in sys.stdlib_module_names)")
	if [ "${res}" != "True" ]; then
		echo "$m"
	fi
done


+1 −1
Original line number Diff line number Diff line
@@ -3,7 +3,7 @@ PySEN revision module
"""
import sys
__version__  = "2.0"
__release__  = ".1"
__release__  = ".2b1"
__date__     = "June 2, 2025"

def version(full=False):
+1 −1
Original line number Diff line number Diff line
@@ -49,7 +49,7 @@ setup(
      scripts       = [
        'scripts/pysen_completion',
      ],
      install_requires = ['numpy', 'scipy', 'matplotlib', 'pandas', 'h5py' , 'qtconsole'],
      install_requires = ['numpy', 'scipy', 'matplotlib', 'pandas', 'h5py' , 'qtpy', 'qtconsole'],
      #for development and  testing 
      #requires 'sphinx', 'pytest', 'pylint' 'coverage' 
      license = 'BSD 3-Clause License',