diffpy.fourigui 0.1.0rc0__tar.gz

diffpy_fourigui-0.1.0rc0/AUTHORS.rst

@@ -0,0 +1,10 @@
+Authors
+=======
+
+Billinge Group and community contributors.
+
+Contributors
+------------
+
+For a list of contributors, visit
+https://github.com/diffpy/diffpy.fourigui/graphs/contributors

diffpy_fourigui-0.1.0rc0/LICENSE.rst

@@ -0,0 +1,30 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, The Trustees of Columbia University
+in the City of New York.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors
+   may be used to endorse or promote products derived from this software
+   without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

diffpy_fourigui-0.1.0rc0/MANIFEST.in

@@ -0,0 +1,12 @@
+graft src
+graft tests
+graft requirements
+
+include AUTHORS.rst LICENSE*.rst README.rst
+
+# Exclude all bytecode files and __pycache__ directories
+global-exclude *.py[cod]  # Exclude all .pyc, .pyo, and .pyd files.
+global-exclude .DS_Store  # Exclude Mac filesystem artifacts.
+global-exclude __pycache__  # Exclude Python cache directories.
+global-exclude .git*  # Exclude git files and directories.
+global-exclude .idea  # Exclude PyCharm project settings.

diffpy_fourigui-0.1.0rc0/PKG-INFO

