Skip to content

docs: explain development notes #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
IAmirKhani merged 1 commit into from
Aug 31, 2026
Merged

docs: explain development notes #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions notes/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Development Notes

This directory preserves internal planning documents created while migrating the earlier
PyGPLA development code into the current Python package. They are retained as a historical
record of the project’s design and migration process, not as current user documentation.
For current information, see the repository `README.md` and the documentation under `docs/`.

## Implemented

The planned `src/pygpla` package structure, layered core/preprocessing/statistics API,
configuration objects, supported simulations, Hatchling packaging, tests, CI, Sphinx
documentation, and PyPI distribution were implemented.

## Deviations

Unsupported or unused planned components—including multifrequency simulations, utility and
statistics-summary modules, bundled datasets, and a CLI—were not retained. Sphinx was chosen
instead of MkDocs, Python support starts at 3.10, and automated regression fixtures against
MATLAB reference outputs remain future work.
Loading