| Name | nodimo JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | |
| Summary | Nodimo is a tool that creates nondimensional models. |
| upload_time | 2024-02-26 03:10:17 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2024 Rodrigo Castro Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
dimensional
analysis
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<p align="center" width="100%">
<img src="nodimo_logo.png" alt="Nodimo Logo">
</p>
---
<p align="center">
<a href="https://www.python.org/" alt="Python">
<img src="https://img.shields.io/badge/python-3-green" /></a>
<a href="https://github.com/jupyter/notebook" alt="Jupyter">
<img src="https://img.shields.io/badge/jupyter-notebook-orange" /></a>
<a href="https://github.com/rodrigopcastro018/nodimo/blob/main/LICENSE" alt="License">
<img src="https://img.shields.io/badge/license-MIT-green" /></a>
</p>
# Nodimo
The main purpose of Nodimo is to transform a dimensional relationship between variables into a nondimensional one. The variables are gathered in nondimensional groups such that the number of groups is lower than the number of variables. The resulting nondimensional model is, at the same time, a generalization and simplification of the dimensional model.
Nodimo supports any number of dimensions and variables. It can be used for applications in science, engineering, economics and finance. The resulting nondimensional groups can be used as the basis for further studies in similarity and model testing.
## Installation
Nodimo and its dependencies (`numpy` and `sympy`) are installed by:
```shell
pip install nodimo
```
When running Nodimo on the terminal, make sure that the terminal supports Unicode characters. For the best experience, it is recommended the use of [jupyter notebook](https://github.com/jupyter/notebook).
## Getting started
### Basic example
Simple pendulum:
<p align="center" width="100%">
<img width="30%" src="simple_pendulum.png" alt="Simple Pendulum">
</p>
The nondimensional model for the pendulum's period as a function of the other variables is built and displayed as:
```python
from nodimo import Variable, NonDimensionalModel
# Variables' dimensions: Mass (M), Length (L) and Time (T)
T = Variable('T', M=0, L=0, T=1, dependent=True) # period
L = Variable('L', M=0, L=1, T=0, scaling=True) # length
m = Variable('m', M=1, L=0, T=0) # mass
g = Variable('g', M=0, L=1, T=-2, scaling=True) # gravity
t0 = Variable('theta_0') # initial angle
ndmodel = NonDimensionalModel(T, L, m, g, t0)
ndmodel.show()
```
And the result is:
```math
\displaystyle \frac{T g^{\frac{1}{2}}}{L^{\frac{1}{2}}} = \Pi{\left(\theta_{0} \right)}
```
For more functionalities and examples, check the documentation.
## License
Nodimo is open-source and released under the [MIT License](LICENSE)
Raw data
{
"_id": null,
"home_page": "",
"name": "nodimo",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Rodrigo Castro <rodrigopcastro018@gmail.com>",
"keywords": "dimensional analysis",
"author": "",
"author_email": "Rodrigo Castro <rodrigopcastro018@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/86/0a/d8d137805853fe9fa779d5cc3ef21ab82bd0d0651c29f6b410df9266e8d4/nodimo-1.0.0.tar.gz",
"platform": null,
"description": "<p align=\"center\" width=\"100%\">\r\n <img src=\"nodimo_logo.png\" alt=\"Nodimo Logo\">\r\n</p>\r\n\r\n---\r\n\r\n<p align=\"center\">\r\n <a href=\"https://www.python.org/\" alt=\"Python\">\r\n <img src=\"https://img.shields.io/badge/python-3-green\" /></a>\r\n <a href=\"https://github.com/jupyter/notebook\" alt=\"Jupyter\">\r\n <img src=\"https://img.shields.io/badge/jupyter-notebook-orange\" /></a>\r\n <a href=\"https://github.com/rodrigopcastro018/nodimo/blob/main/LICENSE\" alt=\"License\">\r\n <img src=\"https://img.shields.io/badge/license-MIT-green\" /></a>\r\n</p>\r\n\r\n# Nodimo\r\nThe main purpose of Nodimo is to transform a dimensional relationship between variables into a nondimensional one. The variables are gathered in nondimensional groups such that the number of groups is lower than the number of variables. The resulting nondimensional model is, at the same time, a generalization and simplification of the dimensional model.\r\n\r\nNodimo supports any number of dimensions and variables. It can be used for applications in science, engineering, economics and finance. The resulting nondimensional groups can be used as the basis for further studies in similarity and model testing.\r\n\r\n## Installation\r\nNodimo and its dependencies (`numpy` and `sympy`) are installed by:\r\n```shell\r\npip install nodimo\r\n```\r\n\r\nWhen running Nodimo on the terminal, make sure that the terminal supports Unicode characters. For the best experience, it is recommended the use of [jupyter notebook](https://github.com/jupyter/notebook).\r\n\r\n## Getting started\r\n### Basic example\r\nSimple pendulum:\r\n\r\n<p align=\"center\" width=\"100%\">\r\n <img width=\"30%\" src=\"simple_pendulum.png\" alt=\"Simple Pendulum\">\r\n</p>\r\n\r\nThe nondimensional model for the pendulum's period as a function of the other variables is built and displayed as:\r\n```python\r\nfrom nodimo import Variable, NonDimensionalModel\r\n\r\n# Variables' dimensions: Mass (M), Length (L) and Time (T)\r\nT = Variable('T', M=0, L=0, T=1, dependent=True) # period\r\nL = Variable('L', M=0, L=1, T=0, scaling=True) # length\r\nm = Variable('m', M=1, L=0, T=0) # mass\r\ng = Variable('g', M=0, L=1, T=-2, scaling=True) # gravity\r\nt0 = Variable('theta_0') # initial angle\r\n\r\nndmodel = NonDimensionalModel(T, L, m, g, t0)\r\nndmodel.show()\r\n```\r\n\r\nAnd the result is:\r\n```math\r\n\\displaystyle \\frac{T g^{\\frac{1}{2}}}{L^{\\frac{1}{2}}} = \\Pi{\\left(\\theta_{0} \\right)}\r\n```\r\n\r\nFor more functionalities and examples, check the documentation.\r\n\r\n## License\r\nNodimo is open-source and released under the [MIT License](LICENSE)\r\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Rodrigo Castro Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Nodimo is a tool that creates nondimensional models.",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/rodrigopcastro018/nodimo"
},
"split_keywords": [
"dimensional",
"analysis"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ec9a503a00a57517a5bccc0d45ddfc34af80a623dab00dbc7097131612791802",
"md5": "6265fb94801890807bf880ef443b616e",
"sha256": "2e7f05caf91cef2cf7fb953cb477acba3fa2b73a176d8c65fd36fd826e2635a2"
},
"downloads": -1,
"filename": "nodimo-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6265fb94801890807bf880ef443b616e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 19414,
"upload_time": "2024-02-26T03:10:14",
"upload_time_iso_8601": "2024-02-26T03:10:14.695172Z",
"url": "https://files.pythonhosted.org/packages/ec/9a/503a00a57517a5bccc0d45ddfc34af80a623dab00dbc7097131612791802/nodimo-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "860ad8d137805853fe9fa779d5cc3ef21ab82bd0d0651c29f6b410df9266e8d4",
"md5": "64bff5bc0815ba14e3495d259a062f12",
"sha256": "5147a2bfa6cd06b0b1bc6411c80dee31eede87776b8d9d573c9762d13c47ca7a"
},
"downloads": -1,
"filename": "nodimo-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "64bff5bc0815ba14e3495d259a062f12",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 15843,
"upload_time": "2024-02-26T03:10:17",
"upload_time_iso_8601": "2024-02-26T03:10:17.267517Z",
"url": "https://files.pythonhosted.org/packages/86/0a/d8d137805853fe9fa779d5cc3ef21ab82bd0d0651c29f6b410df9266e8d4/nodimo-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-26 03:10:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rodrigopcastro018",
"github_project": "nodimo",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "nodimo"
}
