TidalPy v0.7.0

Changes

Fixes

• Fixed top-level directories and files being mistakenly installed.
• Updated np.trapz to scipy.integrate.trapezoid due to deprecation of the former.
• Fixed bug in the henning melting model where shear modulus may not have had the correct value when fully melted.
• Fixed issues in some of the demo notebooks.
• Fixed notebooks to work with changes to Matplotlib.

GitHub Actions

• Added action to automatically update version numbers, dates, and commit hashs in citation.cff, codemeta.json, and meta.yaml.

Utilities

• Added fontsize kwarg to projection plotter in utilities.graphics.
• Changed the default of yplot so plotting imaginary parts of radial solution is by default off.

Documentation

• Added JOSS paper draft to Papers/2025-JOSS.
• Added documentation interface with Sphinx and ReadTheDocs.
• Added and updated readme badges.
• Extensive changes to all documentation files and structure.
• Changed how CHANGES.md (main change log) is structured. Major versions will appear as top level headers.

Other

• Change TidalPy's license to Apache 2.0.
• Added CODE_OF_CONDUCT.md with TidalPy's code of conduct.
• Added CONTRIBUTING.md with information on how others can contribute to TidalPy.
• Updated citation.cff with latest information.
• Added codemeta.json with citation and metadata.
• Removed MacOS-13 tests.
• Removed unused code, tests, and documentations.
• TidalPy now uses ruff to check for code issues.
  • Added ruff lint check to ubuntu tests.
• Fixed many code issues found with ruff (these are not bug fixes, just syntax compliance and best practices).
• Moved more module/file level constants into TidalPy.constants and in the configuration file.
• Added TidalPy logo.

GitHub Tracked Changes

• Improving citation meta by @jrenaud90 in #89
• Code Cleanup by @jrenaud90 in #90
• Joss paper draft by @jrenaud90 in #91
• Changes license to apache-2.0 by @jrenaud90 in #92
• Merging current v0.7.0 changes back into doc branch by @jrenaud90 in #93
• Adds logo by @jrenaud90 in #94
• Merging latest v0.7.0 changes to doc branch by @jrenaud90 in #95
• Adds Sphinx / ReadTheDocs Documentation by @jrenaud90 in #96
• Adds ReadTheDocs and other package improvements by @jrenaud90 in #102

Full Changelog: v0.6.11...v0.7.0

TidalPy v0.6.11

Changes

Dependencies

• Added more restrictive pinning for numpy's max version to work with latest CyRK.

GitHub Tracked Changes

Full Changelog: v0.6.10...v0.6.11

TidalPy v0.6.10

Changes

New

• RadialSolver solution can now provide quality factors rs_solution.Q and phase lag angles (in radians) rs_solution.lag.

Fixes

• Fixed issue where RadialSolver would incorrectly say a result was successful when the application of surface boundary conditions failed.
• Fixed issue where RadialSolver solution's diagnostics would print the incorrect parameter for a planet's mass.

Changes

• RadialSolver solution returns nan's instead of None for Love numbers when a solution fails.
• RadialSolver solution Love number attributes now return lists of np.nan if the user requested multiple solution types (e.g., "tidal, loading") and the solution failed. This allows the user to still subscript rs_solution.k[0], rs_solution.k[1] even if the solution was not successful.

Tests

• Added more tests to check RadialSolver Solution attributes.

GitHub Tracked Changes

• Incorrect success in rs by @jrenaud90 in #84

Full Changelog: v0.6.9...v0.6.10

TidalPy v0.6.9

Changes

Fixes

• Fixed issue where TidalPy.RadialSolver.shooting would pick the incorrect starting index. If the starting layer (set by the starting radius) was not the first layer it could cause a int overflow and lead to access violation crashes.

Dependencies

• Updates some GitHub action dependencies.

Tests

• Added more tests to check RadialSolver starting radius conditions to try to catch bugs like this patch fixed!

GitHub Tracked Changes

• Dev 0.6.9 by @jrenaud90 in #83

Full Changelog: v0.6.8...v0.6.9

TidalPy v0.6.8

Changes

• TidalPy.tides.modes.collapse_multilayer_modes now checks for ill-formed radius_arrays and will raise an error if it detects a problem.
• Improved how projection_map displays colorbar numbers.

Fixes

• Fixed issue where TidalPy.tides.modes.collapse_multilayer_modes was not treating macro-layer boundaries correctly.

GitHub Tracked Changes

• v0.6.8 by @jrenaud90 in #81

Full Changelog: v0.6.7...v0.6.8

TidalPy v0.6.7

Changes

• TidalPy.tides.modes.collapse_multilayer_modes now requires a tuple of rheology instances for both shear and bulk rheology. One for each macro layer. This allows different rheologies to be used for different layers.

Fixes

• Fixed some warnings that were showing up in the multilayer demo notebook.

GitHub Tracked Changes

• Ver0.6.7 by @jrenaud90 in #80

Full Changelog: v0.6.6...v0.6.7

TidalPy v0.6.6

Changes

• Updated to work with CyRK v0.15.1
  • This change results in about a 18% performance improvement for RadialSolver depending on the problem.
• Converted RadialSolver and EOSSolver status message to C++ strings.
• Updated some documentation.

Fixes

• Fixed potential issue where RadialSolver could use a very small or even negative maximum step size.

GitHub Tracked Changes

• Ver0.6.6 by @jrenaud90 in #79

Full Changelog: v0.6.5...v0.6.6

v0.6.5

Changes

New

• Added test to check if structure arrays have been changed.
• Added debug flag to installation files to help with cython debugging.

Fixes

• Fixed issue where TidalPy structures (layers, planets, etc.) would return editable arrays instead of copies of arrays. This could lead to subsequent functions (like planet paint) changing the arrays. This fixes GitHub Issue #74.
• Fixed issue where shooting method was corrupting data when starting radius was too large (which happened for higher orders of l) This fixes GitHub Issue #72.
• Fixed broken demo notebooks.

GitHub Tracked Changes

• Structures now return copys of arrays (fix for data modification bug)… by @jrenaud90 in #75
• fixed bug introduced in last PR by @jrenaud90 in #76
• Isolating issue by @jrenaud90 in #77
• Ver0.6.5 by @jrenaud90 in #78

Full Changelog: v0.6.4...v0.6.5

TidalPy v0.6.4

Changes

Dependencies:

• Removed max version limit for platformdirs package

GitHub Tracked Changes

Full Changelog: v0.6.3...v0.6.4

TidalPy v0.6.3

Changes

• Changes GitHub actions to avoid testing when not needed.
• Now supports Python 3.13

Fixes:

• Removed various files that were being included in the manifest

Dependencies:

• Updated to work with CyRK 0.13.3
• Updated to work with Numpy 2.x

GitHub Tracked Changes

• TidalPy v0.6.3 - Support for Python 3.13 and Numpy 2.x by @jrenaud90 in #71

Full Changelog: v0.6.2...v0.6.3