c4dynamics

[C4dynamics]

Submitting Author: Ziv (@C4dynamics)
Package Name: c4dynamics
One-Line Description of Package: Python framework for algorithms of dynamic systems

Repository Link (if existing): https://github.com/C4dynamics/C4dynamics
EiC: @coatless

---

Code of Conduct & Commitment to Maintain Package

• I agree to abide by pyOpenSci's Code of Conduct during the review process and in maintaining my package after should it be accepted.
• I have read and will commit to package maintenance after the review as per the pyOpenSci Policies Guidelines.

Description

• Include a brief paragraph describing what your package does:
  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.

Community Partnerships

We partner with communities to support peer review with an additional layer of
checks that satisfy community requirements. If your package fits into an
existing community please check below:

• Astropy: My package adheres to Astropy community standards
• Pangeo: My package adheres to the Pangeo standards listed in the pyOpenSci peer review guidebook

Scope

• Please indicate which category or categories this package falls under:

  • Data retrieval
  • Data extraction
  • Data processing/munging
  • Data deposition
  • Data validation and testing
  • Data visualization
  • Workflow automation
  • Citation management and bibliometrics
  • Scientific software wrappers
  • Database interoperability

None of these. c4dynamics belongs to the category of math-operations and data-operations for physical models.

Domain Specific

• Geospatial
• Education

---

• Explain how and why the package falls under these categories (briefly, 1-2 sentences). For community partnerships, check also their specific guidelines as documented in the links above. Please note any areas you are unsure of:
  c4dynamics belongs to the category of math-operations and data-operations for physical models. Please refer to this page from the documentary to a brief overview of the package core: https://c4dynamics.github.io/C4dynamics/api/States.html

• Who is the target audience and what are the scientific applications of this package?
  Researchers, engineers, and students from the fields of aerospace, robotics, navigation guidance and control.

• Are there other Python packages that accomplish similar things? If so, how does yours differ?
  The core concept of state objects - probably not.
  Modules from the library of the package, like Kalman filters, seeker models, solvers etc. - there are. However, here they are built on top of a state object, which according to the philosophy of the package, should facilitate and improve the algorithm development.

• Any other questions or issues we should be aware of:
  I'd be happy if the kind reviewer contact with me for any question or uncertainty. I'm open to any kind of communication.

P.S. Have feedback/comments about our review process? Leave a comment here
thank you :-)

[coatless]

Hi Ziv/@C4dynamics thank you for making this presubmission inquiry. Sorry we haven't gotten back to you sooner as we were on break and undergoing an EiC transition.

In terms of scope, we'll need to consider the package underneath Data processing and munging category:

https://www.pyopensci.org/software-peer-review/about/package-scope.html#data-processing-and-munging

I'm working on broadening our categories; but, that will be the primary one used for this submission.

We'll also consider this package to be "in-scope" under a specialized field instead of a general "core" package (due to the new data structures).

Regarding other Python packages, I suppose we have:

• For event-driven or discrete event simulation, statepy [defunct], statemachine, or transition.
• For decision-making or reinforcement learning systems, POMDPy (not maintained) and tools like transition (for FSM).

In comparison, this package presents a novel state interface and individual modules tailored for sensors, detectors, and filters.

---

Before submitting for review, please make sure to enable CI testing:

https://www.pyopensci.org/python-package-guide/tests/tests-ci.html

Please add to the README: Badges for the packages current published version, documentation and test suite build. (OPTIONAL: test coverage)

https://www.pyopensci.org/python-package-guide/documentation/repository-files/readme-file-best-practices.html

Please make sure to use capitalized names for README.md, CODE_OF_CONDUCT.md, and CONTRIBUTING.md.

Please add a CHANGELOG.md file discussing changes:

https://www.pyopensci.org/python-package-guide/documentation/repository-files/changelog-file.html

[C4dynamics]

Hi James, Thanks for the initial review. I think Data Processing and Munging is probably the best choice. The relative packages you suggested are reasonable. I enabled the CI testing as GitHub workflow and it seems to work correctly. I also added to the README some badges, capitalized the names of meta files and added a CHANGELOG.md file. Waiting for further instructions toward submission for review.

…

On Wed, Feb 5, 2025, 09:38 James J Balamuta ***@***.***> wrote: Hi ***@***.*** <https://github.com/C4dynamics> thank you for making this presubmission inquiry. Sorry we haven't gotten back to you sooner as we were on break and undergoing an EiC transition. In terms of scope, we'll need to consider the package underneath Data processing and munging category: https://www.pyopensci.org/software-peer-review/about/package-scope.html#data-processing-and-munging I'm working on broadening our categories; but, that will be the primary one used for this submission. We'll also consider this package to be "in-scope" under a specialized field instead of a general "core" package (due to the new data structures). Regarding other Python packages, I suppose we have: - For event-driven or discrete event simulation, statepy <https://pypi.org/project/StatePy/> [defunct], statemachine <https://python-statemachine.readthedocs.io/en/latest/readme.html>, or transition <https://github.com/pytransitions/transitions>. - For decision-making or reinforcement learning systems, POMDPy <https://github.com/pemami4911/POMDPy> (not maintained) and tools like transition (for FSM). In comparison, this package presents a novel state interface and individual modules tailored for sensors, detectors, and filters. ------------------------------ Before submitting for review, please make sure to enable CI testing: https://www.pyopensci.org/python-package-guide/tests/tests-ci.html Please add to the README: Badges for the packages current published version, documentation and test suite build. (OPTIONAL: test coverage) https://www.pyopensci.org/python-package-guide/documentation/repository-files/readme-file-best-practices.html Please make sure to use capitalized names for README.md, CODE_OF_CONDUCT.md, and CONTRIBUTING.md. Please add a CHANGELOG.md file discussing changes: https://www.pyopensci.org/python-package-guide/documentation/repository-files/changelog-file.html — Reply to this email directly, view it on GitHub <#224 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/APQX7NH5STUM7V23JG2ID3T2OG5YNAVCNFSM6AAAAABTWRY4DKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMMZVHE2DQNZRGU> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[C4dynamics]

Hi,
I'm sorry.
I now see that the tests in the CI workflow are not really performed ("run 0 tests in 0sec").

Let me a few days to see what's going on and I'll update you.

[C4dynamics]

Alright. All tests are passing. I think all instructions are fulfilled.

[coatless]

@C4dynamics thank you for addressing those points. I'd like to move this from a pre-submission inquiry into a formal review inquiry.

This means that I'll need you to create a new issue on the repository that follows our formal software request instead of a pre-submission note.

https://github.com/pyOpenSci/software-submission/issues/new?template=submit-software-for-review.md

You can see the next steps in the process under the author's guide:

https://www.pyopensci.org/software-peer-review/how-to/author-guide.html#submit-your-package-for-peer-review

If you any more pre-submission inquiries, please let me know!

[C4dynamics]

Thanks, it was pleasure working with you.

[coatless]

@C4dynamics not quite done yet ;)

I'll see you over in #234 before assigning out an editor. 😄