| Name | useful-math-functions JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | useful-math-functions for Optimization, Benchmarking, Visualizing, and more ... |
| upload_time | 2024-08-10 10:19:40 |
| maintainer | None |
| docs_url | None |
| author | Anselm Hahn |
| requires_python | <3.12,>=3.10 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://doi.org/10.5281/zenodo.8373435)
# useful-math-functions
`useful-math-functions` is a collection of useful mathematical functions with a
focus on:
1. **ease of use** - the functions are designed to be as easy to use as possible
2. **pure python** - the functions are written in much python as possible and
only use external libraries when necessary
3. **documentation** - the functions are documented in code itself with:
1. Examples
2. Equations
3. References
4. Links to external resources
## Installation
The package can be installed via pip:
```bash
pip install useful-math-functions
```
and for Visualizations:
```bash
# matplotlib
pip install useful-math-functions[matplotlib]
# plotly
pip install useful-math-functions[plotly]
# all visualizations
pip install useful-math-functions[all]
```
## Usage
The package can be imported like any other python package:
```python
from umf.core.create import OptBench
res = OptBench(["DeJongN5Function"], dim=3)
res.plot_type_3d = "plot_surface"
res.plot()
res.save_as_image()
```
## Documentation
The documentation can be found
[here](https://anselmoo.github.io/useful-math-functions/).
## Contributing
Contributions are welcome. For major changes, please open an issue first to
discuss what you would like to change.
## License
The project is licensed under the
[MIT](https://github.com/Anselmoo/useful-math-functions/blob/main/LICENSE)
license.
Raw data
{
"_id": null,
"home_page": null,
"name": "useful-math-functions",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Anselm Hahn",
"author_email": "anselm.hahn@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/16/78/97b95682982fc78999fb46daed09a40b2ac306a8113a1ccfe71839fb324c/useful_math_functions-0.2.0.tar.gz",
"platform": null,
"description": "[](https://doi.org/10.5281/zenodo.8373435)\n\n# useful-math-functions\n\n`useful-math-functions` is a collection of useful mathematical functions with a\nfocus on:\n\n1. **ease of use** - the functions are designed to be as easy to use as possible\n2. **pure python** - the functions are written in much python as possible and\n only use external libraries when necessary\n3. **documentation** - the functions are documented in code itself with:\n 1. Examples\n 2. Equations\n 3. References\n 4. Links to external resources\n\n## Installation\n\nThe package can be installed via pip:\n\n```bash\npip install useful-math-functions\n```\n\nand for Visualizations:\n\n```bash\n# matplotlib\npip install useful-math-functions[matplotlib]\n\n# plotly\npip install useful-math-functions[plotly]\n\n# all visualizations\npip install useful-math-functions[all]\n```\n\n## Usage\n\nThe package can be imported like any other python package:\n\n```python\nfrom umf.core.create import OptBench\nres = OptBench([\"DeJongN5Function\"], dim=3)\nres.plot_type_3d = \"plot_surface\"\nres.plot()\nres.save_as_image()\n```\n\n\n\n## Documentation\n\nThe documentation can be found\n[here](https://anselmoo.github.io/useful-math-functions/).\n\n## Contributing\n\nContributions are welcome. For major changes, please open an issue first to\ndiscuss what you would like to change.\n\n## License\n\nThe project is licensed under the\n[MIT](https://github.com/Anselmoo/useful-math-functions/blob/main/LICENSE)\nlicense.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "useful-math-functions for Optimization, Benchmarking, Visualizing, and more ...",
"version": "0.2.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d4a26ff8f80bb3c0298d83e4b28e9d9bb78e8866f78d9f3ca62b10c9138dc3e4",
"md5": "b9a76991846add2176c85d33236b05c3",
"sha256": "7a38b260d2db3db02210dfd6a1508bda5439e8e2e9ec6eb2b27632f8322ae513"
},
"downloads": -1,
"filename": "useful_math_functions-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b9a76991846add2176c85d33236b05c3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.10",
"size": 80238,
"upload_time": "2024-08-10T10:19:39",
"upload_time_iso_8601": "2024-08-10T10:19:39.273793Z",
"url": "https://files.pythonhosted.org/packages/d4/a2/6ff8f80bb3c0298d83e4b28e9d9bb78e8866f78d9f3ca62b10c9138dc3e4/useful_math_functions-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "167897b95682982fc78999fb46daed09a40b2ac306a8113a1ccfe71839fb324c",
"md5": "e57ed010fa55d2bc08d007cd9cdc9134",
"sha256": "11c22de7a40108812784516b88f1d0e6a9cc41b3ab1db7b455c306b5b8fae6f9"
},
"downloads": -1,
"filename": "useful_math_functions-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "e57ed010fa55d2bc08d007cd9cdc9134",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.10",
"size": 60830,
"upload_time": "2024-08-10T10:19:40",
"upload_time_iso_8601": "2024-08-10T10:19:40.625049Z",
"url": "https://files.pythonhosted.org/packages/16/78/97b95682982fc78999fb46daed09a40b2ac306a8113a1ccfe71839fb324c/useful_math_functions-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-10 10:19:40",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "useful-math-functions"
}
