sxscatalog 3.0.0__tar.gz

sxscatalog-3.0.0/.github/workflows/ci.yml

@@ -0,0 +1,166 @@
+# SPDX-FileCopyrightText: 2025-present Mike Boyle <michael.oliver.boyle@gmail.com>
+#
+# SPDX-License-Identifier: MIT
+
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+    tags: ["*"]
+  pull_request:
+
+concurrency:
+  group: test-${{ github.head_ref }}
+  cancel-in-progress: true
+
+env:
+  PYTHONUNBUFFERED: "1"
+  FORCE_COLOR: "1"
+
+jobs:
+  test-and-release:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    permissions:
+      pages: write
+      id-token: write
+      contents: write
+    # Provide an output so the next job knows whether to release
+    outputs:
+      RUN_RELEASE: ${{ steps.release_check.outputs.run_release }}
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+
+      - name: Install dependencies
+        run: pip install --upgrade pip hatch
+
+      - name: Run tests
+        run: hatch run tests:test
+
+      - name: Check marimo
+        if: "!contains(github.event.head_commit.message, '[skip marimo check]')"
+        run: hatch run marimo:check
+
+      - name: Export notebook
+        run: hatch run marimo:convert
+
+      - name: Determine bump type
+        id: version
+        run: |
+          OLD_VERSION="$(hatch version)"
+          BUMP_TYPE="patch"
+          if [[ "$OLD_VERSION" == *"a"* ]]; then
+              BUMP_TYPE="a"
+          elif [[ "$OLD_VERSION" == *"b"* ]]; then
+              BUMP_TYPE="b"
+          fi
+          COMMIT_MSG="$(git log -1 --pretty=%B)"
+          if [[ "$COMMIT_MSG" == *"#major"* ]]; then
+              BUMP_TYPE="major"
+          elif [[ "$COMMIT_MSG" == *"#minor"* ]]; then
+              BUMP_TYPE="minor"
+          elif [[ "$COMMIT_MSG" == *"#patch"* ]]; then
+              BUMP_TYPE="patch"
+          elif [[ "$COMMIT_MSG" == *"#alpha"* ]]; then
+              BUMP_TYPE="a"
+          elif [[ "$COMMIT_MSG" == *"#beta"* ]]; then
+              BUMP_TYPE="b"
+          elif [[ "$COMMIT_MSG" == *"#release"* ]]; then
+              BUMP_TYPE="release"
+          fi
+          echo "BUMP_TYPE=$BUMP_TYPE" >> $GITHUB_OUTPUT
+
+      - name: Bump version
+        id: bump_version
+        run: |
+          export NO_COLOR=1  # To turn off formatting in `hatch version`
+          hatch version ${{ steps.version.outputs.BUMP_TYPE }}
+          NEW_VERSION="$(hatch version | tr -d '\n')"
+          echo "NEW_VERSION=$NEW_VERSION" >> $GITHUB_OUTPUT
+          echo "new_version=${NEW_VERSION}" >> $GITHUB_ENV
+          prerelease="false"
+          if [[ "$NEW_VERSION" == *"a"* ]]; then
+              prerelease="true"
+          elif [[ "$NEW_VERSION" == *"b"* ]]; then
+              prerelease="true"
+          fi
+          echo "prerelease=${prerelease}" >> $GITHUB_ENV
+
+      - name: Copy version to catalog_notebook.py dependencies
+        run: |
+          sed -i "s/sxscatalog==.*\"/sxscatalog==${{ env.new_version }}\"/" scripts/catalog_notebook.py
+
+      - name: Determine if release steps should run
+        id: release_check
+        run: |
+          # Default to skipping release steps
+          echo "run_release=false" >> $GITHUB_OUTPUT
+
+          # If the ref is main, check the commit message for [skip release]
+          if [[ "${GITHUB_REF}" == "refs/heads/main" ]]; then
+            COMMIT_MSG="$(git log -1 --pretty=%B)"
+            if [[ "$COMMIT_MSG" != *"[skip release]"* ]]; then
+              echo "run_release=true" >> $GITHUB_OUTPUT
+              echo "run_release=true"
+            fi
+          fi
+
+      - name: Commit version bump
+        if: ${{ steps.release_check.outputs.run_release == 'true' }}
+        run: |
+          # Note that we need to set read and write permissions under
+          # "Settings" > "Actions" > "General" > "Workflow permissions"
+          git config user.name github-actions
+          git config user.email github-actions@github.com
+          git add src/sxscatalog/__about__.py scripts/catalog_notebook.py
+          git commit -m "Bump version to v${new_version}"
+          git tag -a "v${new_version}" -m "Version ${new_version}"
+          git status
+          git push --follow-tags  # Will not trigger new workflow because it uses GITHUB_TOKEN
+
+      - name: Create GitHub Release
+        if: ${{ steps.release_check.outputs.run_release == 'true' }}
+        uses: softprops/action-gh-release@v2
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: v${{ env.new_version }}
+          name: Release v${{ env.new_version }}
+          draft: false
+          prerelease: ${{ env.prerelease }}
+
+      - name: Publish to PyPI
+        if: ${{ steps.release_check.outputs.run_release == 'true' }}
+        env:
+          # 1) Get key from https://pypi.org/manage/account/token/
+          # 2) Copy it to Github > repo > Settings > Secrets > Actions > New repository secret
+          HATCH_INDEX_USER: __token__
+          HATCH_INDEX_AUTH: ${{ secrets.PYPI_TOKEN }}
+        shell: bash
+        run: |
+          hatch build
+          hatch publish
+  
+      - name: Upload Pages Artifact
+        if: ${{ steps.release_check.outputs.run_release == 'true' }}
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: scripts/catalog_notebook_output
+
+      - name: Deploy to GitHub Pages
+        # Be sure to allow this under Settings > Pages > Build and deployment > Source > Github Actions
+        if: ${{ steps.release_check.outputs.run_release == 'true' }}
+        id: deployment
+        uses: actions/deploy-pages@v4
+        with:
+          artifact_name: github-pages

