TidalPy 0.6.5__tar.gz → 0.6.7__tar.gz

{tidalpy-0.6.5/TidalPy.egg-info → tidalpy-0.6.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: TidalPy
-Version: 0.6.5
+Version: 0.6.7
 Summary: Tidal Dynamics and Thermal-Orbital Evolution Software Suite Implemented in Cython and Python
 Author-email: "Joe P. Renaud" <TidalPy@gmail.com>
 License-Expression: CC-BY-NC-SA-4.0
@@ -37,7 +37,7 @@ Requires-Dist: toml>=0.10.2
 Requires-Dist: dill>=0.3.2
 Requires-Dist: psutil>=5.8.0
 Requires-Dist: pathos>=0.2.0
-Requires-Dist: cyrk<0.14.0,>=0.13.5
+Requires-Dist: cyrk<0.16.0,>=0.15.1
 Requires-Dist: astropy
 Requires-Dist: astroquery
 Requires-Dist: ipympl<0.10.0,>=0.9.6
@@ -81,7 +81,7 @@ Dynamic: license-file
 
 ---
 
-<a href="https://github.com/jrenaud90/TidalPy/releases"><img src="https://img.shields.io/badge/TidalPy-0.6.4 Alpha-orange" alt="TidalPy Version 0.6.5 Alpha" /></a>
+<a href="https://github.com/jrenaud90/TidalPy/releases"><img src="https://img.shields.io/badge/TidalPy-0.6.7 Alpha-orange" alt="TidalPy Version 0.6.7 Alpha" /></a>
 
 **Tidal Dynamics and Thermal-Orbital Evolution Software Suite Implemented in Cython and Python**
 
@@ -105,7 +105,7 @@ Have any questions? Feel free to leave an [issue](https://github.com/jrenaud90/T
 
 ## Basic Installation
 
-Installing TidalPy is ass simple as ensuring 64-bit [Python 3.9+](https://www.python.org/) is installed on your 
+Installing TidalPy is as simple as ensuring 64-bit [Python 3.9+](https://www.python.org/) is installed on your 
 system and performing the following in a terminal:
 
 `pip install TidalPy`
@@ -141,10 +141,12 @@ TidalPy offers the ability to make nice 2D plots using the [cartopy](https://sci
 3d projection map plotting. In turn, cartopy relies on [GEOS](https://trac.osgeo.org/geos/) which is not a python
 package and must be installed outside of pip.
 
-The easiest way to install cartopy is using an Anaconda environment by,
+### Installing Cartopy using `conda`
+The easiest way to install cartopy is using a conda environment by,
 
 `conda install -c conda-forge cartopy`
 
+### Installing Cartopy using `pip`
 If you are not using a conda environment then you will need to find and install the GEOS binaries manually:
 
 **Windows:** [Follow instructions here](https://trac.osgeo.org/osgeo4w/)
@@ -162,8 +164,8 @@ _If you ran into a problem that is not listed below please [submit an issue](htt
 **Known Problems:**
 * The `setuptools` package is required before TidalPy can be installed. Usually it is automatically installed, but if
   you are starting with a clean virtual environment it may not have been.
-  * For Anaconda: `conda install setuptools`
-  * Or for regular Python: `pip install setuptools`
+  * For conda: `conda install setuptools`
+  * Or pip: `pip install setuptools`
 
 # How to Use TidalPy
 
@@ -224,7 +226,7 @@ letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
 
 # Acknowledgements
 TidalPy was partially developed with support from NASA Goddard Space Flight Center's 
-Sellers Exoplanet Environments Collaboration (SEEC) and Geodesy ISFM. 
+Sellers Exoplanet Environments Collaboration (SEEC) and Geodesy ISFMs. 
 TidalPy is partially based upon work supported by NASA under award number 80GSFC21M0002 and the
 Center for Research and Exploration in Space Science & Technology II (CRESST II) administered at the University of
 Maryland, College Park.

{tidalpy-0.6.5 → tidalpy-0.6.7}/README.md

@@ -11,7 +11,7 @@
 
 ---
 
-<a href="https://github.com/jrenaud90/TidalPy/releases"><img src="https://img.shields.io/badge/TidalPy-0.6.4 Alpha-orange" alt="TidalPy Version 0.6.5 Alpha" /></a>
+<a href="https://github.com/jrenaud90/TidalPy/releases"><img src="https://img.shields.io/badge/TidalPy-0.6.7 Alpha-orange" alt="TidalPy Version 0.6.7 Alpha" /></a>
 
 **Tidal Dynamics and Thermal-Orbital Evolution Software Suite Implemented in Cython and Python**
 
@@ -35,7 +35,7 @@ Have any questions? Feel free to leave an [issue](https://github.com/jrenaud90/T
 
 ## Basic Installation
 
-Installing TidalPy is ass simple as ensuring 64-bit [Python 3.9+](https://www.python.org/) is installed on your 
+Installing TidalPy is as simple as ensuring 64-bit [Python 3.9+](https://www.python.org/) is installed on your 
 system and performing the following in a terminal:
 
 `pip install TidalPy`
@@ -71,10 +71,12 @@ TidalPy offers the ability to make nice 2D plots using the [cartopy](https://sci
 3d projection map plotting. In turn, cartopy relies on [GEOS](https://trac.osgeo.org/geos/) which is not a python
 package and must be installed outside of pip.
 
-The easiest way to install cartopy is using an Anaconda environment by,
+### Installing Cartopy using `conda`
+The easiest way to install cartopy is using a conda environment by,
 
 `conda install -c conda-forge cartopy`
 
+### Installing Cartopy using `pip`
 If you are not using a conda environment then you will need to find and install the GEOS binaries manually:
 
 **Windows:** [Follow instructions here](https://trac.osgeo.org/osgeo4w/)
@@ -92,8 +94,8 @@ _If you ran into a problem that is not listed below please [submit an issue](htt
 **Known Problems:**
 * The `setuptools` package is required before TidalPy can be installed. Usually it is automatically installed, but if
   you are starting with a clean virtual environment it may not have been.
-  * For Anaconda: `conda install setuptools`
-  * Or for regular Python: `pip install setuptools`
+  * For conda: `conda install setuptools`
+  * Or pip: `pip install setuptools`
 
 # How to Use TidalPy
 
@@ -154,7 +156,7 @@ letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
 
 # Acknowledgements
 TidalPy was partially developed with support from NASA Goddard Space Flight Center's 
-Sellers Exoplanet Environments Collaboration (SEEC) and Geodesy ISFM. 
+Sellers Exoplanet Environments Collaboration (SEEC) and Geodesy ISFMs. 
 TidalPy is partially based upon work supported by NASA under award number 80GSFC21M0002 and the
 Center for Research and Exploration in Space Science & Technology II (CRESST II) administered at the University of
 Maryland, College Park.

{tidalpy-0.6.5 → tidalpy-0.6.7}/Tests/Test_Old/Test_SetY_MultiLayer/Test_Numerical_Int/test_m1_multilayer_modes.py

@@ -7,7 +7,7 @@ import TidalPy
 
 
 from TidalPy.constants import G, mass_trap1
-from TidalPy.rheology import Maxwell, Elastic
+from TidalPy.rheology import Maxwell, Elastic, Newton
 from TidalPy.tides.modes.multilayer_modes import collapse_multilayer_modes
 from TidalPy.utilities.conversions import orbital_motion2semi_a
 from TidalPy.utilities.spherical_helper.volume import calculate_voxel_volumes
@@ -68,8 +68,8 @@ input_kwargs = {
     'shear_array'                : shear_array,
     'bulk_viscosity_array'       : bulk_viscosity_array,
     'shear_viscosity_array'      : shear_viscosity_array,
-    'bulk_rheology_inst'         : bulk_rheology_inst,
-    'shear_rheology_inst'        : shear_rheology_inst,
+    'bulk_rheology_inst_bylayer' : tuple([bulk_rheology_inst]),
+    'shear_rheology_inst_bylayer': tuple([shear_rheology_inst]),
     'upper_radius_bylayer_array' : np.asarray((R,), dtype=np.float64),
     'density_array'              : density_array,
     'longitude_matrix'           : longitude_matrix,
@@ -548,6 +548,8 @@ def test_collapse_multilayer_modes_liquid_solid():
     input_kwargs_to_use['layer_types'] = ('liquid', 'solid')
     input_kwargs_to_use['is_static_bylayer'] = (True, False)
     input_kwargs_to_use['is_incompressible_bylayer'] = (True, False)
+    input_kwargs_to_use['bulk_rheology_inst_bylayer'] = (Elastic(), Elastic())
+    input_kwargs_to_use['shear_rheology_inst_bylayer'] = (Newton(), Maxwell())
     input_kwargs_to_use['upper_radius_bylayer_array'] = np.asarray((r_core, planet_R), dtype=np.float64)
 
     radius_array_to_use = np.concatenate((

{tidalpy-0.6.5 → tidalpy-0.6.7}/Tests/Test_RadialSolver/test_d_alma_compare.py

@@ -182,7 +182,6 @@ def test_radial_solver_alma_compare(degree_l, use_prop_matrix):
         perform_checks=True
     )
     solution = radial_solver(*inputs, **kwarg_inputs)
-
     if not solution.success:
         raise AssertionError(solution.message)
 
@@ -206,3 +205,6 @@ def test_radial_solver_alma_compare(degree_l, use_prop_matrix):
             raise AssertionError(f'Failed at degree={degree_l} for Im[{name}]:: {imag_pctdiff} (TidalPy = {tpy_imag}; ALMA = {alma_imag}).')
 
     del solution
+
+if __name__ == "__main__":
+    test_radial_solver_alma_compare(3, False)

{tidalpy-0.6.5 → tidalpy-0.6.7}/TidalPy/Material/eos/eos_solution.pxd

@@ -1,6 +1,7 @@
 from libcpp cimport bool as cpp_bool
 from libcpp.vector cimport vector
-from libcpp.memory cimport shared_ptr
+from libcpp.memory cimport unique_ptr
+from libcpp.string cimport string as cpp_string
 
 cimport numpy as cnp
 cnp.import_array()
@@ -28,7 +29,7 @@ cdef extern from "eos_solution_.cpp" nogil:
             cpp_bool radius_array_set
             cpp_bool other_vecs_set
 
-            char* message_ptr
+            cpp_string message
 
             size_t current_layers_saved
             size_t num_layers
@@ -51,7 +52,7 @@ cdef extern from "eos_solution_.cpp" nogil:
             double redim_pascal_scale
 
             vector[double] upper_radius_bylayer_vec
-            vector[shared_ptr[CySolverResult]] cysolver_results_sptr_bylayer_vec
+            vector[unique_ptr[CySolverResult]] cysolver_results_uptr_bylayer_vec
             vector[size_t] steps_taken_vec
 
             vector[double] radius_array_vec
@@ -73,10 +74,8 @@ cdef extern from "eos_solution_.cpp" nogil:
                     size_t radius_array_size
                 )
             
-            void save_cyresult(
-                shared_ptr[CySolverResult] new_cysolver_result_sptr)
-            void save_steps_taken(
-                size_t steps_taken)
+            void save_cyresult(unique_ptr[CySolverResult] new_cysolver_result_uptr)
+            void save_steps_taken(size_t steps_taken)
             
             void call(
                 const size_t layer_index,

{tidalpy-0.6.5 → tidalpy-0.6.7}/TidalPy/Material/eos/eos_solution_.cpp

@@ -1,7 +1,7 @@
-#include "eos_solution_.hpp"
 #include <exception>
 #include <cmath>
 
+#include "eos_solution_.hpp"
 
 bool isclose(double a, double b)
 {
@@ -46,7 +46,7 @@ EOSSolutionCC::EOSSolutionCC(
             current_layers_saved(0),
             num_layers(num_layers)
 {
-    this->cysolver_results_sptr_bylayer_vec.reserve(num_layers);
+    this->cysolver_results_uptr_bylayer_vec.reserve(num_layers);
     this->upper_radius_bylayer_vec.resize(num_layers);
 
     // Store the upper radius of each layer to make it easier to call interpolators later
@@ -59,14 +59,14 @@ EOSSolutionCC::EOSSolutionCC(
 EOSSolutionCC::~EOSSolutionCC( )
 {
     // Reset each shared pointer in the cysolver vector
-    for (size_t i = 0; i < this->cysolver_results_sptr_bylayer_vec.size(); i++)
+    for (size_t i = 0; i < this->cysolver_results_uptr_bylayer_vec.size(); i++)
     {
-        this->cysolver_results_sptr_bylayer_vec[i]->dense_vec.clear();
+        this->cysolver_results_uptr_bylayer_vec[i]->dense_vec.clear();
         // Reset this class reference to the shared pointer.
-        this->cysolver_results_sptr_bylayer_vec[i].reset();
+        this->cysolver_results_uptr_bylayer_vec[i].reset();
     }
     // Clear all vectors
-    this->cysolver_results_sptr_bylayer_vec.clear();
+    this->cysolver_results_uptr_bylayer_vec.clear();
     this->upper_radius_bylayer_vec.clear();
     this->radius_array_vec.clear();
     this->gravity_array_vec.clear();
@@ -78,11 +78,11 @@ EOSSolutionCC::~EOSSolutionCC( )
     this->complex_bulk_array_vec.clear();
 }
 
-void EOSSolutionCC::save_cyresult(std::shared_ptr<CySolverResult> new_cysolver_result_sptr)
+void EOSSolutionCC::save_cyresult(std::unique_ptr<CySolverResult> new_cysolver_result_uptr)
 {
     // We will save a copy of the shared pointer to ensure that the underlying object does not get deconstructed as long
     // as this object is alive. We will also save the raw pointer for ease of access and performance. 
-    this->cysolver_results_sptr_bylayer_vec.push_back(new_cysolver_result_sptr);
+    this->cysolver_results_uptr_bylayer_vec.push_back(std::move(new_cysolver_result_uptr));
     this->current_layers_saved++;
 }
 
@@ -99,7 +99,7 @@ void EOSSolutionCC::call(
 {
     if (layer_index < this->current_layers_saved) [[likely]]
     {
-        this->cysolver_results_sptr_bylayer_vec[layer_index]->call(radius, y_interp_ptr);
+        this->cysolver_results_uptr_bylayer_vec[layer_index]->call(radius, y_interp_ptr);
 
         if (this->nondim_status == 1)
         {
@@ -178,12 +178,12 @@ void EOSSolutionCC::change_radius_array(
         this->density_array_vec.clear();
         this->complex_shear_array_vec.clear();
         this->complex_bulk_array_vec.clear();
-        for (size_t i = 0; i < this->cysolver_results_sptr_bylayer_vec.size(); i++)
+        for (size_t i = 0; i < this->cysolver_results_uptr_bylayer_vec.size(); i++)
         {
-            this->cysolver_results_sptr_bylayer_vec[i]->dense_vec.clear();
-            this->cysolver_results_sptr_bylayer_vec[i].reset();
+            this->cysolver_results_uptr_bylayer_vec[i]->dense_vec.clear();
+            this->cysolver_results_uptr_bylayer_vec[i].reset();
         }
-        this->cysolver_results_sptr_bylayer_vec.clear();
+        this->cysolver_results_uptr_bylayer_vec.clear();
         this->current_layers_saved = 0;
 
         // Indicate that all vectors are cleared.
@@ -268,7 +268,7 @@ void EOSSolutionCC::interpolate_full_planet()
         }
 
         // Call interpolate using temp array as holder.
-        this->cysolver_results_sptr_bylayer_vec[current_layer_index]->call(radius, y_interp_ptr);
+        this->cysolver_results_uptr_bylayer_vec[current_layer_index]->call(radius, y_interp_ptr);
         
         // Store results
         this->gravity_array_vec.push_back(y_interp_ptr[0]);

{tidalpy-0.6.5 → tidalpy-0.6.7}/TidalPy/Material/eos/eos_solution_.hpp

@@ -4,6 +4,7 @@
 #include <cstring>
 #include <vector>
 #include <memory>
+#include <string>
 
 #include "cysolution.hpp"  // Part of the CyRK python package. Header should be included in setup using CyRK.get_include()
 
@@ -29,7 +30,6 @@ class EOSSolutionCC
 
 // Attributes
 protected:
-    char message[256] = { };
 
 public:
     int iterations             = -1;
@@ -41,7 +41,7 @@ public:
     bool radius_array_set = false;
     bool other_vecs_set   = false;
 
-    char* message_ptr           = &message[0];
+    std::string message         = "No Message Set.";
     size_t current_layers_saved = 0;
     size_t num_layers           = 0;
     size_t radius_array_size    = 0;
@@ -64,7 +64,7 @@ public:
     
     // Store results from CyRK's cysolve_ivp.
     std::vector<double> upper_radius_bylayer_vec = std::vector<double>();
-    std::vector<std::shared_ptr<CySolverResult>> cysolver_results_sptr_bylayer_vec = std::vector<std::shared_ptr<CySolverResult>>();
+    std::vector<std::unique_ptr<CySolverResult>> cysolver_results_uptr_bylayer_vec = std::vector<std::unique_ptr<CySolverResult>>();
     std::vector<size_t> steps_taken_vec = std::vector<size_t>();
 
     // Copy of user-provided radius array
@@ -101,7 +101,7 @@ public:
         size_t new_radius_size);
 
     // Save result of cysolve_ivp integration
-    void save_cyresult(std::shared_ptr<CySolverResult> new_cysolver_result_sptr);
+    void save_cyresult(std::unique_ptr<CySolverResult> new_cysolver_result_uptr);
     void save_steps_taken(size_t steps_taken);
     
     // Call a specific layer's interpolate function.

{tidalpy-0.6.5 → tidalpy-0.6.7}/TidalPy/Material/eos/solver.pxd

@@ -1,15 +1,12 @@
 from libcpp.vector cimport vector
-from libcpp.memory cimport shared_ptr, unique_ptr
+from libcpp.memory cimport unique_ptr
 from libcpp cimport bool as cpp_bool
 
-from CyRK cimport PreEvalFunc, CySolveOutput
+from CyRK cimport PreEvalFunc, CySolveOutput, ODEMethod
 
 from TidalPy.Material.eos.ode cimport EOS_ODEInput
 from TidalPy.Material.eos.eos_solution cimport EOSSolutionCC, EOS_DY_VALUES
 
-ctypedef vector[CySolveOutput] CySolverResult_sptr_vec
-ctypedef shared_ptr[CySolverResult_sptr_vec] CySolverResult_sptr_vec_sptr
-
 cdef void solve_eos(
     EOSSolutionCC* eos_solution_ptr,
     vector[PreEvalFunc] eos_function_bylayer_ptr_vec,
@@ -17,10 +14,10 @@ cdef void solve_eos(
     double planet_bulk_density,
     double surface_pressure = *,
     double G_to_use = *,
-    unsigned int integration_method = *,
+    ODEMethod integration_method = *,
     double rtol = *,
     double atol = *,
     double pressure_tol = *,
-    unsigned int max_iters = *,
+    size_t max_iters = *,
     cpp_bool verbose = *
     ) noexcept nogil