pynamicalsys 1.3.1__py3-none-any.whl → 1.4.0__py3-none-any.whl

{pynamicalsys-1.3.1.dist-info → pynamicalsys-1.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pynamicalsys
-Version: 1.3.1
+Version: 1.4.0
 Summary: A Python toolkit for the analysis of dynamical systems
 Author-email: Matheus Rolim Sales <rolim.sales.m@gmail.com>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -690,6 +690,7 @@ Requires-Dist: numpy>=1.21
 Requires-Dist: matplotlib>=3.4
 Requires-Dist: numba>=0.55
 Requires-Dist: scipy>=0.6
+Requires-Dist: scikit-learn>=0.14
 
 # pynamicalsys: A Python toolkit for the analysis of dynamical systems
 
@@ -701,6 +702,8 @@ Requires-Dist: scipy>=0.6
 
 **pynamicalsys** is designed to provide a fast, flexible, and user-friendly environment for analyzing **nonlinear dynamical systems**. It is intended for students, researchers, educators, and enthusiasts who want to explore the world of chaos and dynamical systems. Beyond standard tools like trajectory generation and Lyapunov exponents calculation, **pynamicalsys** includes advanced features such as
 
+- **Bifurcation diagrams**, **Poincaré sections**, and **stroboscopic maps** for analyzing system trajectories.
+- **Symplectic integrators** for analyzing Hamiltonian systems.
 - **Linear dependence index** for chaos detection.
 - **Recurrence plots** and recurrence time statistics.
 - Chaos indicators based on **weighted Birkhoff averages**.
@@ -723,7 +726,7 @@ Requires-Dist: scipy>=0.6
 To install the latest stable release, run in your command line:
 
 ```bash
-$ pip install pynamicalsys
+pip install pynamicalsys
 ```
 
 > **Note:** On **Windows**, it is **strongly recommended** to use [Anaconda](https://www.anaconda.com). It simplifies dependency management and avoids potential issues with scientific libraries during installation. Be sure to run the command from the **Anaconda Prompt**, not from Command Prompt or PowerShell, to ensure the correct environment is activated.
@@ -733,7 +736,7 @@ $ pip install pynamicalsys
 To upgrade your current version of **pynamicalsys** to the latest stable release, run in your command line:
 
 ```bash
-$ pip install pynamicalsys --upgrade
+pip install pynamicalsys --upgrade
 ```
 
 ### Install from source
@@ -741,9 +744,9 @@ $ pip install pynamicalsys --upgrade
 If you want to install the development version from the source repository, clone the repo and install with:
 
 ```bash
-$ git clone https://github.com/mrolims/pynamicalsys.git
-$ cd pynamicalsys
-$ pip install .
+git clone https://github.com/mrolims/pynamicalsys.git
+cd pynamicalsys
+pip install .
 ```
 
 ### Verifying the installation
@@ -760,12 +763,26 @@ After installation, you can verify it by running Python and importing the packag
 If you encounter any issues, make sure you have the latest version of pip:
 
 ```bash
-$ pip install --upgrade pip build
+pip install --upgrade pip build
 ```
 
+## Documentation
+
+For detailed instructions, examples, and API references, please visit the full documentation page:
+
+[pynamicalsys.readthedocs.io](https://pynamicalsys.readthedocs.io/)
+
+The documentation includes:
+
+- **Getting Started** — installation and quick-start examples.  
+- **Tutorial** — step-by-step explanations of key concepts and pratical demonstrations.
+- **API Reference** — detailed descriptions of all functions, parameters, and return values.
+
 ## Citation
 
-Currently, our research paper is under review, but in the mean time, if you use **pynamicalsys** in your work, you can cite the [arXiv](https://arxiv.org/abs/2506.14044) version:
+Our research paper is currently under review. In the meantime, if you use **pynamicalsys** in your work, please cite the [arXiv version](https://arxiv.org/abs/2506.14044). Below are recommended citation formats for different use cases.
+
+### BibTeX
 
 ```bibtex
 @misc{pynamicalsys,
@@ -779,6 +796,18 @@ Currently, our research paper is under review, but in the mean time, if you use
 }
 ```
 
+### APA style
+
+```
+Rolim Sales, M., Costa de Souza, L., Borin, D., Mugnaine, M., Szezech Jr., J. D., Viana, R. L., Caldas, I. L., Leonel, E. D., & Antonopoulos, C. G. (2025). pynamicalsys: A Python toolkit for the analysis of dynamical systems. arXiv:2506.14044. https://arxiv.org/abs/2506.14044
+```
+
+### Short citation style
+
+```
+Matheus Rolim Sales et al., "pynamicalsys: A Python toolkit for the analysis of dynamical systems," arXiv:2506.14044, 2025. https://arxiv.org/abs/2506.14044
+```
+
 ## Contributing
 
 We welcome contributions from the community! To get started, please see our [Contributing Guidelines](https://pynamicalsys.readthedocs.io/en/latest/contributing.html).

pynamicalsys-1.4.0.dist-info/RECORD

@@ -0,0 +1,36 @@
+pynamicalsys/__init__.py,sha256=ioId1lT3XdGTyBeYOFAX8XzppO0tH2HXlshZudYZ6wY,1308
+pynamicalsys/__version__.py,sha256=qX8_mGjWClM0QeMyVAByaVXEA4Pk87fxkFSMEQx9-KM,704
+pynamicalsys/common/__init__.py,sha256=W4OESm7TA-EUTGUOtIgBgvSd1n80Mgl0KA2dCkw8yIw,721
+pynamicalsys/common/basin_analysis.py,sha256=teGEOMPPOdzKNZsN0_OvkzBlcV-UOANRjcdFyI2-FLM,5473
+pynamicalsys/common/recurrence_quantification_analysis.py,sha256=WQDFwM1aCJJuaATTVNsHzCXode53lzG_PqPoHmBcprs,14344
+pynamicalsys/common/time_series_metrics.py,sha256=A5vJV21knNe3ZSeJWBRMly8Wgx0IRGWVE7yMRPAjbZM,2708
+pynamicalsys/common/utils.py,sha256=KexTurkehh_O7TR38iiBEnUVAAvqGRpwbxVKsqLDA4A,10268
+pynamicalsys/continuous_time/__init__.py,sha256=W4OESm7TA-EUTGUOtIgBgvSd1n80Mgl0KA2dCkw8yIw,721
+pynamicalsys/continuous_time/chaotic_indicators.py,sha256=Srsk8F1jYFcPYUF-QWtH2tEN96T_TORBYVsvbAa61YU,19678
+pynamicalsys/continuous_time/models.py,sha256=doObl0Sd5AwdRKtT-ibvXMa2RJUmQf_Ralt201RcA9s,5879
+pynamicalsys/continuous_time/numerical_integrators.py,sha256=loIzJenp04ZWiukCK3oCs8vn9BeEcxckDO58B7QRKTo,9600
+pynamicalsys/continuous_time/trajectory_analysis.py,sha256=uwWFLMkfDmL-ZSgEfk-5UHMfuCWMQLLXsNhfRS33BjE,17448
+pynamicalsys/continuous_time/validators.py,sha256=dvtlcWbn2w5_vNUB68f7ywFPyFrPKe3cUDqGCk52mhw,3834
+pynamicalsys/core/__init__.py,sha256=W4OESm7TA-EUTGUOtIgBgvSd1n80Mgl0KA2dCkw8yIw,721
+pynamicalsys/core/basin_metrics.py,sha256=sqSj-UCzBQdRaTvOBtzo8SCgJN90T3GiWy4nlLsbg5c,7604
+pynamicalsys/core/continuous_dynamical_systems.py,sha256=fqcHUgW43cFW-fDm3XWvsdbn0z1DQW2OMq_1zrWmd0A,75107
+pynamicalsys/core/discrete_dynamical_systems.py,sha256=zNTuLkdN28U7iqRkNoYf5QLgre3n8TNGqZz7WxrKOpI,146129
+pynamicalsys/core/hamiltonian_systems.py,sha256=0KT7tg__TwCR6HGDy062U8MZL823eCopwuwj1kUmie4,40668
+pynamicalsys/core/plot_styler.py,sha256=sVX_rb1HSt340U3zyPlXojylhma9cKCOgYirMIge18M,5647
+pynamicalsys/core/time_series_metrics.py,sha256=_-5iyAR7YBMbcnk9kKkwyyE0D9MiIQ1TizH2JAkt_bQ,7613
+pynamicalsys/discrete_time/__init__.py,sha256=W4OESm7TA-EUTGUOtIgBgvSd1n80Mgl0KA2dCkw8yIw,721
+pynamicalsys/discrete_time/dynamical_indicators.py,sha256=2AgAoOfShVxF5B4d4ZNh3XtIcDenpk19GhD0F_82crQ,48548
+pynamicalsys/discrete_time/models.py,sha256=8mw7jrjMLDxKF7qtRyOAIf6zRu7koX43epdzSbqwi1o,10732
+pynamicalsys/discrete_time/trajectory_analysis.py,sha256=z9obMDO62pvUQI1xVikAVo5m6BiyMu7Rmvt3uhKiuYg,48549
+pynamicalsys/discrete_time/transport.py,sha256=CyRiF5ZNLQVUgHbFANH9wIGJuMTOyPRg9Q67_3C8zFM,14417
+pynamicalsys/discrete_time/validators.py,sha256=sk5PuQ6vxNj6ReqIfBTb2iQqlgY0SUkndS56xcp3w_w,10013
+pynamicalsys/hamiltonian_systems/__init__.py,sha256=W4OESm7TA-EUTGUOtIgBgvSd1n80Mgl0KA2dCkw8yIw,721
+pynamicalsys/hamiltonian_systems/chaotic_indicators.py,sha256=MfYbf2iBYk5PRAuBJVp38o2fWs0Fxnb78DExtWoI4Zo,18839
+pynamicalsys/hamiltonian_systems/models.py,sha256=l0QWdaQ9xEWNcMXDDl8FiEcqYXQ5E0zbRQPPqfDDrG4,2181
+pynamicalsys/hamiltonian_systems/numerical_integrators.py,sha256=9T_BLJ8BXIydQ_YuqWO04O6jCuRI9koe1Y7_BcioP-I,8725
+pynamicalsys/hamiltonian_systems/trajectory_analysis.py,sha256=ZSZ9Y0mZOZscWLlAvup-8kSw6054bUj4ohJ1M45VxEg,10179
+pynamicalsys/hamiltonian_systems/validators.py,sha256=qj4lV4E5wte4PHhXPAWuXG71THCCvuv-x_b_N8LTxSM,3832
+pynamicalsys-1.4.0.dist-info/METADATA,sha256=fm3KhDszb0-Gyif3jECFkV-X8fBa44wU-lmBTjjY7F0,47127
+pynamicalsys-1.4.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pynamicalsys-1.4.0.dist-info/top_level.txt,sha256=1AqoHXye_hGRkvqu4KY0SdEuNTgqf3xyTlV8xhiJJFU,13
+pynamicalsys-1.4.0.dist-info/RECORD,,

pynamicalsys-1.3.1.dist-info/RECORD

@@ -1,28 +0,0 @@
-pynamicalsys/__init__.py,sha256=IBHDcCD7wX8pULFXLk0yvF3uuNodvDKGirJektm1nR4,1215
-pynamicalsys/__version__.py,sha256=-4u7pjQ4caDQqa-1Qgms81j5hpkXjmjUYRCVEaLmb88,704
-pynamicalsys/common/__init__.py,sha256=W4OESm7TA-EUTGUOtIgBgvSd1n80Mgl0KA2dCkw8yIw,721
-pynamicalsys/common/basin_analysis.py,sha256=teGEOMPPOdzKNZsN0_OvkzBlcV-UOANRjcdFyI2-FLM,5473
-pynamicalsys/common/recurrence_quantification_analysis.py,sha256=WQDFwM1aCJJuaATTVNsHzCXode53lzG_PqPoHmBcprs,14344
-pynamicalsys/common/utils.py,sha256=KexTurkehh_O7TR38iiBEnUVAAvqGRpwbxVKsqLDA4A,10268
-pynamicalsys/continuous_time/__init__.py,sha256=W4OESm7TA-EUTGUOtIgBgvSd1n80Mgl0KA2dCkw8yIw,721
-pynamicalsys/continuous_time/chaotic_indicators.py,sha256=kwoI259MoGntEBO7-LBnb-SG6JuTq0Ixgz8lxXNl-tk,12506
-pynamicalsys/continuous_time/models.py,sha256=YJtmsVZqSn3GDNqV0IKSQBHWZSCDY_EJ5Sgh4ulDc9I,5339
-pynamicalsys/continuous_time/numerical_integrators.py,sha256=loIzJenp04ZWiukCK3oCs8vn9BeEcxckDO58B7QRKTo,9600
-pynamicalsys/continuous_time/trajectory_analysis.py,sha256=GwAMFuvH0kLqCaROXSFoXmj1PYauwwB3h5M_gR17FLY,5220
-pynamicalsys/continuous_time/validators.py,sha256=dvtlcWbn2w5_vNUB68f7ywFPyFrPKe3cUDqGCk52mhw,3834
-pynamicalsys/core/__init__.py,sha256=W4OESm7TA-EUTGUOtIgBgvSd1n80Mgl0KA2dCkw8yIw,721
-pynamicalsys/core/basin_metrics.py,sha256=sqSj-UCzBQdRaTvOBtzo8SCgJN90T3GiWy4nlLsbg5c,7604
-pynamicalsys/core/continuous_dynamical_systems.py,sha256=uunVcArRk5JEG0Z1G8KqlmYDxVzPokoeqNSXzXvUZN8,37989
-pynamicalsys/core/discrete_dynamical_systems.py,sha256=JcDL71M3kaQJLnkWOVTG28ylolNmitMg1tlpq3EryQA,145975
-pynamicalsys/core/plot_styler.py,sha256=sVX_rb1HSt340U3zyPlXojylhma9cKCOgYirMIge18M,5647
-pynamicalsys/core/time_series_metrics.py,sha256=7fwXO1I6lIjmv_MzYxBn-9k2gjjnhm_y_Tp3diE1z68,5102
-pynamicalsys/discrete_time/__init__.py,sha256=W4OESm7TA-EUTGUOtIgBgvSd1n80Mgl0KA2dCkw8yIw,721
-pynamicalsys/discrete_time/dynamical_indicators.py,sha256=2Dz-ubootvvey2Hx9g3bGDSVUty3kVSXWvosAlwysHU,51651
-pynamicalsys/discrete_time/models.py,sha256=8mw7jrjMLDxKF7qtRyOAIf6zRu7koX43epdzSbqwi1o,10732
-pynamicalsys/discrete_time/trajectory_analysis.py,sha256=z9obMDO62pvUQI1xVikAVo5m6BiyMu7Rmvt3uhKiuYg,48549
-pynamicalsys/discrete_time/transport.py,sha256=CyRiF5ZNLQVUgHbFANH9wIGJuMTOyPRg9Q67_3C8zFM,14417
-pynamicalsys/discrete_time/validators.py,sha256=sk5PuQ6vxNj6ReqIfBTb2iQqlgY0SUkndS56xcp3w_w,10013
-pynamicalsys-1.3.1.dist-info/METADATA,sha256=yTQx9DYbgYQygq4dfqDmUmdIETMXrha58TswTb8_A-w,45897
-pynamicalsys-1.3.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-pynamicalsys-1.3.1.dist-info/top_level.txt,sha256=1AqoHXye_hGRkvqu4KY0SdEuNTgqf3xyTlV8xhiJJFU,13
-pynamicalsys-1.3.1.dist-info/RECORD,,