nova-trame 1.2.1__tar.gz

nova_trame-1.2.1/.copier-answers.yml

@@ -0,0 +1,8 @@
+# Please do not edit or delete this file. It is needed to be able to update project from template.
+_commit: '0.10'
+_src_path: https://code.ornl.gov/ndip/project-templates/python.git
+project_name: nova-trame
+publish_docs: true
+publish_to_pypi: true
+python_package: nova-trame
+use_mantid: false

nova_trame-1.2.1/.dockerignore

@@ -0,0 +1 @@
+dockerfiles/Dockerfile

nova_trame-1.2.1/.github/workflows/build-test.yml

@@ -0,0 +1,49 @@
+name: Build and Test
+
+on: push
+
+concurrency:
+  group: "${{ github.ref }}"
+  cancel-in-progress: true
+
+env:
+  NDIP_DOCKER_REPOSITORY: "${{ secrets.NDIP_DOCKER_REPOSITORY }}"
+  READTHEDOCS_WEBHOOK_URL: "${{ secrets.READTHEDOCS_WEBHOOK_URL }}"
+  READTHEDOCS_WEBHOOK_SECRET: "${{ secrets.READTHEDOCS_WEBHOOK_SECRET }}"
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 60
+    env:
+      GIT_STRATEGY: clone
+      IMAGE_NAME: "${NDIP_DOCKER_REPOSITORY}/${{ github.repository }}"
+    steps:
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      - name: Checkout repo
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 20
+          lfs: true
+      - name: Build
+        uses: docker/build-push-action@v6
+        id: build
+        with:
+          file: dockerfiles/Dockerfile
+          load: true
+          target: source
+      - name: Run ruff check
+        run: docker run --rm ${{ steps.build.outputs.imageid }} ruff check
+      - name: Run format check
+        run: docker run --rm ${{ steps.build.outputs.imageid }} ruff format --check
+      - name: Run mypy
+        run: docker run --rm ${{ steps.build.outputs.imageid }} mypy .
+      - name: Unit tests
+        run: docker run --rm ${{ steps.build.outputs.imageid }} pytest
+      - name: Run coverage
+        run: docker run --rm ${{ steps.build.outputs.imageid }} sh -c "coverage run && coverage report"
+      - name: Docs test
+        run: docker run --rm ${{ steps.build.outputs.imageid }} bash build_docs.sh

nova_trame-1.2.1/.github/workflows/nova-trame.yml

@@ -0,0 +1,62 @@
+name: Publish Package
+
+on: workflow_dispatch
+
+concurrency:
+  group: "${{ github.ref }}"
+  cancel-in-progress: true
+
+env:
+  PYPI_API_TOKEN: "${{ secrets.PYPI_API_TOKEN }}"
+
+jobs:
+  tag-release:
+    runs-on: ubuntu-latest
+    timeout-minutes: 60
+    permissions: write-all
+    env:
+      GIT_STRATEGY: clone
+      IMAGE_NAME: "${NDIP_DOCKER_REPOSITORY}/${{ github.repository }}"
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 20
+          lfs: true
+      - name: Parse version
+        run: echo "VERSION=$(cat pyproject.toml | grep "version =" | head -n 1 | awk '{ print $3 }' | tr -d '"')" >> $GITHUB_ENV
+      - name: Create release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ env.VERSION }}
+          release_name: ${{ env.VERSION }}
+
+  publish-package:
+    needs: tag-release
+    runs-on: ubuntu-latest
+    if: github.event_name == 'workflow_dispatch'
+    timeout-minutes: 60
+    env:
+      GIT_STRATEGY: clone
+      IMAGE_NAME: "${NDIP_DOCKER_REPOSITORY}/${{ github.repository }}"
+    steps:
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      - name: Checkout repo
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 20
+          lfs: true
+      - name: Build
+        uses: docker/build-push-action@v6
+        id: build
+        with:
+          file: dockerfiles/Dockerfile
+          load: true
+          target: package
+      - name: Publish
+        run: docker run --rm ${{ steps.build.outputs.imageid }} sh -c "hatch build && hatch publish -u __token__ -a ${PYPI_API_TOKEN}"

nova_trame-1.2.1/.gitignore

@@ -0,0 +1,168 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  We ingore the whole .idea folder
+#  For more fine tuning, JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.
+.idea
+
+
+.envrc
+
+
+junit.xml
+
+.pixi

nova_trame-1.2.1/.pre-commit-config.yaml

