mtgeodesicdome 1.2.0__tar.gz

mtgeodesicdome-1.2.0/CHANGELOG.md

@@ -0,0 +1,54 @@
+# Changelog
+
+All notable changes are recorded here. The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and the project uses [Semantic Versioning](https://semver.org/).
+
+## [Unreleased]
+
+## [1.2.0] — 2026-09-28
+
+### Changed
+- **New home.** Published as `mtgeodesicdome` (import `mt.geodesicdome`) from
+  [`takatsuka/mtGeodesicDome`](https://github.com/takatsuka/mtGeodesicDome).
+- `src/` layout; tests in `tests/`; the old plotly/dash viewers moved to `examples/legacy/`.
+- GitHub Actions workflows for tests (Linux, macOS, Windows; Python 3.10–3.14) and PyPI publishing.
+- Code tidied to pass `ruff check` (type hints use built-in generics such as `list[int]`, unused
+  variables removed). No change in behaviour.
+
+### Added
+- `tests/test_geodesicdome.py`: sizes, `split` and neighbour-ring checks.
+- User guide in `docs/index.md`.
+
+### Fixed
+- The abstract methods of `Manifold` and `Projection` raised `TypeError` (`raise NotImplemented()`);
+  they now raise `NotImplementedError`.
+
+---
+
+## Earlier history
+
+### 1.1.0 (first release since 1.0.11 on PyPI)
+
+*Fixes*
+* Fixed `GeodesicDome(frequency=n)` for n > 1. Previously it recorded frequency n² and building faces failed.
+* Fixed seam linking along one edge of the net (v6–v7 / v10–v7). 2(f−1) vertices there returned only
+  4 of their 6 neighbours. Neighbour rings now match graph distance on the sphere for every vertex.
+* `latlon_coord` is now stored as float (it was truncated to integers).
+* `util.facing` no longer uses `np.cross` on 2D vectors, which is deprecated in NumPy 2.
+* Removed debug `print`s from `split()`.
+
+*New*
+* Subpackage `interactive`: `ProjectionViewer` (drag to rotate the sphere in a map projection),
+  `SphereMap` (seam- and pole-correct projection of a rotated mesh), `unique_mesh` and rotation helpers.
+* `Projection` gained vectorised `latlong_to_2d`, `xyz_to_2d_many` and `outline`. Existing methods are unchanged.
+* `GeodesicDome.__repr__` and `__version__`.
+* The `examples/` folder, this README, a test suite, and `setup_env.sh` for a complete development
+  environment.
+
+*Packaging*
+* Licensed under **AGPL-3.0-or-later** with an attribution term (see the [README](https://github.com/takatsuka/mtGeodesicDome#8-licence)).
+* Built from `pyproject.toml`, which replaces `setup.py`. Correct requirements: Python ≥ 3.10 and NumPy,
+  plus optional extras.
+* Test scripts are no longer shipped in the wheel.
+
+### 1.0.7 – 1.0.11 (2024): earlier releases.

mtgeodesicdome-1.2.0/CITATION.cff

@@ -0,0 +1,35 @@
+cff-version: 1.2.0
+message: >-
+  If you use this software, please cite the publication below
+  (preferred-citation) and, where appropriate, the software itself.
+title: "mtGeodesicDome: geodesic domes for Python"
+type: software
+authors:
+  - family-names: Takatsuka
+    given-names: Masahiro
+    email: masa@takatsuka.org
+version: 1.2.0
+date-released: "2026-09-28"
+license: AGPL-3.0-or-later
+repository-code: "https://github.com/takatsuka/mtGeodesicDome"
+url: "https://pypi.org/project/mtgeodesicdome/"
+keywords:
+  - geodesic dome
+  - icosahedral grid
+  - spherical self-organizing map
+preferred-citation:
+  type: article
+  authors:
+    - family-names: Wu
+      given-names: Yingxin
+    - family-names: Takatsuka
+      given-names: Masahiro
+  title: "Spherical self-organizing map using efficient indexed geodesic data structure"
+  journal: "Neural Networks"
+  volume: 19
+  issue: "6-7"
+  start: 900
+  end: 910
+  year: 2006
+  month: 7
+  doi: "10.1016/j.neunet.2006.05.021"

mtgeodesicdome-1.2.0/CONTRIBUTING.md

@@ -0,0 +1,40 @@
+# Contributing to mtGeodesicDome
+
+Thank you for considering a contribution! Bug reports, questions and pull requests are welcome on
+[GitHub](https://github.com/takatsuka/mtGeodesicDome/issues).
+
+## Development set-up
+
+```bash
+python -m venv .venv && source .venv/bin/activate
+pip install -e ".[dev]"         # editable install with test and lint tools
+pytest                          # runs the test suite
+ruff check . && ruff format .   # lint and format
+```
+
+Please add or update tests in `tests/`, add a line to `CHANGELOG.md` under *Unreleased*, and keep
+the `SPDX-License-Identifier` and copyright header at the top of every source file.
+
+## Licence of contributions (please read)
+
+mtGeodesicDome is published under the GNU Affero GPL v3 or later (AGPL-3.0-or-later), with an additional attribution term (see
+`LICENSE` and `NOTICE`). The copyright holder, Masahiro Takatsuka, also offers the software under other
+licences, including commercial ones. To keep that possible, contributions are accepted only on the
+following terms.
+
+By submitting a contribution (a pull request, patch, or other material) you confirm that:
+
+1. **You have the right to submit it.** The contribution is your original work, or you otherwise have the
+   right to submit it under these terms. If your employer has rights to your work, you have its permission.
+2. **You keep your copyright,** and license the contribution to the public under the GNU AGPL v3 or later,
+   like the rest of the project.
+3. **You also grant a broader licence to Masahiro Takatsuka.** This is a perpetual, worldwide,
+   non-exclusive, royalty-free, irrevocable licence, including under any patent claims you can license that
+   the contribution necessarily infringes. It covers using, reproducing, modifying, distributing and
+   sublicensing the contribution, and licensing it under any other terms, including proprietary or
+   commercial ones, alone or as part of mtGeodesicDome or any other work.
+4. **You are not owed any payment or support,** and the contribution is provided "as is", without
+   warranty.
+
+Please state in your pull request: *"I agree to the licence terms in CONTRIBUTING.md."* Pull requests
+without that statement cannot be merged.