tasvisan 0.1.2__tar.gz

tasvisan-0.1.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018-2026 Guochu Deng
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

tasvisan-0.1.2/PKG-INFO

@@ -0,0 +1,122 @@
+Metadata-Version: 2.4
+Name: tasvisan
+Version: 0.1.2
+Summary: Toolkit for data reduction, normalization, combination, visualization and analyis of triple-axis spectrometers, especially for Tapain and Sika
+Author-email: Guochu Deng <gc.deng.ansto@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/gcdengansto/TasVisAn
+Project-URL: Repository, https://github.com/gcdengansto/TasVisAn
+Keywords: neutron,scattering,resolution,inelastic,spectrometer,triple-axis
+Classifier: Programming Language :: Python :: 3
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.20
+Requires-Dist: matplotlib>=3.5
+Requires-Dist: scipy>=1.7
+Requires-Dist: pandas>=1.3
+Requires-Dist: lmfit>=1.0
+Requires-Dist: h5py>=3.0
+Requires-Dist: plotly>=5.0
+Requires-Dist: inspy-conv
+Requires-Dist: QtPy
+Requires-Dist: PySide6
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Dynamic: license-file
+
+# TasVisAn
+
+**TasVisAn** is a Python library for data reduction, visualization, and analysis of neutron triple-axis spectrometers (TASs), particularly for the thermal-neutron triple-axis spectrometer Taipan and cold-neutron triple-axis spectrometer Sika at Australian Centre for Neutron Scattering, ANSTO. It can also be used for other triple-axis spectrometers in other facilities, for example, the thermal-neutron triple-axis spectrometer BT7 and the cold-neutron triple-axis spectrometer BT4 at NIST. More triple-axis spectrometers will be supported soon.
+
+> Install name: `tasvisan`  
+> Import name: `tasvisan`
+
+---
+
+## 🚀 Installation
+
+```bash
+pip install tasvisan
+```
+
+## 📦 Usage
+```bash
+import tasvisan
+
+# Example usage
+# (replace with real functionality)
+result = tasvisan.do_something()
+print(result)
+```
+
+## 🎯 Features
+Modular design for scientific workflows
+Lightweight and easy to integrate into existing pipelines
+Designed for extensibility in research environments
+Compatible with NumPy-based data processing
+Friendly GUI for Data Browsing
+
+
+## 📁 Project Structure
+```bash
+tasvisan/
+├── src/tasvisan/     # Main package (import tasvisan)
+├── pyproject.toml    # Build configuration
+├── README.md
+└── LICENSE
+```
+
+## 🔬 Scope
+
+This package is intended for:
+
+> Triple-axis Spectrometer Data Reduction, Normalization, Visualization, and Analysis
+
+> Quick Data Combination and Contour Mapping
+
+> Resolution Convolution Fitting to Inelastic Neutron Scattering Data
+
+> Experimental Planning and Command Validation and Simulation
+
+> Data Reduction and 3D Visualization of Multiplexing and Multi-analyzer Triple-axis Spectrometers
+
+## 🛠️ Development
+
+Repository:
+
+https://github.com/gcdengansto/TasVisAn
+
+
+Install in editable mode:
+```bash
+pip install -e .
+```
+
+## 📖 Documentation
+
+Documentation is under development.
+Usage examples and tutorials can be found at https://github.com/gcdengansto/TasVisAn.
+
+## 🤝 Contributing
+
+Please contact the author for fixing bugs and adding additional functions
+
+
+## 📜 License
+
+This project is licensed under the MIT License — see the LICENSE file for details.
+
+## 👤 Author
+
+Guochu Deng
+
+Email: gc.deng.ansto@gmail.com
+
+## ⚠️ Disclaimer
+
+This software is provided for scientific research purposes.
+No guarantees are made regarding correctness or fitness for a particular application.

tasvisan-0.1.2/README.md