@@ -0,0 +1,27 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.6.0
+  hooks:
+    - id: check-added-large-files
+      args: [--maxkb=8192]
+    - id: check-merge-conflict
+    - id: check-yaml
+      args: [--allow-multiple-documents]
+    - id: end-of-file-fixer
+    - id: check-toml
+    - id: trailing-whitespace
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.6.2
+  hooks:
+    - id: ruff
+      args: [--fix, --exit-non-zero-on-fix]
+    - id: ruff-format
+- repo: local
+  hooks:
+    - id: mypy
+      name: mypy
+      entry: pixi run mypy .
+      language: system
+      types: [python]
+      verbose: true
+      pass_filenames: false

nova_trame-1.2.1/.readthedocs.yml

@@ -0,0 +1,39 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+    # You can also specify other tool versions:
+    # nodejs: "20"
+    # rust: "1.70"
+    # golang: "1.20"
+  jobs:
+    post_create_environment:
+      - pip install altair sphinx-rtd-theme==3.0.2 tomli
+      - pip install .
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
+  # builder: "dirhtml"
+  # Fail on all warnings to avoid broken references
+  # fail_on_warning: true
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#   - pdf
+#   - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+# python:
+#   install:
+#     - requirements: docs/requirements.txt

nova_trame-1.2.1/.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+    "recommendations": [
+        "charliermarsh.ruff",
+        "ms-python.mypy-type-checker"
+    ]
+}

nova_trame-1.2.1/.vscode/launch.json

@@ -0,0 +1,10 @@
+{
+    "configurations": [{
+        "name": "Launch",
+        "type": "debugpy",
+        "request": "launch",
+        "cwd": "${workspaceFolder}",
+        "module": "tests.gallery",
+        "args": ["--server"]
+    }]
+}

nova_trame-1.2.1/.vscode/settings.json

