pylunar 0.7.3__tar.gz → 0.8.0__tar.gz

{pylunar-0.7.3 → pylunar-0.8.0}/CONTRIBUTING.rst

@@ -93,9 +93,8 @@ Pull Request Guidelines
 Before you submit a pull request, check that it meets these guidelines:
 
 #. The pull request should include tests.
-#. If the pull request adds functionality, the docs should be updated. Put
-   your new functionality into a function with a docstring, and add the
-   feature to the list in HISTORY.rst.
+#. If the pull request adds functionality, put your new functionality into a
+   function with a docstring. Run ``scriv create`` to add a changelog fragment and fill out the appropriate section for the change. Add that to the commits for the pull request.
 #. The pull request should work for the supported range of Python versions.
    The pull request will run GitHub actions to perform those checks.
    Check https://github.com/mareuter/pylunar/pulls

{pylunar-0.7.3 → pylunar-0.8.0}/HISTORY.rst

@@ -2,6 +2,35 @@
 
 History
 -------
+.. scriv-insert-here
+
+.. _changelog-0.8.0:
+
+0.8.0 (2024-11-09)
+++++++++++++++++++
+
+Added
+^^^^^
+
+- Solar altitude over lunar feature calculation
+- AltitudeDict class to provide solar altitude for Lunar II features
+- Use scriv for history generation
+
+Changed
+^^^^^^^
+
+- OS version for readthedocs build
+- Updated CONTRIBUTING.rst to add scriv usage
+
+Fixed
+^^^^^
+
+- Internal class cross-references in docs
+
+0.7.4 (2024-10-27)
+++++++++++++++++++
+
+* Updates to project dependencies
 
 0.7.3 (2024-09-29)
 ++++++++++++++++++

{pylunar-0.7.3 → pylunar-0.8.0}/Makefile

@@ -17,6 +17,7 @@ help:
 init:
 	pip install --editable .[dev]
 	pre-commit install
+	mkdir changelog.d
 
 clean: clean-build clean-docs clean-pyc
 