@@ -0,0 +1,154 @@
+Metadata-Version: 2.1
+Name: diffpy.fourigui
+Version: 0.1.0rc0
+Summary: Tool for visualizing 3D diffraction and PDF Images.
+Author-email: "Simon J.L. Billinge group" <simon.billinge@gmail.com>
+Maintainer-email: "Simon J.L. Billinge group" <simon.billinge@gmail.com>
+Project-URL: Homepage, https://github.com/diffpy/diffpy.fourigui/
+Project-URL: Issues, https://github.com/diffpy/diffpy.fourigui/issues/
+Keywords: diffraction,pdf,pair distribution function,gui
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Unix
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Topic :: Scientific/Engineering :: Chemistry
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+License-File: LICENSE.rst
+License-File: AUTHORS.rst
+Requires-Dist: h5py
+Requires-Dist: time
+Requires-Dist: tk
+Requires-Dist: matplotlib
+Requires-Dist: numpy
+
+|Icon| |title|_
+===============
+
+.. |title| replace:: diffpy.fourigui
+.. _title: https://diffpy.github.io/diffpy.fourigui
+
+.. |Icon| image:: https://avatars.githubusercontent.com/diffpy
+        :target: https://diffpy.github.io/diffpy.fourigui
+        :height: 100px
+
+|PyPi| |Forge| |PythonVersion| |PR|
+
+|CI| |Codecov| |Black| |Tracking|
+
+.. |Black| image:: https://img.shields.io/badge/code_style-black-black
+        :target: https://github.com/psf/black
+
+.. |CI| image:: https://github.com/diffpy/diffpy.fourigui/actions/workflows/matrix-and-codecov-on-merge-to-main.yml/badge.svg
+        :target: https://github.com/diffpy/diffpy.fourigui/actions/workflows/matrix-and-codecov-on-merge-to-main.yml
+
+.. |Codecov| image:: https://codecov.io/gh/diffpy/diffpy.fourigui/branch/main/graph/badge.svg
+        :target: https://codecov.io/gh/diffpy/diffpy.fourigui
+
+.. |Forge| image:: https://img.shields.io/conda/vn/conda-forge/diffpy.fourigui
+        :target: https://anaconda.org/conda-forge/diffpy.fourigui
+
+.. |PR| image:: https://img.shields.io/badge/PR-Welcome-29ab47ff
+
+.. |PyPi| image:: https://img.shields.io/pypi/v/diffpy.fourigui
+        :target: https://pypi.org/project/diffpy.fourigui/
+
+.. |PythonVersion| image:: https://img.shields.io/pypi/pyversions/diffpy.fourigui
+        :target: https://pypi.org/project/diffpy.fourigui/
+
+.. |Tracking| image:: https://img.shields.io/badge/issue_tracking-github-blue
+        :target: https://github.com/diffpy/diffpy.fourigui/issues
+
+Tool for visualizing 3D diffraction and PDF Images.
+
+* LONGER DESCRIPTION HERE
+
+For more information about the diffpy.fourigui library, please consult our `online documentation <https://diffpy.github.io/diffpy.fourigui>`_.
+
+Citation
+--------
+
+If you use diffpy.fourigui in a scientific publication, we would like you to cite this package as
+
+        diffpy.fourigui Package, https://github.com/diffpy/diffpy.fourigui
+
+Installation
+------------
+
+The preferred method is to use `Miniconda Python
+<https://docs.conda.io/projects/miniconda/en/latest/miniconda-install.html>`_
+and install from the "conda-forge" channel of Conda packages.
+
+To add "conda-forge" to the conda channels, run the following in a terminal. ::
+
+        conda config --add channels conda-forge
+
+We want to install our packages in a suitable conda environment.
+The following creates and activates a new environment named ``diffpy.fourigui_env`` ::
+
+        conda create -n diffpy.fourigui_env python=3
+        conda activate diffpy.fourigui_env
+
+Then, to fully install ``diffpy.fourigui`` in our active environment, run ::
+
+        conda install diffpy.fourigui
+
+Another option is to use ``pip`` to download and install the latest release from
+`Python Package Index <https://pypi.python.org>`_.
+To install using ``pip`` into your ``diffpy.fourigui_env`` environment, we will also have to install dependencies ::
+
+        pip install -r https://raw.githubusercontent.com/diffpy/diffpy.fourigui/main/requirements/run.txt
+
+and then install the package ::
+
+        pip install diffpy.fourigui
+
+If you prefer to install from sources, after installing the dependencies, obtain the source archive from
+`GitHub <https://github.com/diffpy/diffpy.fourigui/>`_. Once installed, ``cd`` into your ``diffpy.fourigui`` directory
+and run the following ::
+
+        pip install .
+
+Support and Contribute
+----------------------
+
+`Diffpy user group <https://groups.google.com/g/diffpy-users>`_ is the discussion forum for general questions and discussions about the use of diffpy.fourigui. Please join the diffpy.fourigui users community by joining the Google group. The diffpy.fourigui project welcomes your expertise and enthusiasm!
+
+If you see a bug or want to request a feature, please `report it as an issue <https://github.com/diffpy/diffpy.fourigui/issues>`_ and/or `submit a fix as a PR <https://github.com/diffpy/diffpy.fourigui/pulls>`_. You can also post it to the `Diffpy user group <https://groups.google.com/g/diffpy-users>`_.
+
+Feel free to fork the project and contribute. To install diffpy.fourigui
+in a development mode, with its sources being directly used by Python
+rather than copied to a package directory, use the following in the root
+directory ::
+
+        pip install -e .
+
+To ensure code quality and to prevent accidental commits into the default branch, please set up the use of our pre-commit
+hooks.
+
+1. Install pre-commit in your working environment by running ``conda install pre-commit``.
+
+2. Initialize pre-commit (one time only) ``pre-commit install``.
+
+Thereafter your code will be linted by black and isort and checked against flake8 before you can commit.
+If it fails by black or isort, just rerun and it should pass (black and isort will modify the files so should
+pass after they are modified). If the flake8 test fails please see the error messages and fix them manually before
+trying to commit again.
+
+Improvements and fixes are always appreciated.
+
+Before contribuing, please read our `Code of Conduct <https://github.com/diffpy/diffpy.fourigui/blob/main/CODE_OF_CONDUCT.rst>`_.
+
+Contact
+-------
+
+For more information on diffpy.fourigui please visit the project `web-page <https://diffpy.github.io/>`_ or email Prof. Simon Billinge at sb2896@columbia.edu.

diffpy_fourigui-0.1.0rc0/README.rst

