furst-optics 0.0.0__tar.gz

furst_optics-0.0.0/.github/workflows/black.yml

@@ -0,0 +1,17 @@
+name: Black
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  black:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: psf/black@stable
+        with:
+          options: "--check --verbose --diff"
+          src: "./furst_optics"

furst_optics-0.0.0/.github/workflows/publish.yml

@@ -0,0 +1,33 @@
+name: Publish to PyPI
+
+permissions:
+  id-token: write
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    name: Build and publish to PyPI
+    if: startsWith(github.ref, 'refs/tags')
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - name: Set up Python
+        uses: actions/setup-python@v3
+      - name: Install pypa/build
+        run: >-
+          python -m
+          pip install
+          build
+          --user
+      - name: Build a binary wheel and a source tarball
+        run: >-
+          python -m
+          build
+          --sdist
+          --wheel
+          --outdir dist/
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

furst_optics-0.0.0/.github/workflows/ruff.yml

@@ -0,0 +1,14 @@
+name: Ruff
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: chartboost/ruff-action@v1

furst_optics-0.0.0/.readthedocs.yml

@@ -0,0 +1,18 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+  apt_packages:
+    - graphviz
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - doc

furst_optics-0.0.0/PKG-INFO

@@ -0,0 +1,27 @@
+Metadata-Version: 2.1
+Name: furst-optics
+Version: 0.0.0
+Summary: A model of the optical design for the Full-sun Ultraviolet Rocket Spectrometer (FURST).
+Author-email: "Roy T. Smart" <roytsmart@gmail.com>
+Project-URL: Homepage, https://github.com/Kankelborg-Group/furst-optics
+Project-URL: Documentation, https://furst-optics.readthedocs.io/en/latest
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: astropy
+Requires-Dist: optika==0.3.1
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Provides-Extra: doc
+Requires-Dist: pytest; extra == "doc"
+Requires-Dist: matplotlib; extra == "doc"
+Requires-Dist: graphviz; extra == "doc"
+Requires-Dist: sphinx-autodoc-typehints; extra == "doc"
+Requires-Dist: sphinxcontrib-bibtex; extra == "doc"
+Requires-Dist: pydata-sphinx-theme; extra == "doc"
+Requires-Dist: ipykernel; extra == "doc"
+Requires-Dist: jupyter-sphinx; extra == "doc"
+Requires-Dist: sphinx-favicon; extra == "doc"
+
+# furst-optics
+A model of the optical design for the Full-sun Ultraviolet Rocket Spectrometer (FURST).

furst_optics-0.0.0/README.md

@@ -0,0 +1,2 @@
+# furst-optics
+A model of the optical design for the Full-sun Ultraviolet Rocket Spectrometer (FURST).

furst_optics-0.0.0/docs/.gitignore

@@ -0,0 +1,2 @@
+_autosummary/
+_build/

furst_optics-0.0.0/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)

furst_optics-0.0.0/docs/_templates/class_custom.rst

@@ -0,0 +1,40 @@
+{{ name | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ fullname }}
+    :members:
+    :show-inheritance:
+    :inherited-members:
+    :undoc-members:
+    :member-order: groupwise
+
+    {% block attributes %}
+    {% if attributes %}
+    .. rubric:: {{ _('Attributes') }}
+
+    .. autosummary::
+    {% for item in attributes %}
+      ~{{ name }}.{{ item }}
+    {%- endfor %}
+    {% endif %}
+    {% endblock %}
+
+    {% block methods %}
+    {% if methods %}
+    .. rubric:: {{ _('Methods') }}
+
+    .. autosummary::
+    {% for item in methods %}
+      ~{{ name }}.{{ item }}
+    {%- endfor %}
+    {% endif %}
+    {% endblock %}
+
+    {% block dia %}
+    .. rubric:: {{ _('Inheritance Diagram') }}
+
+    .. inheritance-diagram:: {{ fullname }}
+        :parts: 1
+    {% endblock %}
+

furst_optics-0.0.0/docs/_templates/function_custom.rst

