vectoriumPy 0.1.0

A Python library containing common physics utilities for education and quick calculations.

VectoriumPy

VectoriumPy is a lightweight, modular Python library of common physics formulas, helpers, and small simulation utilities for education and quick calculations.

Goals: clear, well-tested helpers for kinematics, forces, energy, electricity, waves, magnetism, and thermodynamics.

Quick start

Install from PyPI (when published):

pip install vectoriumPy

Install editable from source:

python -m venv .venv
.\.venv\Scripts\activate
pip install -e .

Usage example:

from vectoriumPy.Kinematics.motion import avg_velocity

v = avg_velocity(50, 10)  # average velocity = displacement / time
print(v)

Run the examples:

python src/vectoriumPy/examples/examples.py

Run tests locally:

python -m pip install -r requirements-dev.txt
python -m pytest -q

Project layout

• src/vectoriumPy/
  • Kinematics/ — motion and projectile utilities
  • Force/ — force-related formulas
  • Energy/ — energy helpers
  • Electricity/ — circuits and electric-field helpers
  • Waves/ — light and sound calculations
  • Magnetism/ — magnetic field helpers
  • Thermodynamics/ — thermodynamics utilities
  • examples/ — runnable examples
  • Tests/ — unit tests

Contributing

Contributions are welcome. Suggested workflow:

1. Fork the repo and create a feature branch.
2. Add tests for new functions under src/vectoriumPy/Tests.
3. Open a PR with a clear description of changes.

Publishing

This project uses GitHub Actions to run CI. To publish to PyPI create a GitHub release (or push a tag v*) and add PYPI_API_TOKEN to repository secrets.

License

This project is licensed under the MIT License — see LICENSE for details.