Metadata-Version: 2.4
Name: np-vmd
Version: 0.1.1
Summary: A package for Vibrations and Machine Dynamics
Author-email: "N. Papadakis" <npapnet@gmail.com>
Project-URL: Source, https://github.com/npapnet/np-vmd
Project-URL: Documentation, https://npapnet.github.io/np-vmd/
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: matplotlib
Requires-Dist: scipy
Requires-Dist: numpy
Requires-Dist: seaborn
Requires-Dist: pandas
Requires-Dist: openpyxl
Requires-Dist: ipykernel
Requires-Dist: jupyter
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Provides-Extra: dev
Requires-Dist: ruff; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-rtd-theme; extra == "docs"
Requires-Dist: sphinxcontrib-mermaid; extra == "docs"
Dynamic: license-file

# Vibrations and Machine Dynamics

This is a package for helping with the lecture of npapnet at the Mechanical Engineering department. 

Contains code for:

- SDOF system
  - Free response
    - Undamped
    - Damped
  - Forced HArmonic response
    - Undamped
    - Damped 
- TDOF systems
- MDOF systems

## project urls
- [Documentation: https://npapnet.github.io/np-vmd/](https://npapnet.github.io/np-vmd/)
- PyPI: https://pypi.org/project/np-vmd/ - not yet published
- [Source Code: https://github.com/npapnet/np-vmd](https://github.com/npapnet/np-vmd)

# Usage

## installation

Navigate to the folder of the pypkg and use

> pip install --editable .


# TODO 

Issues:
- 20240116: [ ] update rst documentation with new configuration of tdof_mck and the response classes. 
- 20240116: [ ] Inman: check forced response of system (no iv)
- 20240116: [ ] Inman: check forced response of system (with iv)
- 20240116: [ ] Gagnon: check forced response of system (single excitation - with iv)
- 20240116: [ ] Gagnon: check forced response of system (only iv - no excitation) 
- 20240116: [ ] Gagnon: check forced response of system (only iv - multipleexcitation)

## History 
### v:0.1.1
- 20251205: [x] moved to separate repository. Updated name and documentation. 

### v0.0.2
- 20240116: [x] Inman: check free response of system
- 20240116: [X] Gagnon: check forced response of system (single excitation - no iv)
