<p align="center">
<img src="https://github.com/nikolaiborbe/PyFys/blob/main/assets/logo.png" width="180" alt="PyFys Logo" />
</p>
<h1 align="center">PyFys</h1>
<p align="center">An opinionated physics library.</p>
<p align="center">
<code>pip install pyfys</code>
</p>
<br />
PyFys is a Python library designed to simplify physics calculations and visualizations. It provides tools for computing common physics quantities and creating graphs.
The philosophy of the project is speed and simplicity. Physics is challenging enough as it is, so PyFys aims to make the programming side of things as easy as possible.
---
## Features
- Calculate physical quantities like kinetic energy, force, and relativistic momentum. (More equations coming soon!)
- Generate and visualize graphs for functions and data.
- Supports scalar and vector inputs for maximum flexibility and speed.
---
## Installation
To install PyFys, run the following command:
```bash
pip install pyfys
```
---
## Quickstart
### Import the Library
Here's an example of how to use PyFys to calculate kinetic energy:
```python
import pyfys
# Example: Calculate kinetic energy
fys = pyfys.fys()
mass = 10
velocity = [5, 10, 15]
energy = fys.kinetic_energy(mass=mass, velocity=velocity)
print(energy) # Output: [125.0, 500.0, 1125.0]
```
### Generate a Graph
This example demonstrates how to plot multiple functions:
```python
fys.graph((math.sin, math.cos), stop=5)
```
### Plot Data
This example demonstrates how to plot data:
```python
mass = 10
velocity = [5, 10, 15]
fys.plot(fys.kinetic_energy(mass, velocity), velocity)
```
### Bar Chart
This example demonstrates how to create a bar chart from a list of data:
```python
data = ["cat", "dog", "bird", "cat", "dog", "fish", "dog"]
fys.bar(data)
```
---
## Documentation
TODO: Add documentation
"For detailed usage and examples, visit the [official documentation](https://github.com/your-repo-link)."
---
## Contributing
Contributions are welcome!
---
## License
This project is licensed under the MIT License. See the `LICENSE` file for details.
## TODO
- [ ] Add more equations
- [ ] Add more constants
- [ ] Add more unit conversions
- [ ] Create documentation
- [ ] Create a documentation website, where you can search for equations (like the Tailwind documentation)
- [ ] Add integralcalculations for e.g. inertia
Raw data
{
"_id": null,
"home_page": "https://github.com/nikolaiborbe",
"name": "pyfys",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "python, physics, graphing, constants",
"author": "Nikolai G. Borbe",
"author_email": "nikolaiborbe@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/17/a6/a11ab7b905b62e5c7e055e6121cc95b109d6b052b9549dd5a0bf4bde82da/pyfys-0.2.15.tar.gz",
"platform": null,
"description": "\n<p align=\"center\">\n <img src=\"https://github.com/nikolaiborbe/PyFys/blob/main/assets/logo.png\" width=\"180\" alt=\"PyFys Logo\" />\n</p>\n\n<h1 align=\"center\">PyFys</h1>\n\n<p align=\"center\">An opinionated physics library.</p>\n<p align=\"center\">\n<code>pip install pyfys</code>\n</p>\n<br />\n\nPyFys is a Python library designed to simplify physics calculations and visualizations. It provides tools for computing common physics quantities and creating graphs.\n\nThe philosophy of the project is speed and simplicity. Physics is challenging enough as it is, so PyFys aims to make the programming side of things as easy as possible.\n\n---\n\n## Features\n- Calculate physical quantities like kinetic energy, force, and relativistic momentum. (More equations coming soon!)\n- Generate and visualize graphs for functions and data.\n- Supports scalar and vector inputs for maximum flexibility and speed.\n\n---\n\n## Installation\n\nTo install PyFys, run the following command:\n\n```bash\npip install pyfys\n```\n\n---\n\n## Quickstart\n\n### Import the Library\nHere's an example of how to use PyFys to calculate kinetic energy:\n\n```python\nimport pyfys\n\n# Example: Calculate kinetic energy\nfys = pyfys.fys()\nmass = 10\nvelocity = [5, 10, 15]\nenergy = fys.kinetic_energy(mass=mass, velocity=velocity)\nprint(energy) # Output: [125.0, 500.0, 1125.0]\n```\n\n### Generate a Graph\nThis example demonstrates how to plot multiple functions:\n\n```python\nfys.graph((math.sin, math.cos), stop=5)\n```\n\n### Plot Data\nThis example demonstrates how to plot data:\n\n```python\nmass = 10\nvelocity = [5, 10, 15]\n\nfys.plot(fys.kinetic_energy(mass, velocity), velocity)\n```\n\n### Bar Chart\nThis example demonstrates how to create a bar chart from a list of data:\n\n```python\ndata = [\"cat\", \"dog\", \"bird\", \"cat\", \"dog\", \"fish\", \"dog\"]\nfys.bar(data)\n```\n\n---\n\n## Documentation\nTODO: Add documentation\n\"For detailed usage and examples, visit the [official documentation](https://github.com/your-repo-link).\"\n\n---\n\n## Contributing\n\nContributions are welcome!\n\n---\n\n## License\n\nThis project is licensed under the MIT License. See the `LICENSE` file for details.\n\n## TODO\n- [ ] Add more equations\n- [ ] Add more constants\n- [ ] Add more unit conversions\n- [ ] Create documentation\n- [ ] Create a documentation website, where you can search for equations (like the Tailwind documentation)\n- [ ] Add integralcalculations for e.g. inertia\n",
"bugtrack_url": null,
"license": null,
"summary": "A library to speed up physics work",
"version": "0.2.15",
"project_urls": {
"Homepage": "https://github.com/nikolaiborbe"
},
"split_keywords": [
"python",
" physics",
" graphing",
" constants"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b7e245f700eab6014e98d686aaaad7fb47496a6f9e8274a1130847609aac79c3",
"md5": "cc630ed3ed4a2468864e90e017e863f1",
"sha256": "e2f32cf7fbd1f4216ef4b47bc3bfb1b8983294fea5043ca9646c0aa89b63d403"
},
"downloads": -1,
"filename": "pyfys-0.2.15-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cc630ed3ed4a2468864e90e017e863f1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7344,
"upload_time": "2024-12-11T20:38:32",
"upload_time_iso_8601": "2024-12-11T20:38:32.893748Z",
"url": "https://files.pythonhosted.org/packages/b7/e2/45f700eab6014e98d686aaaad7fb47496a6f9e8274a1130847609aac79c3/pyfys-0.2.15-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "17a6a11ab7b905b62e5c7e055e6121cc95b109d6b052b9549dd5a0bf4bde82da",
"md5": "c3a6c813cbf8e200b216c9523e80cd4e",
"sha256": "50a8168765d3ac004fcf4b010efa804eeaa95490fb0779e2450f16263071d2ab"
},
"downloads": -1,
"filename": "pyfys-0.2.15.tar.gz",
"has_sig": false,
"md5_digest": "c3a6c813cbf8e200b216c9523e80cd4e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8146,
"upload_time": "2024-12-11T20:38:33",
"upload_time_iso_8601": "2024-12-11T20:38:33.784714Z",
"url": "https://files.pythonhosted.org/packages/17/a6/a11ab7b905b62e5c7e055e6121cc95b109d6b052b9549dd5a0bf4bde82da/pyfys-0.2.15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-11 20:38:33",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pyfys"
}
JSON