c4dynamics 2.3.2__tar.gz → 2.3.4__tar.gz

{c4dynamics-2.3.2/c4dynamics.egg-info → c4dynamics-2.3.4}/PKG-INFO

@@ -1,32 +1,54 @@
 Metadata-Version: 2.4
 Name: c4dynamics
-Version: 2.3.2
+Version: 2.3.4
 Summary: Python framework for state-space modeling and algorithm development
 Author: c4dynamics
 Author-email: Ziv Meri <zivmeri@gmail.com>
 License-Expression: MIT
-Keywords: python,state-space,dynamics,physics,algorithms,computer vision,navigation,guidance,slam,vslam,image processing,signal processing,control
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Intended Audience :: Developers
-Classifier: Programming Language :: Python :: 3
-Classifier: Operating System :: Unix
-Classifier: Operating System :: MacOS :: MacOS X
-Classifier: Operating System :: Microsoft :: Windows
 Requires-Python: >=3.8,<3.13
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: imageio>=2.37.0
 Requires-Dist: matplotlib>=3.9.2
-Requires-Dist: natsort>=8.3.1
 Requires-Dist: numpy>=1.26.0
-Requires-Dist: opencv-python>=4.11.0.86
 Requires-Dist: pooch>=1.8.0
 Requires-Dist: scipy>=1.13.0
+Provides-Extra: vision
+Requires-Dist: matplotlib>=3.9.2; extra == "vision"
+Requires-Dist: numpy>=1.26.0; extra == "vision"
+Requires-Dist: pooch>=1.8.0; extra == "vision"
+Requires-Dist: scipy>=1.13.0; extra == "vision"
+Requires-Dist: imageio>=2.37.0; extra == "vision"
+Requires-Dist: natsort>=8.3.1; extra == "vision"
+Requires-Dist: opencv-python>=4.11.0.86; extra == "vision"
 Provides-Extra: dev
+Requires-Dist: matplotlib>=3.9.2; extra == "dev"
+Requires-Dist: numpy>=1.26.0; extra == "dev"
+Requires-Dist: pooch>=1.8.0; extra == "dev"
+Requires-Dist: scipy>=1.13.0; extra == "dev"
+Requires-Dist: imageio>=2.37.0; extra == "dev"
+Requires-Dist: natsort>=8.3.1; extra == "dev"
+Requires-Dist: opencv-python>=4.11.0.86; extra == "dev"
+Requires-Dist: coverage>=7.0.0; extra == "dev"
 Requires-Dist: nbsphinx>=0.9.3; extra == "dev"
-Requires-Dist: Sphinx>=8.1.3; extra == "dev"
+Requires-Dist: sphinx>=8.1.3; extra == "dev"
 Requires-Dist: sphinx-book-theme>=1.1.4; extra == "dev"
 Requires-Dist: sphinx_design>=0.6.1; extra == "dev"
+Provides-Extra: keywords
+Requires-Dist: python; extra == "keywords"
+Requires-Dist: state-space; extra == "keywords"
+Requires-Dist: dynamics; extra == "keywords"
+Requires-Dist: physics; extra == "keywords"
+Requires-Dist: algorithms; extra == "keywords"
+Requires-Dist: control; extra == "keywords"
+Requires-Dist: navigation; extra == "keywords"
+Requires-Dist: guidance; extra == "keywords"
+Requires-Dist: slam; extra == "keywords"
+Requires-Dist: vslam; extra == "keywords"
+Requires-Dist: computer-vision; extra == "keywords"
+Requires-Dist: image-processing; extra == "keywords"
+Requires-Dist: signal-processing; extra == "keywords"
+Provides-Extra: dynamic
+Requires-Dist: classifiers; extra == "dynamic"
 Dynamic: author
 Dynamic: license-file
 Dynamic: requires-python
@@ -37,6 +59,27 @@ Dynamic: requires-python
 
 
 
+
+
+<div align="center">
+  <strong>📄 Published in the Journal of Open Source Software (JOSS)</strong><br>
+  <em>A peer-reviewed open-source framework for state-space modeling and algorithm development</em>
+  <br>
+  <a href="https://doi.org/10.5281/zenodo.17931207">
+    <img src="https://zenodo.org/badge/DOI/10.5281/zenodo.17931207.svg">
+  </a>
+  <br>
+  <a href="https://doi.org/10.21105/joss.08776">
+    <img src="https://joss.theoj.org/papers/10.21105/joss.08776/status.svg">
+  </a>
+</div>
+
+<br>
+
+
+
+
+
 # Tsipor Dynamics
 
 ## Algorithms Engineering and Development
