[DOC] PyPI-first install docs; drop unused dolfyn dependency - #81
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Reworks the install documentation now that both
oceanarrayandseasenselibare on PyPI, and removes the redundant directdolfyndependency.seasenselibis now a hard dependency (declared inrequirements.txt, which feedspyproject.toml's dynamic dependencies), so the oldpip install --no-deps/pip install -e ../seasenselibworkaround is gone. A plainpip install oceanarrayresolves the whole stack, verified end-to-end in a fresh venv (imports plusoceanarray --helpandseasenselib list).Changes
requirements.txt:seasenselibbecomes a hard dependency; the directdolfynline is removed. oceanarray never importsdolfyn— therdi-rawreader lives inseasenselib, which reads RDI files throughmhkit.dolfyn(mhkit vendors dolfyn as a subpackage and is pulled in via seasenselib'smhkit[dolfyn]>=1.0.0). The standalonedolfynpackage was installed but imported by nothing. Verified: with standalonedolfynuninstalled, seasenselib's reader still resolves viamhkit.dolfyn.io.rdi.read_rdiandoceanarray.processors.stage1imports cleanly.docs/source/setup.md,quickstart.rst,yaml_configuration.rst,roadmap.rst,README.md,troubleshooting.rst: install instructions lead withpip install oceanarray; the separate "install mhkit[dolfyn] for RDI" steps are dropped because RDI support now arrives automatically with seasenselib; the roadmap dependency list is corrected (dolfyn removed as a direct dep;rdi-rawadded to the seasenselib reader list).Notes on dependency footprint
Making
seasenseliba hard dependency raises the download from ~81 MB (core) to ~236 MB. The heaviest transitive additions — PyQt5/Qt (~42 MB, viapylablib) and llvmlite/numba (~40 MB, viapylablib) — are hopefully being removed upstream inseasenselib;mhkit→pyarrow(~34 MB) stays because it carries the vendored dolfyn used for RDI reading. After the upstream trim the seasenselib delta drops to ~73 MB, which is why seasenselib is kept as a hard dependency rather than an optional[raw]extra.Breaking changes
None.
seasenselibmoving from a manual side-install to a declared dependency only adds packages to a fresh install; no public API, CLI flag, output layout, or config option changes. Removing the directdolfynline changes nothing observable — RDI reading already went through seasenselib'smhkit.dolfyn.