@@ -0,0 +1,92 @@
+# TasVisAn
+
+**TasVisAn** is a Python library for data reduction, visualization, and analysis of neutron triple-axis spectrometers (TASs), particularly for the thermal-neutron triple-axis spectrometer Taipan and cold-neutron triple-axis spectrometer Sika at Australian Centre for Neutron Scattering, ANSTO. It can also be used for other triple-axis spectrometers in other facilities, for example, the thermal-neutron triple-axis spectrometer BT7 and the cold-neutron triple-axis spectrometer BT4 at NIST. More triple-axis spectrometers will be supported soon.
+
+> Install name: `tasvisan`  
+> Import name: `tasvisan`
+
+---
+
+## 🚀 Installation
+
+```bash
+pip install tasvisan
+```
+
+## 📦 Usage
+```bash
+import tasvisan
+
+# Example usage
+# (replace with real functionality)
+result = tasvisan.do_something()
+print(result)
+```
+
+## 🎯 Features
+Modular design for scientific workflows
+Lightweight and easy to integrate into existing pipelines
+Designed for extensibility in research environments
+Compatible with NumPy-based data processing
+Friendly GUI for Data Browsing
+
+
+## 📁 Project Structure
+```bash
+tasvisan/
+├── src/tasvisan/     # Main package (import tasvisan)
+├── pyproject.toml    # Build configuration
+├── README.md
+└── LICENSE
+```
+
+## 🔬 Scope
+
+This package is intended for:
+
+> Triple-axis Spectrometer Data Reduction, Normalization, Visualization, and Analysis
+
+> Quick Data Combination and Contour Mapping
+
+> Resolution Convolution Fitting to Inelastic Neutron Scattering Data
+
+> Experimental Planning and Command Validation and Simulation
+
+> Data Reduction and 3D Visualization of Multiplexing and Multi-analyzer Triple-axis Spectrometers
+
+## 🛠️ Development
+
+Repository:
+
+https://github.com/gcdengansto/TasVisAn
+
+
+Install in editable mode:
+```bash
+pip install -e .
+```
+
+## 📖 Documentation
+
+Documentation is under development.
+Usage examples and tutorials can be found at https://github.com/gcdengansto/TasVisAn.
+
+## 🤝 Contributing
+
+Please contact the author for fixing bugs and adding additional functions
+
+
+## 📜 License
+
+This project is licensed under the MIT License — see the LICENSE file for details.
+
+## 👤 Author
+
+Guochu Deng
+
+Email: gc.deng.ansto@gmail.com
+
+## ⚠️ Disclaimer
+
+This software is provided for scientific research purposes.
+No guarantees are made regarding correctness or fitness for a particular application.

tasvisan-0.1.2/pyproject.toml

@@ -0,0 +1,49 @@
+[build-system]
+requires = ["setuptools>=77", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "tasvisan"
+version = "0.1.2"
+description = "Toolkit for data reduction, normalization, combination, visualization and analyis of triple-axis spectrometers, especially for Tapain and Sika"
+readme = "README.md"
+requires-python = ">=3.8"
+
+authors = [
+    { name = "Guochu Deng", email = "gc.deng.ansto@gmail.com" }
+]
+
+license = "MIT"
+license-files = ["LICEN[CS]E*"]
+
+dependencies = [
+    "numpy>=1.20",
+    "matplotlib>=3.5",
+    "scipy>=1.7",
+    "pandas>=1.3",
+    "lmfit>=1.0",
+    "h5py>=3.0",
+    "plotly>=5.0",
+    "inspy-conv",
+    "QtPy",
+    "PySide6"
+]
+
+keywords = ["neutron", "scattering", "resolution", "inelastic", "spectrometer", "triple-axis"]
+
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Intended Audience :: Science/Research",
+    "Topic :: Scientific/Engineering :: Physics",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+Homepage = "https://github.com/gcdengansto/TasVisAn"
+Repository = "https://github.com/gcdengansto/TasVisAn"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[project.optional-dependencies]
+dev = ["pytest"]

tasvisan-0.1.2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

tasvisan-0.1.2/src/tasvisan/__init__.py

@@ -0,0 +1,11 @@
+from .base import TasData
+from .tas.taipan import Taipan
+from .tas.sika import Sika
+
+try:
+    from .gui.TASDataBrowser import main
+except ImportError:
+    warnings.warn('QtPy not found, cannot run Resolution GUI')
+
+
+__all__ = ['TasData', 'Taipan', 'Sika']