Merge pull request #117 from C4dynamics/dev

Dev

Author: C4dynamics

CLASSIFIERS.txt

@@ -0,0 +1,6 @@
+Development Status :: 5 - Production/Stable
+Intended Audience :: Developers
+Programming Language :: Python :: 3
+Operating System :: Unix
+Operating System :: MacOS :: MacOS X
+Operating System :: Microsoft :: Windows

c4dynamics/__init__.py

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

paper/paper.md

@@ -70,10 +70,10 @@ $$ \dot{\theta} = q $$
 $$ \dot{q} = \frac{g}{L}\sin\theta $$
 
 [Figure 1](#fig-pendulum) shows a schematic of the simple pendulum, and the system parameters are listed below:  
-- Rod length: $L = 1$ $[m]$ (rigid, massless)  
-- Gravity: $g = 9.8$ $[m/s²]$  
-- Time step: $0.01$ $[s]$  
-- Simulation duration: $5$ $[s]$  
+- Rod length: $L = 1$ [m] (rigid, massless)  
+- Gravity: $g = 9.8$ [m/s²]  
+- Time step: $0.01$ [s]  
+- Simulation duration: $5$ [s]  
 - Integration function: `solve_ivp` (SciPy)  
 
 The expected result is an oscillatory motion of the angle $θ(t)$ in [Figure 2](#fig-theta), representing the pendulum swinging back and forth.

pyproject.toml

@@ -6,27 +6,31 @@ build-backend = "setuptools.build_meta"
 name = "c4dynamics"
 version = "2.3.2"
 description = "Python framework for state-space modeling and algorithm development"
-authors = [
-    {name = "Ziv Meri", email="[email protected]"}
-]
+authors = [{name = "Ziv Meri", email="[email protected]"}]
 readme = "README.md"
 requires-python = ">=3.8, <3.13"
-license = {text="MIT"}
-
+license = "MIT"
+license-files = ["LICENSE"]
 dependencies = [
   "imageio>=2.37.0", 
-  "matplotlib>=3.10.3", 
-  "natsort>=8.4.0", 
-  "numpy>=2.3.1", 
+  "matplotlib>=3.9.2", 
+  "natsort>=8.3.1", 
+  "numpy>=1.26.0", 
   "opencv-python>=4.11.0.86",
-  "pooch>=1.8.2",
-  "scipy>=1.16.0"
+  "pooch>=1.8.0",
+  "scipy>=1.13.0"
 ]
+keywords = ['python', 'state-space', 'dynamics', 'physics', 'algorithms', 'computer vision', 'navigation', 'guidance', 'slam', 'vslam', 'image processing', 'signal processing', 'control']
+dynamic = ["classifiers"]
+
+[tool.setuptools.dynamic]
+classifiers = { file = "CLASSIFIERS.txt" }
+
 
 # Optional / development dependencies
 [project.optional-dependencies]
 dev = [
-    "nbsphinx>=0.9.7",
+    "nbsphinx>=0.9.3",
     "Sphinx>=8.1.3",
     "sphinx-book-theme>=1.1.4",
     "sphinx_design>=0.6.1"

requirements-dev.txt

@@ -2,11 +2,11 @@
 imageio>=2.37.0
 matplotlib>=3.9.2
 natsort>=8.3.1
-nbsphinx>=0.9.3
 numpy>=1.26.0
 opencv-python>=4.11.0.86
 pooch>=1.8.0
 scipy>=1.13.0
+nbsphinx>=0.9.3
 Sphinx>=8.1.3
 sphinx-book-theme>=1.1.4
 sphinx_design>=0.6.1

setup.py

@@ -10,22 +10,23 @@
     long_description = '\n' + fh.read()
 
 
-import c4dynamics
+# import c4dynamics
 
-VERSION = c4dynamics.__version__
+# VERSION = c4dynamics.__version__ 
+VERSION = "2.3.2" # change also in __init__.py and pyproject.toml
 print(VERSION)
 print('did u remember to upgrade the version number??') 
 
-DESCRIPTION = 'The framework for algorithms engineering with Python.'
-LONG_DESCRIPTION = 'Tsipor (bird) Dynamics (c4dynamics) is the open-source framework of algorithms development for objects in space and time.'
+DESCRIPTION = 'Python framework for state-space modeling.'
+LONG_DESCRIPTION = 'Tsipor (bird) Dynamics (c4dynamics) is The Python framework for state-space modeling and algorithm development.'
 
 required_packages = []
 
-with open(os.path.join(here, 'requirements.txt'), 'r') as file:
-    for line in file:
-        line = line.strip()  # Remove leading and trailing whitespaces
-        if not line.startswith('#'):
-            required_packages.append(line)
+# with open(os.path.join(here, 'requirements.txt'), 'r') as file:
+    # for line in file:
+        # line = line.strip()  # Remove leading and trailing whitespaces
+        # if not line.startswith('#'):
+            # required_packages.append(line)
 
 
 # Now, lines_to_append contains all lines from the file that don't start with a hash
@@ -52,16 +53,6 @@
     # , exclude_package_data          = {package: ['src/main/resources/*.*']}
     , install_requires              = required_packages
     , python_requires = ">=3.8,<3.13" # update also in run-tests.yml, readme.md, pyproject.yaml, setup_guide.ipynb 
-    , keywords = ['python', 'dynamics', 'physics'
-                    , 'algorithms', 'computer vision'
-                        , 'navigation', 'guidance', 'slam' 
-                            , 'vslam', 'image processing', 'signal processing', 'control']
-    , classifiers = ['Development Status :: 5 - Production/Stable'
-                        , 'Intended Audience :: Developers'
-                            , 'Programming Language :: Python :: 3'
-                                , 'Operating System :: Unix'
-                                    , 'Operating System :: MacOS :: MacOS X'
-                                        , 'Operating System :: Microsoft :: Windows']
         )