@@ -0,0 +1,14 @@
+{
+    "[python]": {
+        "editor.defaultFormatter": "charliermarsh.ruff"
+    },
+    "[restructuredtext]": {
+        "editor.wordWrap": "wordWrapColumn",
+        "editor.wordWrapColumn": 120
+    },
+    "python.testing.pytestArgs": [
+        "tests"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true
+}

nova_trame-1.2.1/CHANGELOG.md

@@ -0,0 +1,146 @@
+### nova-trame, 1.2.1
+
+* Fixes a vertical alignment issue with NeutronDataSelector when the component is placed in a relatively low-width container (thanks to John Duggan).
+
+### nova-trame, 1.2.0
+
+* Adds a show_experiment_filters parameter to NeutronDataSelector to allow hiding the facility/instrument/experiment selection widgets (thanks to John Duggan).
+* The DataSelector user interface has been reworked to provide more consistent visual alignment of content (thanks to John Duggan).
+
+### nova-trame, 1.1.1
+
+* Passing an items parameter to InputField(type="radio") now generates a correct radio button group (thanks to John Duggan).
+
+### nova-trame, 1.1.0
+
+* Sort and filtering capabilities have been added to the DataSelector (thanks to John Duggan).
+* Added a parameter to NeutronDataSelector to preserve selected files when changing the facility, instrument, or experiment (thanks to John Duggan).
+* The v_show parameter should now be functional when used on GridLayout, HBoxLayout, and VBoxLayout (thanks to John Duggan).
+
+### nova-trame, 1.0.1
+
+* Exit button now attempts to close the browser tab and will be visually consistent across all themes now (thanks to John Duggan).
+
+### nova-trame, 1.0.0
+
+* Adds a stretch parameter to GridLayout, HBoxLayout, and VBoxLayout and overhauls how the main content slot works (thanks to John Duggan).
+* This is tagged to version 1.0.0 as we are going to begin considering backwards compatibility with all future changes.
+
+### nova-trame, 0.27.0
+
+* DataSelector and NeutronDataSelector support range selection via Shift+Click (thanks to John Duggan).
+
+### nova-trame, 0.26.2
+
+* Improved the error message when a developer uses the removed NeutronDataSelector.set_state method (thanks to John Duggan).
+
+### nova-trame, 0.26.1
+
+* Added use_bytes parameter to FileUpload and RemoteFileInput for handling binary files that are not stored on the server (thanks to John Duggan).
+
+### nova-trame, 0.26.0
+
+* Added data_source and projection parameters to NeutronDataSelector to allow populating data files from ONCat (thanks to Andrew Ayres and John Duggan).
+
+### nova-trame, 0.25.5
+
+* NeutronDataSelector will no longer show duplicates of a file that matches multiple extensions (thanks to John Duggan).
+
+### nova-trame, 0.25.4
+
+* InputField, FileUpload, and RemoteFileInput should support parameter bindings now (thanks to John Duggan).
+
+### nova-trame, 0.25.3
+
+* Clearing NeutronDataSelector file selections will no longer send null/None values to the state (thanks to John Duggan).
+
+### nova-trame, 0.25.2
+
+* NeutronDataSelector should now reset its state properly when changing the instrument or experiment (thanks to John Duggan).
+
+### nova-trame, 0.25.1
+
+* ExecutionButtons now supports binding to stop_btn and download_btn parameters (thanks to John Duggan).
+
+### nova-trame, 0.25.0
+
+* FileUpload now supports a return_contents parameter (thanks to John Duggan).
+
+### nova-trame, 0.24.1
+
+* Fixed literalinclude paths in the documentation (thanks to John Duggan).
+
+### nova-trame, 0.24.0
+
+* Parameters to DataSelector and NeutronDataSelector should now support bindings (thanks to John Duggan).
+
+### nova-trame, 0.23.1
+
+* Added support for refreshing the file list in DataSelector and its subclasses (thanks to Yuanpeng Zhang and John Duggan).
+
+### nova-trame, 0.23.0
+
+* The existing DataSelector component has been renamed to NeutronDataSelector and moved to nova.trame.view.components.ornl.NeutronDataSelector (thanks to John Duggan).
+
+### nova-trame, 0.22.1
+
+* ThemedApp now has an Exit Button by default which closes the application and can stop any running jobs (thanks to Gregory Cage).
+
+### nova-trame, 0.22.0
+
+* DataSelector queries subdirectories on demand, which should improve performance for large directory trees (thanks to John Duggan).
+
+### nova-trame, 0.21.0
+
+* ProgressBar component now displays detailed job status (thanks to Sergey Yakubov).
+
+### nova-trame, 0.20.5
+
+* DataSelector should now properly display files at the root of the selected directory (thanks to John Duggan).
+
+### nova-trame, 0.20.4
+
+* The Tornado dependency is now pinned to >=6.5 to address a DoS vulnerability (thanks to John Duggan).
+
+### nova-trame, 0.20.3
+
+* Performance of the DataSelector for large numbers of files should be improved (thanks to John Duggan).
+
+### nova-trame, 0.20.2
+
+* Matplotlib figure will no longer raise a TypeError when running on Python >= 3.11 (thanks to John Duggan).
+
+### nova-trame, 0.20.1
+
+* DataSelector now supports a `show_user_directories` flag that will allow users to choose datafiles from user directories (thanks to John Duggan).
+
+### nova-trame, 0.20.0
+
+* Three new components are available: ExecutionButtons, ProgressBar, and ToolOutputWindows. These components allow you to quickly add widgets to your UI for running and monitoring jobs (thanks to Sergey Yakubov).
+
+### nova-trame, 0.19.2
+
+* InputFields using type=autoscroll now work with nested state variables (thanks to John Duggan).
+
+### nova-trame, 0.19.1
+
+* DataSelector now has an additional parameter `extensions` for restricting the selectable datafiles to a list of file extensions (thanks to John Duggan).
+
+### nova-trame, 0.19.0
+
+* You can now use `nova.trame.view.components.DataSelector` to allow the user to select a list of data files from the analysis cluster (thanks to John Duggan).
+
+### nova-trame, 0.18.2
+
+* Passing a string to the style parameter to GridLayout, HBoxLayout, and VBoxLayout will no longer cause Trame to crash (thanks to John Duggan).
+* WebAgg-based Matplotlib figures are no longer automatically scrolled to on page load (thanks to John Duggan).
+* RemoteFileInput will no longer attempt to navigate to another directory after the filtering text field loses focus. The compact UI for this widget has also been updated (thanks to John Duggan).
+
+### nova-trame, 0.18.1
+
+* The `CompactTheme` has been overhauled and should produce denser UIs (thanks to Kristin Maroun).
+
+### nova-trame, 0.18.0
+
+* You can now use `nova.trame.view.components.FileUpload` to allow the user to upload a file from their computer or pick a file off of the analysis cluster (thanks to John Duggan).
+* Content placed in the `post_content` slot will now stick to the bottom of the main `content` slot instead of sticking to the bottom of the page (thanks to John Duggan).

nova_trame-1.2.1/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socioeconomic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+watsongr@ornl.gov.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.