useful-math-functions-functions


Nameuseful-math-functions-functions JSON
Version 0.1.0 PyPI version JSON
download
home_page
Summaryuseful-math-functions for Optimization, Benchmarking, Visualizing, and more ...
upload_time2023-09-23 20:56:42
maintainer
docs_urlNone
authorAnselm Hahn
requires_python>=3.10,<3.12
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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()
```

![_](https://github.com/Anselmoo/useful-math-functions/blob/main/docs/extra/images/DeJongN5Function.png?raw=true)

## 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": "",
    "name": "useful-math-functions-functions",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10,<3.12",
    "maintainer_email": "",
    "keywords": "",
    "author": "Anselm Hahn",
    "author_email": "anselm.hahn@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/3e/19/7cbae94e9bd80d8c90f3d59e700832f973a59d52041340f9293d8770c4ed/useful_math_functions_functions-0.1.0.tar.gz",
    "platform": null,
    "description": "# 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![_](https://github.com/Anselmoo/useful-math-functions/blob/main/docs/extra/images/DeJongN5Function.png?raw=true)\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": "",
    "summary": "useful-math-functions for Optimization, Benchmarking, Visualizing, and more ...",
    "version": "0.1.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5c522ce0034891a630309b4ecf095e8e7f105c195011c81560ed5a51884739fe",
                "md5": "9b158fac8b7ab5f84f26818e4a9d1bfe",
                "sha256": "02bd627620b544e277aa7f7542094e3a2d119ef04c4df1025c44b1e47045257c"
            },
            "downloads": -1,
            "filename": "useful_math_functions_functions-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9b158fac8b7ab5f84f26818e4a9d1bfe",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10,<3.12",
            "size": 66692,
            "upload_time": "2023-09-23T20:56:41",
            "upload_time_iso_8601": "2023-09-23T20:56:41.352183Z",
            "url": "https://files.pythonhosted.org/packages/5c/52/2ce0034891a630309b4ecf095e8e7f105c195011c81560ed5a51884739fe/useful_math_functions_functions-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3e197cbae94e9bd80d8c90f3d59e700832f973a59d52041340f9293d8770c4ed",
                "md5": "e6b205f9359074c4ee28cf90da5afc78",
                "sha256": "ad5a23853e9a32b769cd02ac6cd5873527c8c99cbf93a9d872d7e7e4c65d9afc"
            },
            "downloads": -1,
            "filename": "useful_math_functions_functions-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "e6b205f9359074c4ee28cf90da5afc78",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10,<3.12",
            "size": 48927,
            "upload_time": "2023-09-23T20:56:42",
            "upload_time_iso_8601": "2023-09-23T20:56:42.875466Z",
            "url": "https://files.pythonhosted.org/packages/3e/19/7cbae94e9bd80d8c90f3d59e700832f973a59d52041340f9293d8770c4ed/useful_math_functions_functions-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-23 20:56:42",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "useful-math-functions-functions"
}
        
Elapsed time: 0.13376s