asterias 0.0.1__tar.gz

asterias-0.0.1/.gitignore

@@ -0,0 +1,21 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments/testing
+.venv
+.tox
+coverage.xml
+.coverage
+.pytest_cache
+.ruff_cache
+
+# Docs
+docs/_build/
+
+*.DS_Store
+*slurm*

asterias-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,28 @@
+ci:
+  autoupdate_schedule: monthly
+
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: "v0.9.9"
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+
+  - repo: https://github.com/psf/black
+    rev: 25.1.0
+    hooks:
+      - id: black
+        language_version: python3.13
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: "v5.0.0"
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+        exclude_types: [json, binary]
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.4.1
+    hooks:
+    - id: codespell
+      args: ["--skip=scratch.ipynb,**/*.ipynb"]

asterias-0.0.1/.python-version

@@ -0,0 +1 @@
+3.13

asterias-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Ben Cassese
+
+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.

asterias-0.0.1/PKG-INFO

@@ -0,0 +1,10 @@
+Metadata-Version: 2.4
+Name: asterias
+Version: 0.0.1
+Summary: Add your description here
+Project-URL: Source, https://github.com/ben-cassese/asterias
+Author-email: Ben-Cassese <b.c.cassese@columbia.edu>
+License-File: LICENSE
+Requires-Python: >=3.13
+Requires-Dist: exotic-ld>=3.2.0
+Requires-Dist: jax>=0.5.3

asterias-0.0.1/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

asterias-0.0.1/docs/conf.py

@@ -0,0 +1,79 @@
+# Configuration file for the Sphinx documentation builder.
+
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath("."))
+sys.path.insert(0, os.path.abspath("../src"))
+
+project = "asterias"
+# copyright = '2025, Ben Cassese, Soichiro Hattori'
+author = "Ben Cassese, Soichiro Hattori"
+release = "0.0.1"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    # "sphinx_rtd_theme",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.autodoc",
+    "sphinx_autodoc_typehints",
+    "sphinx.ext.doctest",
+    "sphinx.ext.todo",
+    "sphinx.ext.mathjax",
+    "sphinx.ext.viewcode",
+    "nbsphinx",
+    "sphinx_automodapi.automodapi",
+    "myst_parser",
+    "sphinxcontrib.video",
+    # "sphinx.ext.pngmath",
+]
+
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "visualizations"]
+source_suffix = [".rst", ".md"]
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "sphinx_book_theme"
+html_copy_source = True
+html_show_sourcelink = True
+html_sourcelink_suffix = ""
+html_title = "asterias"
+html_favicon = "_static/starfish.png"
+html_static_path = ["_static"]
+
+html_theme_options = {
+    "path_to_docs": "docs",
+    "repository_url": "https://github.com/ben-cassese/asterias",
+    "repository_branch": "main",
+    "use_repository_button": True,
+    "use_download_button": False,
+    "show_prev_next": False,
+    "logo": {
+        "text": "",
+        "image_light": "_static/starfish.png",
+        "image_dark": "_static/starfish.png",
+    },
+}
+
+html_context = {"default_mode": "dark"}
+
+html_sidebars = {
+    "**": ["navbar-logo.html", "search-field.html", "sbt-sidebar-nav.html"]
+}
+
+autodoc_typehints = "description"
+python_use_unqualified_type_names = True
+autodoc_typehints_format = "fully-qualified"
+napoleon_use_param = True
+napoleon_use_rtype = True

asterias-0.0.1/docs/index.rst

@@ -0,0 +1,16 @@
+.. asterias documentation master file, created by
+   sphinx-quickstart on Thu Apr  3 00:40:04 2025.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+asterias documentation
+======================
+
+Add your content using ``reStructuredText`` syntax. See the
+`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
+documentation for details.
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:

asterias-0.0.1/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

asterias-0.0.1/pyproject.toml

@@ -0,0 +1,43 @@
+[project]
+name = "asterias"
+version = "0.0.1"
+description = "Add your description here"
+readme = "README.md"
+authors = [
+    { name = "Ben-Cassese", email = "b.c.cassese@columbia.edu" }
+
+]
+requires-python = ">=3.13"
+dependencies = [
+    "exotic-ld>=3.2.0",
+    "jax>=0.5.3",
+]
+
+[project.urls]
+# "Homepage" = ""
+"Source" = "https://github.com/ben-cassese/asterias"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[dependency-groups]
+dev = [
+    "black[jupyter]>=25.1.0",
+    "codespell>=2.4.1",
+    "myst-parser>=4.0.1",
+    "nbsphinx>=0.9.6",
+    "pre-commit>=4.2.0",
+    "pytest>=8.3.5",
+    "pytest-cov>=6.1.0",
+    "pytest-xdist>=3.6.1",
+    "ruff>=0.11.2",
+    "sphinx>=8.2.3",
+    "sphinx-autodoc-typehints>=3.1.0",
+    "sphinx-automodapi>=0.18.0",
+    "sphinx-book-theme>=1.1.4",
+    "sphinxcontrib-video>=0.4.1",
+    "tox>=4.25.0",
+    "tox-gh-actions>=3.3.0",
+    "tox-uv>=1.25.0",
+]

asterias-0.0.1/src/asterias/__init__.py

@@ -0,0 +1,2 @@
+def hello() -> str:
+    return "Hello from asterias!"

asterias-0.0.1/tox.ini

@@ -0,0 +1,21 @@
+[tox]
+envlist = py39,py310,py311,py312,py313
+skipsdist = true
+
+[testenv]
+allowlist_externals = uv
+commands =
+    uv sync --python {envpython} --group dev
+    uv pip freeze
+    uv run python -m pytest tests --cov --cov-config=pyproject.toml --cov-report=xml
+
+[gh-actions]
+python =
+    3.9: py39
+    3.10: py310
+    3.11: py311
+    3.12: py312
+    3.13: py313
+
+[coverage:run]
+branch = True