{pylunar-0.7.3 → pylunar-0.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pylunar
-Version: 0.7.3
+Version: 0.8.0
 Summary: Information for completing the Astronomical League's Lunar and Lunar II observing programs.
 Author-email: Michael Reuter <mareuternh@gmail.com>
 Project-URL: Documentation, http://pylunar.readthedocs.io
@@ -18,21 +18,23 @@ Classifier: Programming Language :: Python :: 3.12
 Description-Content-Type: text/x-rst
 License-File: LICENSE
 License-File: AUTHORS.rst
-Requires-Dist: ephem==4.1.5
+Requires-Dist: ephem==4.1.6
 Requires-Dist: importlib-resources==6.4.5; python_version < "3.10"
 Requires-Dist: typing-extensions==4.12.2; python_version < "3.10"
 Requires-Dist: pytz==2024.2
 Provides-Extra: dev
 Requires-Dist: pylunar[build,docs,lint,test]; extra == "dev"
-Requires-Dist: tox==4.20.0; extra == "dev"
+Requires-Dist: scriv==1.5.1; extra == "dev"
+Requires-Dist: tox==4.23.2; extra == "dev"
 Provides-Extra: test
-Requires-Dist: coverage[toml]==7.6.1; extra == "test"
+Requires-Dist: coverage[toml]==7.6.1; python_version < "3.9" and extra == "test"
+Requires-Dist: coverage[toml]==7.6.4; python_version >= "3.9" and extra == "test"
 Requires-Dist: pytest==8.3.3; extra == "test"
 Provides-Extra: lint
 Requires-Dist: pre-commit==3.5.0; python_version < "3.9" and extra == "lint"
 Requires-Dist: pre-commit==3.8.0; python_version >= "3.9" and extra == "lint"
 Provides-Extra: build
-Requires-Dist: build==1.2.2; extra == "build"
+Requires-Dist: build==1.2.2.post1; extra == "build"
 Requires-Dist: twine==5.1.1; extra == "build"
 Provides-Extra: docs
 Requires-Dist: sphinx~=7.1; extra == "docs"

{pylunar-0.7.3 → pylunar-0.8.0}/docs/usage.rst

@@ -22,22 +22,22 @@ API requires UTC, so add 4 hours since on Daylight Savings (changes day)
     >>> mi.phase_name()
     'WAXING_GIBBOUS'
 
-This package also contains the :py:class:`.LunarFeatureContainer` class which holds features on the moon for the Astronomical League's Lunar Club and Lunar II observing programs. To create a container for the Lunar Club program, do.
+This package also contains the :py:class:`pylunar.LunarFeatureContainer` class which holds features on the moon for the Astronomical League's Lunar Club and Lunar II observing programs. To create a container for the Lunar Club program, do.
 
 	>>> lc = pylunar.LunarFeatureContainer("Lunar")
 	>>> lc.load()
 	>>> len(lc)
 	90
 
-There are 90 features available to this observing program. The container allows one to filter those features based on the position of the lunar terminator with respect to a given feature. The :py:meth:`.LunarFeatureContainer.load` method can be passed a :py:class:`.MoonInfo` instance to perform that filtering.
+There are 90 features available to this observing program. The container allows one to filter those features based on the position of the lunar terminator with respect to a given feature. The :py:meth:`pylunar.LunarFeatureContainer.load` method can be passed a :py:class:`pylunar.MoonInfo` instance to perform that filtering.
 
 	>>> lc.load(mi)
 	>>> len(lc)
 	12
 
-A container for Lunar II can be created by passing the `LunarII` string to the constructor of :py:class:`.LunarFeatureContainer`.
+A container for Lunar II can be created by passing the `LunarII` string to the constructor of :py:class:`pylunar.LunarFeatureContainer`.
 
-Feature instances (:py:class:`.LunarFeature`) can be obtained from the container in usual manner.
+Feature instances (:py:class:`pylunar.LunarFeature`) can be obtained from the container in usual manner.
 
 	>>> for feature in lc:
 	...     print(feature)

{pylunar-0.7.3 → pylunar-0.8.0}/pyproject.toml

@@ -27,7 +27,7 @@ classifiers = [
     "Programming Language :: Python :: 3.12",
 ]
 dependencies = [
-    "ephem==4.1.5",
+    "ephem==4.1.6",
     "importlib-resources==6.4.5;python_version<'3.10'",
     "typing-extensions==4.12.2;python_version<'3.10'",
     "pytz==2024.2"
@@ -40,10 +40,12 @@ Repository = "https://github.com/mareuter/pylunar"
 [project.optional-dependencies]
 dev = [
     "pylunar[build,docs,lint,test]",
-    "tox==4.20.0"
+    "scriv==1.5.1",
+    "tox==4.23.2"
 ]
 test = [
-    "coverage[toml]==7.6.1",
+    "coverage[toml]==7.6.1;python_version<'3.9'",
+    "coverage[toml]==7.6.4;python_version>='3.9'",
     "pytest==8.3.3",
 ]
 lint = [
@@ -51,7 +53,7 @@ lint = [
     "pre-commit==3.8.0;python_version>='3.9'"
 ]
 build = [
-    "build==1.2.2",
+    "build==1.2.2.post1",
     "twine==5.1.1"
 ]
 docs = [
@@ -67,11 +69,11 @@ exclude = [
     "scripts/startup.py"
 
 ]
-ignore = [
+lint.ignore = [
     "D104"
 ]
 line-length = 110
-select = [
+lint.select = [
     "B",
     "D",
     "E",
@@ -82,7 +84,7 @@ select = [
     "W"
 ]
 
-[tool.ruff.per-file-ignores]
+[tool.ruff.lint.per-file-ignores]
 "src/pylunar/__init__.py" = [
     "E402",
     "F401",
@@ -94,7 +96,7 @@ select = [
     "D103",
 ]
 
-[tool.ruff.isort]
+[tool.ruff.lint.isort]
 force-sort-within-sections = true
 
 [tool.ruff.lint.pydocstyle]
@@ -121,3 +123,8 @@ exclude = [
     "conf",
     "startup"
 ]
+
+[tool.scriv]
+entry_title_template = "{{ version }} ({{ date.strftime('%Y-%m-%d') }})"
+output_file = "HISTORY.${config:format}"
+rst_header_chars = "+^"

{pylunar-0.7.3 → pylunar-0.8.0}/src/pylunar/__init__.py

@@ -9,6 +9,7 @@
 # license that can be found in the LICENSE file.
 
 __all__ = [
+    "AltitudeDict",
     "__author__",
     "__email__",
     "__version__",
@@ -36,6 +37,7 @@ version_info = __version__.split(".")
 Use this for version comparison.
 """
 
+from .altitude_dict import AltitudeDict
 from .helpers import mjd_to_date_tuple, tuple_to_string
 from .lunar_feature import LunarFeature
 from .lunar_feature_container import LunarFeatureContainer

pylunar-0.8.0/src/pylunar/altitude_dict.py

@@ -0,0 +1,57 @@
+# This file is part of pylunar.
+#
+# Developed by Michael Reuter.
+#
+# See the LICENSE file at the top-level directory of this distribution
+# for details of code ownership.
+#
+# Use of this source code is governed by a 3-clause BSD-style
+# license that can be found in the LICENSE file.
+
+"""Module for the AltitudeDict class."""
+
+from __future__ import annotations
+
+import sys
+from typing import Dict
+
+if sys.version_info >= (3, 10):
+    from importlib.resources import files
+else:
+    from importlib_resources import files
+
+import sqlite3
+
+from .lunar_feature import LunarFeature
+from .moon_info import MoonInfo
+
+__all__ = ["AltitudeDict"]
+
+
+class AltitudeDict(Dict[str, float]):
+    """Dictionary for the Lunar II features requiring solar altitude."""
+
+    def load(self, moon_info: MoonInfo) -> None:
+        """Provide solar altitude for the Lunar II features.
+
+        Parameters
+        ----------
+        moon_info : :class:`pylunar.MoonInfo`
+            Instance of the Lunar information class.
+        """
+        features = ["Byrgius A", "Proclus", "Rupes Recta", "Tycho"]
+        dbname = str(files("pylunar.data").joinpath("lunar.db"))
+        conn = sqlite3.connect(dbname)
+        cur = conn.cursor()
+
+        sql = f"select * from Features where Name in {str(tuple(features))}"
+        cur.execute(sql)
+
+        feature_list = []
+        for row in cur:
+            feature_list.append(LunarFeature.from_row(row))
+
+        for feature in sorted(feature_list, key=lambda x: x.name):
+            self[feature.name] = moon_info.solar_altitude(feature)
+
+        cur.close()

{pylunar-0.7.3 → pylunar-0.8.0}/src/pylunar/lunar_feature.py

@@ -108,7 +108,7 @@ class LunarFeature:
 
         Returns
         -------
-        :class:`.LunarFeature`
+        :class:`pylunar.LunarFeature`
             Class initialized from database row.
         """
         return cls(*row[1:])

{pylunar-0.7.3 → pylunar-0.8.0}/src/pylunar/lunar_feature_container.py

@@ -52,7 +52,7 @@ class LunarFeatureContainer:
 
         Yields
         ------
-        :class:`.LunarFeature`
+        :class:`pylunar.LunarFeature`
             The current lunar feature.
         """
         yield from self.features.values()
@@ -72,7 +72,7 @@ class LunarFeatureContainer:
 
         Parameters
         ----------
-        moon_info : :class:`.MoonInfo`, optional
+        moon_info : :class:`pylunar.MoonInfo`, optional
             Instance of the Lunar information class.
         limit : int, optional
             Restrict the number of features read to the given value.

{pylunar-0.7.3 → pylunar-0.8.0}/src/pylunar/moon_info.py

@@ -266,7 +266,7 @@ class MoonInfo:
 
         Parameters
         ----------
-        feature : :class:`.LunarFeature`
+        feature : :class:`pylunar.LunarFeature`
             The lunar feature instance to check.
 
         Returns
@@ -291,7 +291,7 @@ class MoonInfo:
 
         Parameters
         ----------
-        feature : :class:`.LunarFeature`
+        feature : :class:`pylunar.LunarFeature`
             The lunar feature instance to check.
 
         Returns
@@ -556,6 +556,29 @@ class MoonInfo:
 
         return sorted_times
 
+    def solar_altitude(self, feature: LunarFeature) -> float:
+        """Find the altitude of the sun over a given feature.
+
+        Sunrise is near zero degrees, noon is near 90 degrees and sunset is
+        near 180 degrees.
+
+        Parameters
+        ----------
+        feature : :class:`pylunar.LunarFeature`
+            Feature to calculate solar altitude.
+
+        Returns
+        -------
+        float
+            Solar altitude over feature in degrees.
+        """
+        rad_ss_lat = math.radians(self.subsolar_lat())
+        rad_feature_lat = math.radians(feature.latitude)
+        term1 = math.sin(rad_ss_lat) * math.sin(rad_feature_lat)
+        term2a = math.cos(rad_ss_lat) * math.cos(rad_feature_lat)
+        term2b = math.sin(math.radians(self.colong() + feature.longitude))
+        return math.degrees(math.asin(term1 + term2a * term2b))
+
     def subsolar_lat(self) -> float:
         """Latitude in degress on the moon where the sun is overhead.
 

{pylunar-0.7.3 → pylunar-0.8.0}/src/pylunar.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pylunar
-Version: 0.7.3
+Version: 0.8.0
 Summary: Information for completing the Astronomical League's Lunar and Lunar II observing programs.
 Author-email: Michael Reuter <mareuternh@gmail.com>
 Project-URL: Documentation, http://pylunar.readthedocs.io
@@ -18,21 +18,23 @@ Classifier: Programming Language :: Python :: 3.12
 Description-Content-Type: text/x-rst
 License-File: LICENSE
 License-File: AUTHORS.rst
-Requires-Dist: ephem==4.1.5
+Requires-Dist: ephem==4.1.6
 Requires-Dist: importlib-resources==6.4.5; python_version < "3.10"
 Requires-Dist: typing-extensions==4.12.2; python_version < "3.10"
 Requires-Dist: pytz==2024.2
 Provides-Extra: dev
 Requires-Dist: pylunar[build,docs,lint,test]; extra == "dev"
-Requires-Dist: tox==4.20.0; extra == "dev"
+Requires-Dist: scriv==1.5.1; extra == "dev"
+Requires-Dist: tox==4.23.2; extra == "dev"
 Provides-Extra: test
-Requires-Dist: coverage[toml]==7.6.1; extra == "test"
+Requires-Dist: coverage[toml]==7.6.1; python_version < "3.9" and extra == "test"
+Requires-Dist: coverage[toml]==7.6.4; python_version >= "3.9" and extra == "test"
 Requires-Dist: pytest==8.3.3; extra == "test"
 Provides-Extra: lint
 Requires-Dist: pre-commit==3.5.0; python_version < "3.9" and extra == "lint"
 Requires-Dist: pre-commit==3.8.0; python_version >= "3.9" and extra == "lint"
 Provides-Extra: build
-Requires-Dist: build==1.2.2; extra == "build"
+Requires-Dist: build==1.2.2.post1; extra == "build"
 Requires-Dist: twine==5.1.1; extra == "build"
 Provides-Extra: docs
 Requires-Dist: sphinx~=7.1; extra == "docs"

{pylunar-0.7.3 → pylunar-0.8.0}/src/pylunar.egg-info/SOURCES.txt

@@ -20,6 +20,7 @@ docs/make.bat
 docs/usage.rst
 scripts/startup.py
 src/pylunar/__init__.py
+src/pylunar/altitude_dict.py
 src/pylunar/helpers.py
 src/pylunar/lunar_feature.py
 src/pylunar/lunar_feature_container.py
@@ -32,6 +33,7 @@ src/pylunar.egg-info/requires.txt
 src/pylunar.egg-info/top_level.txt
 src/pylunar/data/lunar.db
 tests/__init__.py
+tests/test_altitude_dict.py
 tests/test_helpers.py
 tests/test_lunar_feature.py
 tests/test_lunar_feature_container.py

{pylunar-0.7.3 → pylunar-0.8.0}/src/pylunar.egg-info/requires.txt

@@ -1,4 +1,4 @@
-ephem==4.1.5
+ephem==4.1.6
 pytz==2024.2
 
 [:python_version < "3.10"]
@@ -6,12 +6,13 @@ importlib-resources==6.4.5
 typing-extensions==4.12.2
 
 [build]
-build==1.2.2
+build==1.2.2.post1
 twine==5.1.1
 
 [dev]
 pylunar[build,docs,lint,test]
-tox==4.20.0
+scriv==1.5.1
+tox==4.23.2
 
 [docs]
 sphinx~=7.1
@@ -26,5 +27,10 @@ pre-commit==3.5.0
 pre-commit==3.8.0
 
 [test]
-coverage[toml]==7.6.1
 pytest==8.3.3
+
+[test:python_version < "3.9"]
+coverage[toml]==7.6.1
+
+[test:python_version >= "3.9"]
+coverage[toml]==7.6.4

pylunar-0.8.0/tests/test_altitude_dict.py

@@ -0,0 +1,31 @@
+# This file is part of pylunar.
+#
+# Developed by Michael Reuter.
+#
+# See the LICENSE file at the top-level directory of this distribution
+# for details of code ownership.
+#
+# Use of this source code is governed by a 3-clause BSD-style
+# license that can be found in the LICENSE file.
+
+"""Tests for AltitudeDict class."""
+
+from pylunar import AltitudeDict, MoonInfo
+
+
+class TestAltitudeDict:
+    def setup_class(self) -> None:
+        self.ad = AltitudeDict()
+
+    def test_basic_information_after_creation(self) -> None:
+        assert len(self.ad) == 0
+
+    def test_information_after_load(self) -> None:
+        location = ((35, 58, 10), (-84, 19, 0))
+        mi = MoonInfo(location[0], location[1])
+        mi.update((2013, 10, 12, 18, 0, 0))
+
+        self.ad.load(mi)
+        assert len(self.ad) == 4
+        assert list(self.ad.keys()) == ["Byrgius A", "Proclus", "Rupes Recta", "Tycho"]
+        assert self.ad["Rupes Recta"] == 1.3038753306292297

{pylunar-0.7.3 → pylunar-0.8.0}/tests/test_moon_info.py

@@ -251,3 +251,20 @@ class TestMoonInfo:
         assert self.mi.is_libration_ok(feature1) is False
         assert self.mi.is_libration_ok(feature2) is False
         assert self.mi.is_libration_ok(feature3) is True
+
+    def test_solar_altitude(self) -> None:
+        self.mi.update((1992, 4, 12, 0, 0, 0))
+        feature = LunarFeature(
+            "Copernicus",
+            96.0699,
+            9.62094521642403,
+            -20.078620508253,
+            3.1684722900391,
+            3.21326828003004,
+            "Crater",
+            "Copernicus",
+            "LAC-58",
+            "Lunar",
+            "Binocular",
+        )
+        assert self.mi.solar_altitude(feature) == 1.9649120982751562