psk-viewer 0.9.9__tar.gz

psk_viewer-0.9.9/.github/workflows/publish-to-pypi.yml

@@ -0,0 +1,46 @@
+name: Publish Python distributions to PyPI and TestPyPI
+# https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
+
+on: push
+jobs:
+  build-n-publish:
+    name: Build and publish Python distributions to PyPI and TestPyPI
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Fetch all history for all tags and branches
+      run: |
+        git fetch --prune --unshallow
+        git fetch --depth=1 origin +refs/tags/*:refs/tags/*
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: "3.x"
+
+    - name: Install pypa/build
+      run: >-
+        python -m
+        pip install
+        build
+        --user
+
+    - name: Build a source tarball
+      run: >-
+        python -m
+        build
+        --sdist
+        --outdir dist/
+        .
+    - name: Publish distribution to Test PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        password: ${{ secrets.TEST_PYPI_API_TOKEN }}
+        repository-url: https://test.pypi.org/legacy/
+
+    - name: Publish distribution to PyPI
+      if: startsWith(github.ref, 'refs/tags')
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        password: ${{ secrets.PYPI_API_TOKEN }}

psk_viewer-0.9.9/.gitignore

@@ -0,0 +1,11 @@
+.*
+/.*
+!.gitignore
+!/.github/
+/build/
+/dist/
+/typograph.py
+/deployment/
+/pysidedeploy.spec
+/src/psk_viewer/_version.py
+/src/psk_viewer.egg-info/

psk_viewer-0.9.9/LICENSE.md

@@ -0,0 +1,157 @@
+### GNU LESSER GENERAL PUBLIC LICENSE
+
+Version 3, 29 June 2007
+
+Copyright (C) 2007 Free Software Foundation, Inc.
+<https://fsf.org/>
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+This version of the GNU Lesser General Public License incorporates the
+terms and conditions of version 3 of the GNU General Public License,
+supplemented by the additional permissions listed below.
+
+#### 0. Additional Definitions.
+
+As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the
+GNU General Public License.
+
+"The Library" refers to a covered work governed by this License, other
+than an Application or a Combined Work as defined below.
+
+An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+A "Combined Work" is a work produced by combining or linking an
+Application with the Library. The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+#### 1. Exception to Section 3 of the GNU GPL.
+
+You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+#### 2. Conveying Modified Versions.
+
+If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+-   a) under this License, provided that you make a good faith effort
+    to ensure that, in the event an Application does not supply the
+    function or data, the facility still operates, and performs
+    whatever part of its purpose remains meaningful, or
+-   b) under the GNU GPL, with none of the additional permissions of
+    this License applicable to that copy.
+
+#### 3. Object Code Incorporating Material from Library Header Files.
+
+The object code form of an Application may incorporate material from a
+header file that is part of the Library. You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+-   a) Give prominent notice with each copy of the object code that
+    the Library is used in it and that the Library and its use are
+    covered by this License.
+-   b) Accompany the object code with a copy of the GNU GPL and this
+    license document.
+
+#### 4. Combined Works.
+
+You may convey a Combined Work under terms of your choice that, taken
+together, effectively do not restrict modification of the portions of
+the Library contained in the Combined Work and reverse engineering for
+debugging such modifications, if you also do each of the following:
+
+-   a) Give prominent notice with each copy of the Combined Work that
+    the Library is used in it and that the Library and its use are
+    covered by this License.
+-   b) Accompany the Combined Work with a copy of the GNU GPL and this
+    license document.
+-   c) For a Combined Work that displays copyright notices during
+    execution, include the copyright notice for the Library among
+    these notices, as well as a reference directing the user to the
+    copies of the GNU GPL and this license document.
+-   d) Do one of the following:
+    -   0) Convey the Minimal Corresponding Source under the terms of
+        this License, and the Corresponding Application Code in a form
+        suitable for, and under terms that permit, the user to
+        recombine or relink the Application with a modified version of
+        the Linked Version to produce a modified Combined Work, in the
+        manner specified by section 6 of the GNU GPL for conveying
+        Corresponding Source.
+    -   1) Use a suitable shared library mechanism for linking with
+        the Library. A suitable mechanism is one that (a) uses at run
+        time a copy of the Library already present on the user's
+        computer system, and (b) will operate properly with a modified
+        version of the Library that is interface-compatible with the
+        Linked Version.
+-   e) Provide Installation Information, but only if you would
+    otherwise be required to provide such information under section 6
+    of the GNU GPL, and only to the extent that such information is
+    necessary to install and execute a modified version of the
+    Combined Work produced by recombining or relinking the Application
+    with a modified version of the Linked Version. (If you use option
+    4d0, the Installation Information must accompany the Minimal
+    Corresponding Source and Corresponding Application Code. If you
+    use option 4d1, you must provide the Installation Information in
+    the manner specified by section 6 of the GNU GPL for conveying
+    Corresponding Source.)
+
+#### 5. Combined Libraries.
+
+You may place library facilities that are a work based on the Library
+side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+-   a) Accompany the combined library with a copy of the same work
+    based on the Library, uncombined with any other library
+    facilities, conveyed under the terms of this License.
+-   b) Give prominent notice with the combined library that part of it
+    is a work based on the Library, and explaining where to find the
+    accompanying uncombined form of the same work.
+
+#### 6. Revised Versions of the GNU Lesser General Public License.
+
+The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Library
+as you received it specifies that a certain numbered version of the
+GNU Lesser General Public License "or any later version" applies to
+it, you have the option of following the terms and conditions either
+of that published version or of any later version published by the
+Free Software Foundation. If the Library as you received it does not
+specify a version number of the GNU Lesser General Public License, you
+may choose any version of the GNU Lesser General Public License ever
+published by the Free Software Foundation.
+
+If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

psk_viewer-0.9.9/PKG-INFO

@@ -0,0 +1,155 @@
+Metadata-Version: 2.1
+Name: psk_viewer
+Version: 0.9.9
+Summary: IPM RAS PSK and FS spectrometer files viewer
+Author-email: StSav012 <stsav012@gmail.com>
+License: LGPL-3.0-only
+Project-URL: Source Code, https://github.com/StSav012/psk_viewer
+Project-URL: Bug Tracker, https://github.com/StSav012/psk_viewer/issues
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Win32 (MS Windows)
+Classifier: Environment :: X11 Applications :: Qt
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
+Classifier: Operating System :: Microsoft :: Windows :: Windows 7
+Classifier: Operating System :: Microsoft :: Windows :: Windows 8
+Classifier: Operating System :: Microsoft :: Windows :: Windows 10
+Classifier: Operating System :: Microsoft :: Windows :: Windows 11
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Astronomy
+Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
+Classifier: Topic :: Scientific/Engineering :: Chemistry
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Typing :: Typed
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: qtpy>=2.4.1
+Requires-Dist: qtawesome
+Requires-Dist: PySide6-Essentials>=6.6.2
+Requires-Dist: pandas
+Requires-Dist: pyqtgraph>=0.13.3
+Requires-Dist: scipy
+
+# IPM RAS PSK and FS spectrometer files viewer
+
+**Required packages:**
+  - `pandas`,
+  - `pyqtgraph>=0.13.3`,
+  - `qtpy>=2.3.1`,
+  - `scipy`,
+  - any of `PyQt6`, `PySide6`, `PyQt5`, `PySide2`.
+
+**Optional packages:**
+  - `numexpr`: for accelerating certain numerical operations;
+  - `bottleneck`: for accelerating certain types of nan evaluations;
+  - `openpyxl`: for saving MS Excel files.
+
+They should install at the first application start automatically.
+
+**Required Python:** >= 3.8
+
+**Notes:** 
+  - only Python <= 3.8 is available for MS Windows 7, so, there is not much choice for those who use it;
+  - `PySide2` requires Python < 3.11; 
+    there is [a port](https://anaconda.org/conda-forge/pyside2) of `PySide2` on Python 3.11 by `conda-forge`, 
+    but it's unclear whether it's stable;
+  - `PyQt6` and `PySide6` require pretty modern OS, e.g., 64-bit MS Windows 10 21H2 or later;
+  - `pyqtgraph<0.13.3` is incompatible with `Qt6>=6.5.0`.
+
+### Getting Python
+Python might already been installed on your system.
+If your system supports repositories, check them first.
+Otherwise, download an appropriate Python distribution (or the source code) from https://www.python.org/downloads/ and install it.
+
+It will be convenient to add the Python directory to the `PATH` environment variable to get quick access to the binaries.
+
+### Getting the application
+The source code is available at https://github.com/StSav012/psk_viewer.
+
+###### Use `pip` or another Python package manager
+You can get the code with `pip` (the preferred way): 
+
+  - (optionally) create a virtual environment and activate it,
+  - issue 
+    ```commandline
+    pip install psk_viewer
+    ```
+    in the command line.
+
+Then, do 
+```commandline
+pip install -U psk_viewer
+```
+every time you wish to update the code.
+
+###### Use `git`
+You can get the code with `git`: 
+
+  - navigate to the directory you wish to store the code in,
+  - issue 
+    ```commandline
+    git clone https://github.com/StSav012/psk_viewer.git
+    ```
+    in the command line,
+  - find `psk_viewer` directory with the code; feel free to move or rename however you want. 
+
+Then, do 
+```commandline
+git pull https://github.com/StSav012/psk_viewer.git
+```
+every time you wish to update the code.
+
+###### Use the official GitHub software
+This way is pretty much like the previous.
+
+If you prefer CLI applications, issue
+```commandline
+gh repo clone StSav012/psk_viewer
+```
+in the preferred directory.
+
+###### Get a packed archive
+  - download the source code archive from https://github.com/StSav012/psk_viewer/archive/master.zip,
+  - unpack its content into a directory to your taste.
+
+The source code will get updated every time the application starts unless you manually delete `updater.py` file.
+
+### Launching the application
+After the installation via `pip` or another package manager,
+an executable named `psk_viewer` should be available in the environment. That's all.
+
+Otherwise, there's more to do.
+
+A file called `main.py` should be fed to Python executable.
+
+If the file associations set so, the opening of the file should lead to executing the code. Ugly and unsafe.
+
+If the Python directory is in `PATH` environment variable, issue something like
+```commandline
+python main.py
+```
+Otherwise, use the full path to `python` (or `python3`) executable.
+
+Feel free to create an entry to the quick launch or to the desktop to avoid excessive typing.
+The text does not cover this topic anyhow.
+
+### Usage tips
+Parts of the application interface can be moved, re-arranged, and resized.
+
+The least evident part of the interface is the toolbar. Its buttons allow you to do the following:
+
+  - open a data file, either from the FS or the PSK spectrometer, see the selector below the file name;
+  - clear everything opened and marked;
+  - replace the displayed data with their finite-step second derivative (if appropriate);
+  - switch the displayed data between the detector voltage and the absorption values (if appropriate);
+  - export the displayed data into a numerical table or as a picture;
+  - mark interesting data points, copy the values, save them, or remove the marks;
+  - customize colors, lines thickness, and some text formatting.
+
+Read the tooltips, they may appear useful.

psk_viewer-0.9.9/README.md

@@ -0,0 +1,117 @@
+# IPM RAS PSK and FS spectrometer files viewer
+
+**Required packages:**
+  - `pandas`,
+  - `pyqtgraph>=0.13.3`,
+  - `qtpy>=2.3.1`,
+  - `scipy`,
+  - any of `PyQt6`, `PySide6`, `PyQt5`, `PySide2`.
+
+**Optional packages:**
+  - `numexpr`: for accelerating certain numerical operations;
+  - `bottleneck`: for accelerating certain types of nan evaluations;
+  - `openpyxl`: for saving MS Excel files.
+
+They should install at the first application start automatically.
+
+**Required Python:** >= 3.8
+
+**Notes:** 
+  - only Python <= 3.8 is available for MS Windows 7, so, there is not much choice for those who use it;
+  - `PySide2` requires Python < 3.11; 
+    there is [a port](https://anaconda.org/conda-forge/pyside2) of `PySide2` on Python 3.11 by `conda-forge`, 
+    but it's unclear whether it's stable;
+  - `PyQt6` and `PySide6` require pretty modern OS, e.g., 64-bit MS Windows 10 21H2 or later;
+  - `pyqtgraph<0.13.3` is incompatible with `Qt6>=6.5.0`.
+
+### Getting Python
+Python might already been installed on your system.
+If your system supports repositories, check them first.
+Otherwise, download an appropriate Python distribution (or the source code) from https://www.python.org/downloads/ and install it.
+
+It will be convenient to add the Python directory to the `PATH` environment variable to get quick access to the binaries.
+
+### Getting the application
+The source code is available at https://github.com/StSav012/psk_viewer.
+
+###### Use `pip` or another Python package manager
+You can get the code with `pip` (the preferred way): 
+
+  - (optionally) create a virtual environment and activate it,
+  - issue 
+    ```commandline
+    pip install psk_viewer
+    ```
+    in the command line.
+
+Then, do 
+```commandline
+pip install -U psk_viewer
+```
+every time you wish to update the code.
+
+###### Use `git`
+You can get the code with `git`: 
+
+  - navigate to the directory you wish to store the code in,
+  - issue 
+    ```commandline
+    git clone https://github.com/StSav012/psk_viewer.git
+    ```
+    in the command line,
+  - find `psk_viewer` directory with the code; feel free to move or rename however you want. 
+
+Then, do 
+```commandline
+git pull https://github.com/StSav012/psk_viewer.git
+```
+every time you wish to update the code.
+
+###### Use the official GitHub software
+This way is pretty much like the previous.
+
+If you prefer CLI applications, issue
+```commandline
+gh repo clone StSav012/psk_viewer
+```
+in the preferred directory.
+
+###### Get a packed archive
+  - download the source code archive from https://github.com/StSav012/psk_viewer/archive/master.zip,
+  - unpack its content into a directory to your taste.
+
+The source code will get updated every time the application starts unless you manually delete `updater.py` file.
+
+### Launching the application
+After the installation via `pip` or another package manager,
+an executable named `psk_viewer` should be available in the environment. That's all.
+
+Otherwise, there's more to do.
+
+A file called `main.py` should be fed to Python executable.
+
+If the file associations set so, the opening of the file should lead to executing the code. Ugly and unsafe.
+
+If the Python directory is in `PATH` environment variable, issue something like
+```commandline
+python main.py
+```
+Otherwise, use the full path to `python` (or `python3`) executable.
+
+Feel free to create an entry to the quick launch or to the desktop to avoid excessive typing.
+The text does not cover this topic anyhow.
+
+### Usage tips
+Parts of the application interface can be moved, re-arranged, and resized.
+
+The least evident part of the interface is the toolbar. Its buttons allow you to do the following:
+
+  - open a data file, either from the FS or the PSK spectrometer, see the selector below the file name;
+  - clear everything opened and marked;
+  - replace the displayed data with their finite-step second derivative (if appropriate);
+  - switch the displayed data between the detector voltage and the absorption values (if appropriate);
+  - export the displayed data into a numerical table or as a picture;
+  - mark interesting data points, copy the values, save them, or remove the marks;
+  - customize colors, lines thickness, and some text formatting.
+
+Read the tooltips, they may appear useful.

psk_viewer-0.9.9/main.py

@@ -0,0 +1,46 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+from __future__ import annotations
+
+import sys
+
+if sys.version_info < (3, 8):
+    message = ('The Python version ' + '.'.join(map(str, sys.version_info[:3])) + ' is not supported.\n' +
+               'Use Python 3.8 or newer.')
+    try:
+        import tkinter
+    except ImportError:
+        input(message)  # wait for the user to see the text
+    else:
+        print(message, file=sys.stderr)
+
+        import tkinter.messagebox
+
+        _root = tkinter.Tk()
+        _root.withdraw()
+        tkinter.messagebox.showerror(title='Outdated Python', message=message)
+        _root.destroy()
+
+    exit(1)
+
+if __name__ == '__main__':
+
+    try:
+        from psk_viewer import main
+    except ImportError:
+        __author__ = 'StSav012'
+        __original_name__ = 'psk_viewer'
+
+        try:
+            from updater import update_with_pip
+
+            update_with_pip(__original_name__)
+
+            from psk_viewer import main
+        except ImportError:
+            from updater import update_with_pip, update_from_github, update_with_git
+
+            update_with_git() or update_from_github(__author__, __original_name__)
+
+            from src.psk_viewer import main
+    main()

psk_viewer-0.9.9/pyproject.toml

@@ -0,0 +1,53 @@
+[build-system]
+requires = ['setuptools>=45', 'setuptools_scm[toml]>=6.2']
+build-backend = 'setuptools.build_meta'
+
+[project]
+name = 'psk_viewer'
+authors = [
+    {name = 'StSav012', email = 'stsav012@gmail.com'},
+]
+description = 'IPM RAS PSK and FS spectrometer files viewer'
+readme = 'README.md'
+license = {text = 'LGPL-3.0-only'}
+requires-python = '>=3.8'
+classifiers = [
+    'Development Status :: 4 - Beta',
+    'Environment :: Win32 (MS Windows)',
+    'Environment :: X11 Applications :: Qt',
+    'Intended Audience :: Science/Research',
+    'License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)',
+    'Operating System :: Microsoft :: Windows :: Windows 7',
+    'Operating System :: Microsoft :: Windows :: Windows 8',
+    'Operating System :: Microsoft :: Windows :: Windows 10',
+    'Operating System :: Microsoft :: Windows :: Windows 11',
+    'Operating System :: POSIX',
+    'Programming Language :: Python :: 3.8',
+    'Programming Language :: Python :: 3.9',
+    'Programming Language :: Python :: 3.10',
+    'Programming Language :: Python :: 3.11',
+    'Topic :: Scientific/Engineering',
+    'Topic :: Scientific/Engineering :: Astronomy',
+    'Topic :: Scientific/Engineering :: Atmospheric Science',
+    'Topic :: Scientific/Engineering :: Chemistry',
+    'Topic :: Scientific/Engineering :: Physics',
+    'Typing :: Typed',
+]
+dynamic = [
+    'version',
+    'dependencies',
+]
+
+[project.gui-scripts]
+psk_viewer = 'psk_viewer:main'
+
+[project.urls]
+'Source Code' = 'https://github.com/StSav012/psk_viewer'
+'Bug Tracker' = 'https://github.com/StSav012/psk_viewer/issues'
+
+[tool.setuptools_scm]
+local_scheme = 'no-local-version'
+write_to = 'src/psk_viewer/_version.py'
+
+[tool.setuptools.dynamic]
+version = {attr = 'psk_viewer._version.__version__'}

psk_viewer-0.9.9/readme.txt

@@ -0,0 +1,21 @@
+IPM RAS PSK and FS spectrometer files viewer
+
+Required packages:
+  • pandas,
+  • pyqtgraph>=0.13.3,
+  • QtPy>=2.3.1,
+  • scipy,
+  • any of PyQt6 (<6.5.0 if pyqtgraph<0.13.3), PySide6 (<6.5.0 if pyqtgraph<0.13.3), PyQt5, PySide2,
+    whichever compatible with the Python and the OS.
+
+Optional packages:
+  • numexpr: for accelerating certain numerical operations;
+  • bottleneck: for accelerating certain types of nan evaluations;
+  • openpyxl: for saving MS Excel files.
+
+Required Python: >= 3.8
+
+For developers. To add a translation, use
+   pyside6-lupdate -noobsolete -tr-function-alias translate="_translate" *.py -ts translations/xy.ts
+   pyside6-linguist translations/*.ts
+   pyside6-lrelease translations/*.ts

psk_viewer-0.9.9/requirements.txt

@@ -0,0 +1,16 @@
+numpy
+scipy
+pandas
+pyqtgraph>=0.13.3
+
+# for the compatibility b/w various Qt versions
+QtPy>=2.3.1
+
+# for unified isons
+qtawesome
+
+# to save MS Excel files
+openpyxl
+
+# to build a package and install it
+setuptools

psk_viewer-0.9.9/setup.cfg

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