@@ -0,0 +1,121 @@
+|Icon| |title|_
+===============
+
+.. |title| replace:: diffpy.fourigui
+.. _title: https://diffpy.github.io/diffpy.fourigui
+
+.. |Icon| image:: https://avatars.githubusercontent.com/diffpy
+        :target: https://diffpy.github.io/diffpy.fourigui
+        :height: 100px
+
+|PyPi| |Forge| |PythonVersion| |PR|
+
+|CI| |Codecov| |Black| |Tracking|
+
+.. |Black| image:: https://img.shields.io/badge/code_style-black-black
+        :target: https://github.com/psf/black
+
+.. |CI| image:: https://github.com/diffpy/diffpy.fourigui/actions/workflows/matrix-and-codecov-on-merge-to-main.yml/badge.svg
+        :target: https://github.com/diffpy/diffpy.fourigui/actions/workflows/matrix-and-codecov-on-merge-to-main.yml
+
+.. |Codecov| image:: https://codecov.io/gh/diffpy/diffpy.fourigui/branch/main/graph/badge.svg
+        :target: https://codecov.io/gh/diffpy/diffpy.fourigui
+
+.. |Forge| image:: https://img.shields.io/conda/vn/conda-forge/diffpy.fourigui
+        :target: https://anaconda.org/conda-forge/diffpy.fourigui
+
+.. |PR| image:: https://img.shields.io/badge/PR-Welcome-29ab47ff
+
+.. |PyPi| image:: https://img.shields.io/pypi/v/diffpy.fourigui
+        :target: https://pypi.org/project/diffpy.fourigui/
+
+.. |PythonVersion| image:: https://img.shields.io/pypi/pyversions/diffpy.fourigui
+        :target: https://pypi.org/project/diffpy.fourigui/
+
+.. |Tracking| image:: https://img.shields.io/badge/issue_tracking-github-blue
+        :target: https://github.com/diffpy/diffpy.fourigui/issues
+
+Tool for visualizing 3D diffraction and PDF Images.
+
+* LONGER DESCRIPTION HERE
+
+For more information about the diffpy.fourigui library, please consult our `online documentation <https://diffpy.github.io/diffpy.fourigui>`_.
+
+Citation
+--------
+
+If you use diffpy.fourigui in a scientific publication, we would like you to cite this package as
+
+        diffpy.fourigui Package, https://github.com/diffpy/diffpy.fourigui
+
+Installation
+------------
+
+The preferred method is to use `Miniconda Python
+<https://docs.conda.io/projects/miniconda/en/latest/miniconda-install.html>`_
+and install from the "conda-forge" channel of Conda packages.
+
+To add "conda-forge" to the conda channels, run the following in a terminal. ::
+
+        conda config --add channels conda-forge
+
+We want to install our packages in a suitable conda environment.
+The following creates and activates a new environment named ``diffpy.fourigui_env`` ::
+
+        conda create -n diffpy.fourigui_env python=3
+        conda activate diffpy.fourigui_env
+
+Then, to fully install ``diffpy.fourigui`` in our active environment, run ::
+
+        conda install diffpy.fourigui
+
+Another option is to use ``pip`` to download and install the latest release from
+`Python Package Index <https://pypi.python.org>`_.
+To install using ``pip`` into your ``diffpy.fourigui_env`` environment, we will also have to install dependencies ::
+
+        pip install -r https://raw.githubusercontent.com/diffpy/diffpy.fourigui/main/requirements/run.txt
+
+and then install the package ::
+
+        pip install diffpy.fourigui
+
+If you prefer to install from sources, after installing the dependencies, obtain the source archive from
+`GitHub <https://github.com/diffpy/diffpy.fourigui/>`_. Once installed, ``cd`` into your ``diffpy.fourigui`` directory
+and run the following ::
+
+        pip install .
+
+Support and Contribute
+----------------------
+
+`Diffpy user group <https://groups.google.com/g/diffpy-users>`_ is the discussion forum for general questions and discussions about the use of diffpy.fourigui. Please join the diffpy.fourigui users community by joining the Google group. The diffpy.fourigui project welcomes your expertise and enthusiasm!
+
+If you see a bug or want to request a feature, please `report it as an issue <https://github.com/diffpy/diffpy.fourigui/issues>`_ and/or `submit a fix as a PR <https://github.com/diffpy/diffpy.fourigui/pulls>`_. You can also post it to the `Diffpy user group <https://groups.google.com/g/diffpy-users>`_.
+
+Feel free to fork the project and contribute. To install diffpy.fourigui
+in a development mode, with its sources being directly used by Python
+rather than copied to a package directory, use the following in the root
+directory ::
+
+        pip install -e .
+
+To ensure code quality and to prevent accidental commits into the default branch, please set up the use of our pre-commit
+hooks.
+
+1. Install pre-commit in your working environment by running ``conda install pre-commit``.
+
+2. Initialize pre-commit (one time only) ``pre-commit install``.
+
+Thereafter your code will be linted by black and isort and checked against flake8 before you can commit.
+If it fails by black or isort, just rerun and it should pass (black and isort will modify the files so should
+pass after they are modified). If the flake8 test fails please see the error messages and fix them manually before
+trying to commit again.
+
+Improvements and fixes are always appreciated.
+
+Before contribuing, please read our `Code of Conduct <https://github.com/diffpy/diffpy.fourigui/blob/main/CODE_OF_CONDUCT.rst>`_.
+
+Contact
+-------
+
+For more information on diffpy.fourigui please visit the project `web-page <https://diffpy.github.io/>`_ or email Prof. Simon Billinge at sb2896@columbia.edu.

diffpy_fourigui-0.1.0rc0/pyproject.toml