sxscatalog-3.0.0/.gitignore

@@ -0,0 +1,179 @@
+# 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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.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/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# 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
+#  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.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+uv.lock
+scripts/catalog_notebook_output
+.vscode
+notes

sxscatalog-3.0.0/LICENSE.txt

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2025-present Mike Boyle <michael.oliver.boyle@gmail.com>
+
+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.

sxscatalog-3.0.0/PKG-INFO

@@ -0,0 +1,39 @@
+Metadata-Version: 2.4
+Name: sxscatalog
+Version: 3.0.0
+Summary: Interface to the catalog of SXS simulations
+Project-URL: Documentation, https://github.com/Mike Boyle/sxscatalog#readme
+Project-URL: Issues, https://github.com/Mike Boyle/sxscatalog/issues
+Project-URL: Source, https://github.com/Mike Boyle/sxscatalog
+Author-email: Mike Boyle <michael.oliver.boyle@gmail.com>
+License-Expression: MIT
+License-File: LICENSE.txt
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+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: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.8
+Requires-Dist: numpy
+Requires-Dist: packaging
+Requires-Dist: pandas
+Requires-Dist: requests
+Requires-Dist: tqdm
+Description-Content-Type: text/markdown
+
+# sxscatalog
+
+[![PyPI - Version](https://img.shields.io/pypi/v/sxscatalog.svg)](https://pypi.org/project/sxscatalog)
+
+
+This package is a minimal set of tools for interacting with the SXS
+Collaboration's catalog of numerical-relativity simulations.  It is
+intended to be used by other packages, such as
+[`sxs`](https://github.com/sxs-collaboration/sxs/).  It only needs to
+exist separately for simple applications like [the web
+interface](https://sxs-collaboration.github.io/sxscatalog/); users will most
+likely never need this package directly.

sxscatalog-3.0.0/README.md

@@ -0,0 +1,12 @@
+# sxscatalog
+
+[![PyPI - Version](https://img.shields.io/pypi/v/sxscatalog.svg)](https://pypi.org/project/sxscatalog)
+
+
+This package is a minimal set of tools for interacting with the SXS
+Collaboration's catalog of numerical-relativity simulations.  It is
+intended to be used by other packages, such as
+[`sxs`](https://github.com/sxs-collaboration/sxs/).  It only needs to
+exist separately for simple applications like [the web
+interface](https://sxs-collaboration.github.io/sxscatalog/); users will most
+likely never need this package directly.

sxscatalog-3.0.0/pyproject.toml

@@ -0,0 +1,86 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "sxscatalog"
+dynamic = ["version"]
+description = 'Interface to the catalog of SXS simulations'
+readme = "README.md"
+requires-python = ">=3.8"
+license = "MIT"
+keywords = []
+authors = [
+  { name = "Mike Boyle", email = "michael.oliver.boyle@gmail.com" },
+]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: Implementation :: CPython",
+  "Programming Language :: Python :: Implementation :: PyPy",
+]
+dependencies = [
+  "requests",
+  "tqdm",
+  "pandas",
+  "numpy",
+  "packaging"
+]
+
+[project.urls]
+Documentation = "https://github.com/Mike Boyle/sxscatalog#readme"
+Issues = "https://github.com/Mike Boyle/sxscatalog/issues"
+Source = "https://github.com/Mike Boyle/sxscatalog"
+
+[tool.hatch.version]
+path = "src/sxscatalog/__about__.py"
+
+[tool.hatch.envs.types]
+extra-dependencies = [
+  "mypy>=1.0.0",
+]
+[tool.hatch.envs.types.scripts]
+check = "mypy --install-types --non-interactive {args:src/sxscatalog tests}"
+
+[tool.hatch.envs.marimo]
+extra-dependencies = [
+  "marimo",
+]
+[tool.hatch.envs.marimo.scripts]
+edit = "marimo edit --sandbox scripts/catalog_notebook.py"
+run = "marimo run --sandbox scripts/catalog_notebook.py"
+check = "uv run scripts/catalog_notebook.py"  # Just to see if the script runs successfully
+convert = "marimo export html-wasm scripts/catalog_notebook.py -o scripts/catalog_notebook_output --mode run"
+
+[tool.hatch.envs.tests]
+dependencies = [
+  "pytest",
+  "pytest-cov"
+]
+[tool.hatch.envs.tests.scripts]
+# Run these as `hatch run tests:test`
+test = "pytest {args:tests}"
+
+[tool.coverage.run]
+source_pkgs = ["sxscatalog", "tests"]
+branch = true
+parallel = true
+omit = [
+  "src/sxscatalog/__about__.py",
+]
+
+[tool.coverage.paths]
+sxscatalog = ["src/sxscatalog", "*/sxscatalog/src/sxscatalog"]
+tests = ["tests", "*/sxscatalog/tests"]
+
+[tool.coverage.report]
+exclude_lines = [
+  "no cov",
+  "if __name__ == .__main__.:",
+  "if TYPE_CHECKING:",
+]