@@ -57,9 +100,24 @@ Tsipor (bird) Dynamics (c4dynamics) is the Python framework for state-space mode
 ![Pepy Total Downloads](https://img.shields.io/pepy/dt/c4dynamics?style=for-the-badge&color=blue%20&link=https%3A%2F%2Fpepy.tech%2Fprojects%2Fc4dynamics%3FtimeRange%3DthreeMonths%26category%3Dversion%26includeCIDownloads%3Dtrue%26granularity%3Ddaily%26viewType%3Dline%26versions%3D2.0.3%252C2.0.1%252C2.0.0)
 
 
+## About c4dynamics
 
+**c4dynamics** is designed to 
+simplify the development of algorithms for dynamic systems, 
+using state space representations. 
+It offers engineers and researchers a systematic approach to model, 
+simulate, and control systems in fields like 
+``robotics, aerospace,`` and ``navigation``.
 
-[Documentation](https://c4dynamics.github.io/c4dynamics/)
+The framework introduces ``state objects,`` which are foundational 
+data structures that encapsulate state vectors and provide 
+the tools for managing data, simulating system behavior, 
+and analyzing results. 
+
+With integrated modules for sensors, 
+detectors, and filters, 
+c4dynamics accelerates algorithm development 
+while maintaining flexibility and scalability.
 
 
 ## Why c4dynamics?
@@ -78,24 +136,15 @@ Tsipor (bird) Dynamics (c4dynamics) is the Python framework for state-space mode
 
 
 
+## Documentation
 
-**c4dynamics** is designed to 
-simplify the development of algorithms for dynamic systems, 
-using state space representations. 
-It offers engineers and researchers a systematic approach to model, 
-simulate, and control systems in fields like 
-``robotics, aerospace,`` and ``navigation``.
-
-The framework introduces ``state objects,`` which are foundational 
-data structures that encapsulate state vectors and provide 
-the tools for managing data, simulating system behavior, 
-and analyzing results. 
-
-With integrated modules for sensors, 
-detectors, and filters, 
-c4dynamics accelerates algorithm development 
-while maintaining flexibility and scalability.
+📘 **Full documentation:**  
+https://c4dynamics.github.io/c4dynamics/
 
+- Installation and setup guides  
+- Core concepts and state-space modeling philosophy  
+- API reference and examples  
+- Tutorials for filtering, sensing, and simulation workflows
 
 
 ## Requirements 
@@ -124,24 +173,25 @@ To run the latest GitHub version, download the repo and install required package
 >>> pip install -r requirements.txt
 ```
 
- 
- 
- 
 
 ## Quickstart
 
 Import c4dynamics:
-```
+```python
 >>> import c4dynamics as c4d
 ```
 
 Define state space object of two variables in the state space (y, vy) with initial conditions (change the state with your variables): 
-```
+```python
 >>> s = c4d.state(y = 1, vy = 0.5)
 ``` 
+Store with time stamp `t = 0`:
+```python 
+>>> s.store(t = 0)
+``` 
 
 Multiply the state vector by a matrix and store:  
-```
+```python
 >>> F = [[1, 1],                      
          [0, 1]]              
 >>> s.X += F @ s.X                     
@@ -149,7 +199,7 @@ Multiply the state vector by a matrix and store:
 ```
 
 Print the state variables, the state vector, and the stored data:  
-```
+```python
 >>> print(s)  
 [ y  vy ]
 >>> s.X 

{c4dynamics-2.3.2 → c4dynamics-2.3.4}/README.md

@@ -4,6 +4,27 @@
 
 
 
+
+
+<div align="center">
+  <strong>📄 Published in the Journal of Open Source Software (JOSS)</strong><br>
+  <em>A peer-reviewed open-source framework for state-space modeling and algorithm development</em>
+  <br>
+  <a href="https://doi.org/10.5281/zenodo.17931207">
+    <img src="https://zenodo.org/badge/DOI/10.5281/zenodo.17931207.svg">
+  </a>
+  <br>
+  <a href="https://doi.org/10.21105/joss.08776">
+    <img src="https://joss.theoj.org/papers/10.21105/joss.08776/status.svg">
+  </a>
+</div>
+
+<br>
+
+
+
+
+
 # Tsipor Dynamics
 
 ## Algorithms Engineering and Development
@@ -24,9 +45,24 @@ Tsipor (bird) Dynamics (c4dynamics) is the Python framework for state-space mode
 ![Pepy Total Downloads](https://img.shields.io/pepy/dt/c4dynamics?style=for-the-badge&color=blue%20&link=https%3A%2F%2Fpepy.tech%2Fprojects%2Fc4dynamics%3FtimeRange%3DthreeMonths%26category%3Dversion%26includeCIDownloads%3Dtrue%26granularity%3Ddaily%26viewType%3Dline%26versions%3D2.0.3%252C2.0.1%252C2.0.0)
 
 
+## About c4dynamics
 
+**c4dynamics** is designed to 
+simplify the development of algorithms for dynamic systems, 
+using state space representations. 
+It offers engineers and researchers a systematic approach to model, 
+simulate, and control systems in fields like 
+``robotics, aerospace,`` and ``navigation``.
 
-[Documentation](https://c4dynamics.github.io/c4dynamics/)
+The framework introduces ``state objects,`` which are foundational 
+data structures that encapsulate state vectors and provide 
+the tools for managing data, simulating system behavior, 
+and analyzing results. 
+
+With integrated modules for sensors, 
+detectors, and filters, 
+c4dynamics accelerates algorithm development 
+while maintaining flexibility and scalability.
 
 
 ## Why c4dynamics?
@@ -45,24 +81,15 @@ Tsipor (bird) Dynamics (c4dynamics) is the Python framework for state-space mode
 
 
 
+## Documentation
 
-**c4dynamics** is designed to 
-simplify the development of algorithms for dynamic systems, 
-using state space representations. 
-It offers engineers and researchers a systematic approach to model, 
-simulate, and control systems in fields like 
-``robotics, aerospace,`` and ``navigation``.
-
-The framework introduces ``state objects,`` which are foundational 
-data structures that encapsulate state vectors and provide 
-the tools for managing data, simulating system behavior, 
-and analyzing results. 
-
-With integrated modules for sensors, 
-detectors, and filters, 
-c4dynamics accelerates algorithm development 
-while maintaining flexibility and scalability.
+📘 **Full documentation:**  
+https://c4dynamics.github.io/c4dynamics/
 
+- Installation and setup guides  
+- Core concepts and state-space modeling philosophy  
+- API reference and examples  
+- Tutorials for filtering, sensing, and simulation workflows
 
 
 ## Requirements 
@@ -91,24 +118,25 @@ To run the latest GitHub version, download the repo and install required package
 >>> pip install -r requirements.txt
 ```
 
- 
- 
- 
 
 ## Quickstart
 
 Import c4dynamics:
-```
+```python
 >>> import c4dynamics as c4d
 ```
 
 Define state space object of two variables in the state space (y, vy) with initial conditions (change the state with your variables): 
-```
+```python
 >>> s = c4d.state(y = 1, vy = 0.5)
 ``` 
+Store with time stamp `t = 0`:
+```python 
+>>> s.store(t = 0)
+``` 
 
 Multiply the state vector by a matrix and store:  
-```
+```python
 >>> F = [[1, 1],                      
          [0, 1]]              
 >>> s.X += F @ s.X                     
@@ -116,7 +144,7 @@ Multiply the state vector by a matrix and store:
 ```
 
 Print the state variables, the state vector, and the stored data:  
-```
+```python
 >>> print(s)  
 [ y  vy ]
 >>> s.X 

{c4dynamics-2.3.2 → c4dynamics-2.3.4}/c4dynamics/__init__.py

@@ -83,7 +83,7 @@ from . import envs
 #
 # version
 ##
-__version__ = '2.3.2' # update also in pyproject.toml & setup.py 
+__version__ = '2.3.4' # update also in pyproject.toml & setup.py 
 
 
 #

{c4dynamics-2.3.2 → c4dynamics-2.3.4}/c4dynamics/datasets/_manager.py

@@ -573,20 +573,26 @@ def sha256(filename: str) -> str:
 if __name__ == "__main__":
 
 
+  current_module = sys.modules[__name__]
 
   try:
     import open3d as o3d  # OPEN3D AVAILABLE
-
   except ImportError:     # OPEN3D UNAVAILABLE
     # remove the doctests for d3_model if open3d is not available
-    
-    current_module = sys.modules[__name__]
     if hasattr(current_module, "d3_model"):
       current_module.d3_model.__doc__ = ""   # clears doctest examples
 
+  try:
+    import cv2 
+  except ImportError:     
+    if hasattr(current_module, "video"):
+      current_module.video.__doc__ = ""   # clears doctest examples
+    if hasattr(current_module, "nn_model"):
+      current_module.nn_model.__doc__ = ""   # clears doctest examples
+
 
-  import doctest, contextlib
-  from c4dynamics import IgnoreOutputChecker, cprint
+  # import doctest, contextlib
+  # from c4dynamics import IgnoreOutputChecker, cprint
 
 
   # # Register the custom OutputChecker

{c4dynamics-2.3.2 → c4dynamics-2.3.4}/c4dynamics/detectors/yolo3_opencv.py

@@ -1,5 +1,10 @@
 import os, sys 
-import cv2
+# optional vision modules
+try:
+    import cv2
+except ImportError:
+    # vision modules are unavailable
+    pass
 
 import numpy as np
 sys.path.append('.')
@@ -657,8 +662,21 @@ class yolov3:
 
 if __name__ == "__main__":
 
-  from c4dynamics import rundoctests
-  rundoctests(sys.modules[__name__])
-
+		from c4dynamics import rundoctests
+		
+		# current_module = sys.modules[__name__].yolov3
+		current_module = sys.modules[__name__]
+
+		try:
+			import cv2 
+		except ImportError:     
+			# if hasattr(current_module, "yolov3"):
+			current_module.yolov3.__doc__ = ""   # clears doctest examples
+			current_module.yolov3.detect.__doc__ = ""   # clears doctest examples
+			current_module.yolov3.confidence_th.__doc__ = ""   # clears doctest examples
+			current_module.yolov3.nms_th.__doc__ = ""   # clears doctest examples
+		
+		rundoctests(sys.modules[__name__])
+