I'm developing a Python API for simulating and visualizing systems of ordinary differential equations, and I'd love to get your feedback! I'm fairly new to software development, so I'm looking for suggestions and ideas to improve my project. I plan to add adaptive time stepping in the future as well. Here's a link to my GitHub repository where you can find the code. I'm not looking for a line-by-line code review; rather, I would appreciate insights on long-term maintainability and the features included. Thanks for your help!
2 Answers
I think you're missing out by not having any tests set up or a good delivery mechanism. Also, the current documentation isn't very helpful, so it's hard to see who would be interested in using this.
First off, you should seriously consider revamping your README. I read it and honestly had no clue what your project was about. A clearer overview can make a huge difference in attracting interest.
I hear you! I've already updated the README and I'm working on proper documentation for everything. It'll take some time, but I'm on it!
Thanks for the feedback. I admit I'm not very familiar with best practices in software, which is exactly why I'm reaching out for advice on how to improve. I appreciate your understanding!