| Name | nodimo JSON |
| Version |
2.0.0
JSON |
| download |
| home_page | None |
| Summary | Nodimo is a tool that creates dimensionless models |
| upload_time | 2024-08-16 13:42:08 |
| maintainer | None |
| docs_url | None |
| author | None |
| 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="https://github.com/rodrigopcastro018/nodimo/raw/main/docs/logo/logo_name_side.svg" alt="Nodimo Logo" width="500">
</p>
---
| **Docs** | [![Docs Status Badge]][Docs Status] |
| :---------- | :---------------------------------------------------------------------------- |
| **Tests** | [![Tests Status Badge]][Tests Status] [![Coverage Badge]][Coverage] |
| **Python** | [![Python Versions Badge]][Python Versions] |
| **Version** | [![PyPI Version Badge]][PyPI Version] [![Conda Version Badge]][Conda Version] |
| **License** | [![License Badge]][License] |
# Nodimo
The main purpose of Nodimo is to transform a dimensional relationship between quantities into a dimensionless one. This is done by grouping dimensional quantities into dimensionless products in such a way that the resulting number of products is always lower than or equal to the starting number of quantities. Therefore, the ensuing dimensionless model is, at the same time, a generalization and simplification of the dimensional model.
Nodimo supports any number of dimensions and quantities. It can be used for applications in science, engineering, economics and finance. The resulting dimensionless relations can be used as the basis for further studies in similarity and model testing.
## Notes
* The use of Nodimo requires basic knowledge of dimensional analysis, specially on choosing the appropriate set of scaling parameters and indentifying established dimensionless groups.
* It is recommended the use of [jupyter notebook][Jupyter Notebook] for a better displaying of the results.
## Installation
Via `PyPI`, Nodimo and its dependency `Sympy` is installed by:
```shell
pip install nodimo
```
Alternatively, via `Conda`:
```shell
conda install nodimo --channel rodrigopcastro018
```
## Getting started
### Basic example
* Simple pendulum
<p align="center" width="100%">
<img width="30%" src="https://github.com/rodrigopcastro018/nodimo/raw/main/docs/tutorials/drawings/01_simple_pendulum.svg" alt="Simple Pendulum">
</p>
The dimensionless relation between the pendulum's period `T` and the other quantities presented in the figure above is built and displayed as:
```python
from nodimo import Quantity, Model
T = Quantity('T', mass=0, length=0, time=1, dependent=True) # period
L = Quantity('L', mass=0, length=1, time=0, scaling=True) # length
m = Quantity('m', mass=1, length=0, time=0) # mass
g = Quantity('g', mass=0, length=1, time=-2, scaling=True) # gravity
t0 = Quantity('theta_0') # initial angle
model = Model(T, L, m, g, t0)
model.show()
```
And the result is:
$$\displaystyle \frac{T g^{\frac{1}{2}}}{L^{\frac{1}{2}}} = \Phi{\left(\theta_{0} \right)}$$
For more applications and functionalities, check the [documentation][Docs Status].
<!-- Links -->
[Docs Status]: https://nodimo.readthedocs.io/
[Docs Status Badge]: https://img.shields.io/readthedocs/nodimo?color=8A2BE2
[Tests Status]: https://github.com/rodrigopcastro018/nodimo/actions/workflows/full_test.yml?query=branch%3Amain
[Tests Status Badge]: https://img.shields.io/github/actions/workflow/status/rodrigopcastro018/nodimo/full_test.yml?branch=main&label=Tests
[Coverage]: https://coverage-badge.samuelcolvin.workers.dev/redirect/rodrigopcastro018/nodimo
[Coverage Badge]: https://coverage-badge.samuelcolvin.workers.dev/rodrigopcastro018/nodimo.svg
[Python Versions]: https://pypi.org/project/nodimo
[Python Versions Badge]: https://img.shields.io/pypi/pyversions/nodimo
[PyPI Version]: https://pypi.org/project/nodimo/
[PyPI Version Badge]: https://img.shields.io/pypi/v/nodimo?label=PyPI&color=orange
[Conda Version]: https://anaconda.org/rodrigopcastro018/nodimo
[Conda Version Badge]: https://img.shields.io/conda/v/rodrigopcastro018/nodimo?label=Conda&color=green
[PyPI Downloads]: https://pypi.org/project/nodimo
[PyPI Downloads Badge]: https://img.shields.io/pypi/dm/nodimo?label=PyPI%20downloads&color=blue
[Conda Downloads]: https://anaconda.org/rodrigopcastro018/nodimo
[Conda Downloads Badge]: https://img.shields.io/conda/d/rodrigopcastro018/nodimo?label=Conda%20downloads&color=green
[License]: https://github.com/rodrigopcastro018/nodimo/blob/main/LICENSE
[License Badge]: https://img.shields.io/github/license/rodrigopcastro018/nodimo?label=License&color=yellow
[Jupyter Notebook]: https://jupyter.org/
Raw data
{
"_id": null,
"home_page": null,
"name": "nodimo",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Rodrigo Castro <rodrigopcastro018@gmail.com>",
"keywords": "dimensional analysis",
"author": null,
"author_email": "Rodrigo Castro <rodrigopcastro018@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/53/05/c8967a505c3c85259289e94bdb812da7e34310477d46b2af3ebb3f173568/nodimo-2.0.0.tar.gz",
"platform": null,
"description": "<p align=\"center\" width=\"100%\">\r\n <img src=\"https://github.com/rodrigopcastro018/nodimo/raw/main/docs/logo/logo_name_side.svg\" alt=\"Nodimo Logo\" width=\"500\">\r\n</p>\r\n\r\n---\r\n\r\n| **Docs** | [![Docs Status Badge]][Docs Status] |\r\n| :---------- | :---------------------------------------------------------------------------- |\r\n| **Tests** | [![Tests Status Badge]][Tests Status] [![Coverage Badge]][Coverage] |\r\n| **Python** | [![Python Versions Badge]][Python Versions] |\r\n| **Version** | [![PyPI Version Badge]][PyPI Version] [![Conda Version Badge]][Conda Version] |\r\n| **License** | [![License Badge]][License] |\r\n\r\n# Nodimo\r\nThe main purpose of Nodimo is to transform a dimensional relationship between quantities into a dimensionless one. This is done by grouping dimensional quantities into dimensionless products in such a way that the resulting number of products is always lower than or equal to the starting number of quantities. Therefore, the ensuing dimensionless model is, at the same time, a generalization and simplification of the dimensional model.\r\n\r\nNodimo supports any number of dimensions and quantities. It can be used for applications in science, engineering, economics and finance. The resulting dimensionless relations can be used as the basis for further studies in similarity and model testing.\r\n\r\n## Notes\r\n\r\n* The use of Nodimo requires basic knowledge of dimensional analysis, specially on choosing the appropriate set of scaling parameters and indentifying established dimensionless groups.\r\n\r\n* It is recommended the use of [jupyter notebook][Jupyter Notebook] for a better displaying of the results.\r\n\r\n## Installation\r\nVia `PyPI`, Nodimo and its dependency `Sympy` is installed by:\r\n```shell\r\npip install nodimo\r\n```\r\n\r\nAlternatively, via `Conda`:\r\n```shell\r\nconda install nodimo --channel rodrigopcastro018\r\n```\r\n\r\n## Getting started\r\n### Basic example\r\n* Simple pendulum\r\n\r\n<p align=\"center\" width=\"100%\">\r\n <img width=\"30%\" src=\"https://github.com/rodrigopcastro018/nodimo/raw/main/docs/tutorials/drawings/01_simple_pendulum.svg\" alt=\"Simple Pendulum\">\r\n</p>\r\n\r\nThe dimensionless relation between the pendulum's period `T` and the other quantities presented in the figure above is built and displayed as:\r\n\r\n```python\r\nfrom nodimo import Quantity, Model\r\n\r\nT = Quantity('T', mass=0, length=0, time=1, dependent=True) # period\r\nL = Quantity('L', mass=0, length=1, time=0, scaling=True) # length\r\nm = Quantity('m', mass=1, length=0, time=0) # mass\r\ng = Quantity('g', mass=0, length=1, time=-2, scaling=True) # gravity\r\nt0 = Quantity('theta_0') # initial angle\r\n\r\nmodel = Model(T, L, m, g, t0)\r\nmodel.show()\r\n```\r\n\r\nAnd the result is:\r\n\r\n$$\\displaystyle \\frac{T g^{\\frac{1}{2}}}{L^{\\frac{1}{2}}} = \\Phi{\\left(\\theta_{0} \\right)}$$\r\n\r\nFor more applications and functionalities, check the [documentation][Docs Status].\r\n\r\n<!-- Links -->\r\n[Docs Status]: https://nodimo.readthedocs.io/\r\n[Docs Status Badge]: https://img.shields.io/readthedocs/nodimo?color=8A2BE2\r\n[Tests Status]: https://github.com/rodrigopcastro018/nodimo/actions/workflows/full_test.yml?query=branch%3Amain\r\n[Tests Status Badge]: https://img.shields.io/github/actions/workflow/status/rodrigopcastro018/nodimo/full_test.yml?branch=main&label=Tests\r\n[Coverage]: https://coverage-badge.samuelcolvin.workers.dev/redirect/rodrigopcastro018/nodimo\r\n[Coverage Badge]: https://coverage-badge.samuelcolvin.workers.dev/rodrigopcastro018/nodimo.svg\r\n[Python Versions]: https://pypi.org/project/nodimo\r\n[Python Versions Badge]: https://img.shields.io/pypi/pyversions/nodimo\r\n[PyPI Version]: https://pypi.org/project/nodimo/\r\n[PyPI Version Badge]: https://img.shields.io/pypi/v/nodimo?label=PyPI&color=orange\r\n[Conda Version]: https://anaconda.org/rodrigopcastro018/nodimo\r\n[Conda Version Badge]: https://img.shields.io/conda/v/rodrigopcastro018/nodimo?label=Conda&color=green\r\n[PyPI Downloads]: https://pypi.org/project/nodimo\r\n[PyPI Downloads Badge]: https://img.shields.io/pypi/dm/nodimo?label=PyPI%20downloads&color=blue\r\n[Conda Downloads]: https://anaconda.org/rodrigopcastro018/nodimo\r\n[Conda Downloads Badge]: https://img.shields.io/conda/d/rodrigopcastro018/nodimo?label=Conda%20downloads&color=green\r\n[License]: https://github.com/rodrigopcastro018/nodimo/blob/main/LICENSE\r\n[License Badge]: https://img.shields.io/github/license/rodrigopcastro018/nodimo?label=License&color=yellow\r\n[Jupyter Notebook]: https://jupyter.org/\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 dimensionless models",
"version": "2.0.0",
"project_urls": {
"Documentation": "https://nodimo.readthedocs.io/",
"Source": "https://github.com/rodrigopcastro018/nodimo"
},
"split_keywords": [
"dimensional",
"analysis"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cdfa882c492e91190a1aafca4aa37ee4052ee8eb4abed57dfdfbbf992787c283",
"md5": "cb7a4dd1ffd02d3654a77411e7914d59",
"sha256": "5e8ef4bddb022d6b88162f2a8f9003bb37a88a4939042801eac0a1a865528431"
},
"downloads": -1,
"filename": "nodimo-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cb7a4dd1ffd02d3654a77411e7914d59",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 31301,
"upload_time": "2024-08-16T13:42:06",
"upload_time_iso_8601": "2024-08-16T13:42:06.948645Z",
"url": "https://files.pythonhosted.org/packages/cd/fa/882c492e91190a1aafca4aa37ee4052ee8eb4abed57dfdfbbf992787c283/nodimo-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5305c8967a505c3c85259289e94bdb812da7e34310477d46b2af3ebb3f173568",
"md5": "cf7711ee935e322aff0764fb1a258fc3",
"sha256": "18d996bccf816b6f45e6769d9c131c084528321b913707eb02b65b5bae6c5e41"
},
"downloads": -1,
"filename": "nodimo-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "cf7711ee935e322aff0764fb1a258fc3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 36734,
"upload_time": "2024-08-16T13:42:08",
"upload_time_iso_8601": "2024-08-16T13:42:08.779195Z",
"url": "https://files.pythonhosted.org/packages/53/05/c8967a505c3c85259289e94bdb812da7e34310477d46b2af3ebb3f173568/nodimo-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-16 13:42:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rodrigopcastro018",
"github_project": "nodimo",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "nodimo"
}