@@ -0,0 +1,5 @@
+{{ name | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autofunction:: {{ fullname }}

furst_optics-0.0.0/docs/_templates/module_custom.rst

@@ -0,0 +1,69 @@
+{{ name | escape | underline}}
+
+.. automodule:: {{ fullname }}
+
+    {% block attributes %}
+    {% if attributes %}
+    .. rubric:: Module Attributes
+
+    .. autosummary::
+      :toctree:
+    {% for item in attributes %}
+      {{ item }}
+    {%- endfor %}
+    {% endif %}
+    {% endblock %}
+
+    {% block functions %}
+    {% if functions %}
+    .. rubric:: {{ _('Functions') }}
+
+    .. autosummary::
+      :toctree:
+      :template: function_custom.rst
+    {% for item in functions %}
+      {{ item }}
+    {%- endfor %}
+    {% endif %}
+    {% endblock %}
+
+    {% block classes %}
+    {% if classes %}
+    .. rubric:: {{ _('Classes') }}
+
+    .. autosummary::
+      :toctree:
+      :template: class_custom.rst
+    {% for item in classes %}
+      {{ item }}
+    {%- endfor %}
+    {% endif %}
+    {% endblock %}
+
+    {% block exceptions %}
+    {% if exceptions %}
+    .. rubric:: {{ _('Exceptions') }}
+
+    .. autosummary::
+      :toctree:
+    {% for item in exceptions %}
+      {{ item }}
+    {%- endfor %}
+    {% endif %}
+    {% endblock %}
+
+    {% block modules %}
+    {% if modules %}
+    .. rubric:: Modules
+
+    .. autosummary::
+       :toctree:
+       :template: module_custom.rst
+       :recursive:
+    {% for item in modules %}
+       {{ item }}
+    {%- endfor %}
+    {% endif %}
+    {% endblock %}
+
+

furst_optics-0.0.0/docs/conf.py

@@ -0,0 +1,102 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+
+package_path = os.path.abspath('../')
+sys.path.insert(0, package_path)
+os.environ['PYTHONPATH'] = ';'.join((package_path, os.environ.get('PYTHONPATH', '')))
+
+# -- Project information -----------------------------------------------------
+
+project = 'furst-optics'
+copyright = '2024, Roy T. Smart'
+author = 'Roy T. Smart'
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.napoleon',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.inheritance_diagram',
+    'sphinx.ext.viewcode',
+    'sphinxcontrib.bibtex',
+    'jupyter_sphinx',
+]
+autosummary_generate = True  # Turn on sphinx.ext.autosummary
+autosummary_imported_members = True
+autosummary_ignore_module_all = False
+autodoc_typehints = "description"
+
+graphviz_output_format = 'png'
+inheritance_graph_attrs = dict(rankdir='TB')
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# This pattern also affects html_static_path and html_extra_path.
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+
+html_theme = 'pydata_sphinx_theme'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+html_theme_options = {
+    "icon_links": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/Kankelborg-Group/furst-optics",
+            "icon": "fa-brands fa-github",
+            "type": "fontawesome",
+        },
+        {
+            "name": "PyPI",
+            "url": "https://pypi.org/project/furst-optics",
+            "icon": "fa-brands fa-python",
+        },
+    ],
+    "analytics": {
+        "google_analytics_id": "G-X817NDXEC0"
+    },
+}
+
+# https://github.com/readthedocs/readthedocs.org/issues/2569
+master_doc = 'index'
+
+bibtex_bibfiles = ['refs.bib']
+bibtex_default_style = 'plain'
+bibtex_reference_style = 'author_year'
+
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3', None),
+    'numpy': ('https://numpy.org/doc/stable/', None),
+    'matplotlib': ('https://matplotlib.org/stable', None),
+    'astropy': ('https://docs.astropy.org/en/stable/', None),
+    'named_arrays': ('https://named-arrays.readthedocs.io/en/stable/', None),
+    'optika': ('https://optika.readthedocs.io/en/stable/', None),
+}

furst_optics-0.0.0/docs/index.rst

@@ -0,0 +1,44 @@
+Introduction
+============
+
+The Full-sun Ultraviolet Rocket Spectrometer (FURST) is a NASA sounding rocket
+mission designed to measure the full-disk spectrum of the Sun in the far
+ultraviolet spectral range (120 - 180 nm) with high spectral resolution.
+
+This package provides a idealized model of the FURST optical system which is
+designed to be used by the FURST data reduction pipeline.
+
+Installation
+============
+
+This package is published to PyPI and can be installed using pip:
+
+.. code-block::
+
+    pip install furst-optics
+
+API Reference
+=============
+
+.. autosummary::
+    :toctree: _autosummary
+    :template: module_custom.rst
+    :recursive:
+
+    furst_optics
+
+
+Bibliography
+============
+
+.. bibliography::
+
+|
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

furst_optics-0.0.0/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
+
+if "%1" == "" goto help
+
+%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.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

furst_optics-0.0.0/docs/refs.bib

