Skip to main content

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

Project description

VectoriumPy

License

Vectorium logo

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.

License

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vectoriumpy-0.3.0.tar.gz (25.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vectoriumpy-0.3.0-py3-none-any.whl (33.7 kB view details)

Uploaded Python 3

File details

Details for the file vectoriumpy-0.3.0.tar.gz.

File metadata

  • Download URL: vectoriumpy-0.3.0.tar.gz
  • Upload date:
  • Size: 25.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.5

File hashes

Hashes for vectoriumpy-0.3.0.tar.gz
Algorithm Hash digest
SHA256 01b64532f06a4c11ccb38a4ff6b4b275a2709285b14ca99966850f008f9a0ad6
MD5 c233779941ee698fddbdd5ca13a62770
BLAKE2b-256 2ce618d4e3cae82f83a9bb8155d6e5235ca2f74fbf495c644cb24e1b2609d844

See more details on using hashes here.

File details

Details for the file vectoriumpy-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: vectoriumpy-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 33.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.5

File hashes

Hashes for vectoriumpy-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b4bfaaddb6491c7a55f3deff1b7ce416de7742679fb8172330e8b77b62925836
MD5 cecd199cc78cd7bef91c6082b4c3a0ff
BLAKE2b-256 35807b39f688393ab46bd076ef302b88112d28082916577f588c50a64a3a0d9c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page