@@ -0,0 +1,75 @@
+[build-system]
+requires = ["setuptools>=62.0", "setuptools-git-versioning>=2.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "diffpy.fourigui"
+dynamic=['version', 'dependencies']
+authors = [
+  { name="Simon J.L. Billinge group", email="simon.billinge@gmail.com" },
+]
+maintainers = [
+  { name="Simon J.L. Billinge group", email="simon.billinge@gmail.com" },
+]
+description = "Tool for visualizing 3D diffraction and PDF Images."
+keywords = ['diffraction', 'pdf', 'pair distribution function', 'gui']
+readme = "README.rst"
+requires-python = ">=3.10"
+classifiers = [
+        'Development Status :: 5 - Production/Stable',
+        'Environment :: Console',
+        'Intended Audience :: Developers',
+        'Intended Audience :: Science/Research',
+        'License :: OSI Approved :: BSD License',
+        'Operating System :: MacOS :: MacOS X',
+        'Operating System :: Microsoft :: Windows',
+        'Operating System :: POSIX',
+        'Operating System :: Unix',
+        'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: 3.11',
+        'Programming Language :: Python :: 3.12',
+        'Topic :: Scientific/Engineering :: Physics',
+        'Topic :: Scientific/Engineering :: Chemistry',
+]
+
+[project.urls]
+Homepage = "https://github.com/diffpy/diffpy.fourigui/"
+Issues = "https://github.com/diffpy/diffpy.fourigui/issues/"
+
+[tool.setuptools-git-versioning]
+enabled = true
+template = "{tag}"
+dev_template = "{tag}"
+dirty_template = "{tag}"
+
+[tool.setuptools.packages.find]
+where = ["src"]  # list of folders that contain the packages (["."] by default)
+include = ["*"]  # package names should match these glob patterns (["*"] by default)
+exclude = []  # exclude packages matching these glob patterns (empty by default)
+namespaces = false  # to disable scanning PEP 420 namespaces (true by default)
+
+[tool.setuptools.dynamic]
+dependencies = {file = ["requirements/pip.txt"]}
+
+[tool.black]
+line-length = 115
+include = '\.pyi?$'
+exclude = '''
+/(
+    \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | \.rst
+  | \.txt
+  | _build
+  | buck-out
+  | build
+  | dist
+
+  # The following are specific to Black, you probably don't want those.
+  | blib2to3
+  | tests/data
+)/
+'''

diffpy_fourigui-0.1.0rc0/requirements/conda.txt

@@ -0,0 +1,5 @@
+h5py
+time
+tk
+matplotlib-base
+numpy

diffpy_fourigui-0.1.0rc0/requirements/docs.txt

@@ -0,0 +1,4 @@
+sphinx
+sphinx_rtd_theme
+doctr
+m2r

diffpy_fourigui-0.1.0rc0/requirements/pip.txt

@@ -0,0 +1,5 @@
+h5py
+time
+tk
+matplotlib
+numpy

diffpy_fourigui-0.1.0rc0/requirements/test.txt

@@ -0,0 +1,6 @@
+flake8
+pytest
+codecov
+coverage
+pytest-cov
+pytest-env

diffpy_fourigui-0.1.0rc0/setup.cfg

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

diffpy_fourigui-0.1.0rc0/src/diffpy/__init__.py

@@ -0,0 +1,23 @@
+#!/usr/bin/env python
+##############################################################################
+#
+# (c) 2024 The Trustees of Columbia University in the City of New York.
+# All rights reserved.
+#
+# File coded by: Billinge Group members and community contributors.
+#
+# See GitHub contributions for a more detailed list of contributors.
+# https://github.com/diffpy/diffpy.fourigui/graphs/contributors
+#
+# See LICENSE.rst for license information.
+#
+##############################################################################
+
+"""Blank namespace package for module diffpy."""
+
+
+from pkgutil import extend_path
+
+__path__ = extend_path(__path__, __name__)
+
+# End of file

diffpy_fourigui-0.1.0rc0/src/diffpy/fourigui/__init__.py

@@ -0,0 +1,24 @@
+#!/usr/bin/env python
+##############################################################################
+#
+# (c) 2024 The Trustees of Columbia University in the City of New York.
+# All rights reserved.
+#
+# File coded by: Billinge Group members and community contributors.
+#
+# See GitHub contributions for a more detailed list of contributors.
+# https://github.com/diffpy/diffpy.fourigui/graphs/contributors
+#
+# See LICENSE.rst for license information.
+#
+##############################################################################
+
+"""Tool for visualizing 3D diffraction and PDF Images."""
+
+# package version
+from diffpy.fourigui.version import __version__
+
+# silence the pyflakes syntax checker
+assert __version__ or True
+
+# End of file