Revisions outline

[Gorkowski]

Fixes #438

Discussions and examples of how we could revise the code, base.

[github-actions]

PR Preview Action v1.4.7
🚀 Deployed preview to https://uncscode.github.io/particula/pr-preview/pr-439/
on branch gh-pages at 2024-03-21 18:37 UTC

[Gorkowski]

@ngmahfouz Check out the examples on the docs, https://uncscode.github.io/particula/pr-preview/pr-439/documentation/base/gas.html

I think this structure/framework will be pretty flexible. I'm mainly trying to layout the interactions between each class/process. What are your thoughts? You want to discuss, before proceeding?

[ngmahfouz]

This started with "chat with gpt on how this could work" and then went bananas 😸

We will discuss tomorrow.

One quick comment after glancing over this: I think we might benefit from utilizing the __repr__ method somewhere in this rewrite.

[ngmahfouz]

I notice we have no more units around. Should we drop carrying units and do everything in the 7 SI base units or possibly the 29 (or so?) base and derived units?

[ngmahfouz]

@Gorkowski Sorry... I got distracted. Could we rename base to something like dev or exp or experimental or next or something like that to convey that it is the next planned structure? Other than that, all other items can be delayed until later. Sorry!

[Gorkowski]

yeah, I like next

[sourcery-ai]

Hey @Gorkowski - I've reviewed your changes and they look great!

General suggestions:

• Consider consolidating related imports for improved readability.
• Add TODO comments for future implementation plans to clarify the intention behind commented-out code.
• Ensure all imports are utilized to maintain clean and efficient code.
• Expand the test suite to cover edge cases and error handling scenarios for more robust code.
• Verify dynamic behavior and method attachments in the Aerosol class after replacing Gas or Particle instances.

Here's what I looked at during the review

• 🟡 General issues: 3 issues found
• 🟢 Security: all looks good
• 🟡 Testing: 4 issues found
• 🟢 Complexity: all looks good
• 🟢 Docstrings: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.}