@@ -0,0 +1,14 @@
+@ARTICLE{Pesnell2012,
+       author = {{Pesnell}, W. Dean and {Thompson}, B.~J. and {Chamberlin}, P.~C.},
+        title = "{The Solar Dynamics Observatory (SDO)}",
+      journal = {\solphys},
+     keywords = {SDO, Solar cycle, Helioseismology, Coronal, Space weather},
+         year = 2012,
+        month = jan,
+       volume = {275},
+       number = {1-2},
+        pages = {3-15},
+          doi = {10.1007/s11207-011-9841-3},
+       adsurl = {https://ui.adsabs.harvard.edu/abs/2012SoPh..275....3P},
+      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
+}

furst_optics-0.0.0/furst_optics/__init__.py

@@ -0,0 +1,3 @@
+"""
+An idealized raytrace model of the FURST optical system.
+"""

furst_optics-0.0.0/furst_optics.egg-info/PKG-INFO

@@ -0,0 +1,27 @@
+Metadata-Version: 2.1
+Name: furst-optics
+Version: 0.0.0
+Summary: A model of the optical design for the Full-sun Ultraviolet Rocket Spectrometer (FURST).
+Author-email: "Roy T. Smart" <roytsmart@gmail.com>
+Project-URL: Homepage, https://github.com/Kankelborg-Group/furst-optics
+Project-URL: Documentation, https://furst-optics.readthedocs.io/en/latest
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: astropy
+Requires-Dist: optika==0.3.1
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Provides-Extra: doc
+Requires-Dist: pytest; extra == "doc"
+Requires-Dist: matplotlib; extra == "doc"
+Requires-Dist: graphviz; extra == "doc"
+Requires-Dist: sphinx-autodoc-typehints; extra == "doc"
+Requires-Dist: sphinxcontrib-bibtex; extra == "doc"
+Requires-Dist: pydata-sphinx-theme; extra == "doc"
+Requires-Dist: ipykernel; extra == "doc"
+Requires-Dist: jupyter-sphinx; extra == "doc"
+Requires-Dist: sphinx-favicon; extra == "doc"
+
+# furst-optics
+A model of the optical design for the Full-sun Ultraviolet Rocket Spectrometer (FURST).

furst_optics-0.0.0/furst_optics.egg-info/SOURCES.txt

@@ -0,0 +1,22 @@
+.readthedocs.yml
+README.md
+pyproject.toml
+.github/workflows/black.yml
+.github/workflows/publish.yml
+.github/workflows/ruff.yml
+docs/.gitignore
+docs/Makefile
+docs/conf.py
+docs/index.rst
+docs/make.bat
+docs/refs.bib
+docs/_static/.gitkeep
+docs/_templates/class_custom.rst
+docs/_templates/function_custom.rst
+docs/_templates/module_custom.rst
+furst_optics/__init__.py
+furst_optics.egg-info/PKG-INFO
+furst_optics.egg-info/SOURCES.txt
+furst_optics.egg-info/dependency_links.txt
+furst_optics.egg-info/requires.txt
+furst_optics.egg-info/top_level.txt

furst_optics-0.0.0/furst_optics.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

furst_optics-0.0.0/furst_optics.egg-info/requires.txt

@@ -0,0 +1,16 @@
+astropy
+optika==0.3.1
+
+[doc]
+pytest
+matplotlib
+graphviz
+sphinx-autodoc-typehints
+sphinxcontrib-bibtex
+pydata-sphinx-theme
+ipykernel
+jupyter-sphinx
+sphinx-favicon
+
+[test]
+pytest

furst_optics-0.0.0/furst_optics.egg-info/top_level.txt

@@ -0,0 +1 @@
+furst_optics

furst_optics-0.0.0/pyproject.toml

@@ -0,0 +1,42 @@
+[build-system]
+requires = ["setuptools", "setuptools-scm"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "furst-optics"
+authors = [
+    {name = "Roy T. Smart", email = "roytsmart@gmail.com"},
+]
+description = "A model of the optical design for the Full-sun Ultraviolet Rocket Spectrometer (FURST)."
+readme = "README.md"
+requires-python = ">=3.10"
+classifiers = [
+    "Programming Language :: Python :: 3",
+]
+dependencies = [
+    "astropy",
+    "optika==0.3.1",
+]
+dynamic = ["version"]
+
+[project.optional-dependencies]
+test = [
+    "pytest",
+]
+doc = [
+    "pytest",
+    "matplotlib",
+    "graphviz",
+    "sphinx-autodoc-typehints",
+    "sphinxcontrib-bibtex",
+    "pydata-sphinx-theme",
+    "ipykernel",
+    "jupyter-sphinx",
+    "sphinx-favicon",
+]
+
+[project.urls]
+Homepage = "https://github.com/Kankelborg-Group/furst-optics"
+Documentation = "https://furst-optics.readthedocs.io/en/latest"
+
+[tool.setuptools_scm]

furst_optics-0.0.0/setup.cfg

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