| Name | spotPython JSON |
| Version |
0.0.18
JSON |
| download |
| home_page | |
| Summary | spotPython - Sequential Parameter Optimization in Python |
| upload_time | 2023-03-26 11:12:25 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.10 |
| license | AGPL-3.0-or-later |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# spotPython
Sequential Parameter Optimization in Python
# Development
## Styleguide
Follow the Google Python Style Guide from [https://google.github.io/styleguide/pyguide.html]([https://google.github.io/styleguide/pyguide.html).
## Pre commit checks
Before you commit your code, please check that it is "clean".
To do so, first run [`black`](https://github.com/psf/black) from the projects root directory:
```
$ black .
```
Next, check if [`flake8`](https://flake8.pycqa.org/en/latest/) shows any errors:
```
$ flake8
```
Fix any shown errors before you commit.
# Installation
`pip install spotPython`
## Python
* Mac Users: Install [brew](https://brew.sh/index_de)
* `brew install python` and `brew install graphviz` etc.
* Generate and activate a virtual environment, see [venv](https://docs.python.org/3/library/venv.html), e.g.,
* `cd ~; python3 -m venv .venv`
* `source ~/.venv/bin/activate`
### Python mkdocs
* `python -m pip install mkdocs mkdocs-gen-files mkdocs-literate-nav mkdocs-section-index mkdocs-material`
* `mkdocs build`
* `mkdocs serve`
* `http://127.0.0.1:8000/`
### Optimizing/Profiling Code
* [scipy lecture notes: optimizing code](https://scipy-lectures.org/advanced/optimizing/index.html)
https://scipy-lectures.org/advanced/optimizing/index.html
## Editor/IDE
* Optional: Install [visualstudio](https://code.visualstudio.com)
* Optional: Install [quarto](https://quarto.org)
## Package Installation
### Configuration Files
* This information is based on [https://packaging.python.org/en/latest/tutorials/packaging-projects/](https://packaging.python.org/en/latest/tutorials/packaging-projects/)
* Information is stored in `pyproject.toml` (`setup.py` is not used anymore.)
* A `src` folder is used for the package sources.
* The following files are used for the package building:
* `pyproject.toml`: see [pyproject.toml](./pyproject.toml).
* Important: Follow the instructions from [https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html](https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html) for including data files (like *.csv, *.tar, etc.). These files can be specified in the following `MANIFEST` file:
* `MANIFEST`: see [MANIFEST](MANIFEST.in). It describes the data files to be included, e.g.:
* `include src/spotPython/data/*.rst`
* `LICENSE`: see [LICENSE](./LICENSE)
### Installation
* Perform the following steps to install the package:
* Make sure you have the latest version of PyPA’s build installed:
* `python3 -m pip install --upgrade build`
* Start the package building process via: `python3 -m build`
* This command should output a lot of text and once completed should generate two files in the `dist` directory.
* You can use the local `spotPython*.tar.gz` file from the `dist` folder for your package installation with `pip`, e.g.;
* `python3 -m pip install ./dist/spotPython-0.0.1.tar.gz`
Raw data
{
"_id": null,
"home_page": "",
"name": "spotPython",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "",
"author": "",
"author_email": "\"T. Bartz-Beielstein\" <tbb@bartzundbartz.de>",
"download_url": "https://files.pythonhosted.org/packages/d6/77/a0133fb65f1f2f43cbf28c24cb80774167239370bf99e76c52b35de72bc2/spotPython-0.0.18.tar.gz",
"platform": null,
"description": "# spotPython\n\nSequential Parameter Optimization in Python\n\n# Development\n\n\n## Styleguide\n\nFollow the Google Python Style Guide from [https://google.github.io/styleguide/pyguide.html]([https://google.github.io/styleguide/pyguide.html).\n\n## Pre commit checks\n\nBefore you commit your code, please check that it is \"clean\". \nTo do so, first run [`black`](https://github.com/psf/black) from the projects root directory:\n\n```\n$ black .\n```\n\nNext, check if [`flake8`](https://flake8.pycqa.org/en/latest/) shows any errors:\n\n```\n$ flake8\n```\n\nFix any shown errors before you commit.\n\n# Installation\n\n`pip install spotPython`\n\n\n## Python\n\n* Mac Users: Install [brew](https://brew.sh/index_de)\n * `brew install python` and `brew install graphviz` etc.\n\n* Generate and activate a virtual environment, see [venv](https://docs.python.org/3/library/venv.html), e.g.,\n * `cd ~; python3 -m venv .venv`\n * `source ~/.venv/bin/activate`\n\n### Python mkdocs\n\n* `python -m pip install mkdocs mkdocs-gen-files mkdocs-literate-nav mkdocs-section-index mkdocs-material`\n* `mkdocs build`\n* `mkdocs serve`\n* `http://127.0.0.1:8000/`\n\n\n### Optimizing/Profiling Code\n\n* [scipy lecture notes: optimizing code](https://scipy-lectures.org/advanced/optimizing/index.html)\n\nhttps://scipy-lectures.org/advanced/optimizing/index.html\n\n## Editor/IDE\n\n* Optional: Install [visualstudio](https://code.visualstudio.com)\n* Optional: Install [quarto](https://quarto.org)\n\n\n## Package Installation\n\n### Configuration Files\n\n* This information is based on [https://packaging.python.org/en/latest/tutorials/packaging-projects/](https://packaging.python.org/en/latest/tutorials/packaging-projects/)\n* Information is stored in `pyproject.toml` (`setup.py` is not used anymore.)\n* A `src` folder is used for the package sources.\n* The following files are used for the package building:\n * `pyproject.toml`: see [pyproject.toml](./pyproject.toml). \n * Important: Follow the instructions from [https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html](https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html) for including data files (like *.csv, *.tar, etc.). These files can be specified in the following `MANIFEST` file:\n * `MANIFEST`: see [MANIFEST](MANIFEST.in). It describes the data files to be included, e.g.:\n * `include src/spotPython/data/*.rst`\n * `LICENSE`: see [LICENSE](./LICENSE)\n\n### Installation\n\n* Perform the following steps to install the package:\n * Make sure you have the latest version of PyPA\u2019s build installed:\n * `python3 -m pip install --upgrade build`\n * Start the package building process via: `python3 -m build` \n * This command should output a lot of text and once completed should generate two files in the `dist` directory.\n * You can use the local `spotPython*.tar.gz` file from the `dist` folder for your package installation with `pip`, e.g.;\n * `python3 -m pip install ./dist/spotPython-0.0.1.tar.gz`\n\n\n",
"bugtrack_url": null,
"license": "AGPL-3.0-or-later",
"summary": "spotPython - Sequential Parameter Optimization in Python",
"version": "0.0.18",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "02e93b84a4305e428bd06889339760c0a01722350df1081a956de341fcba7efb",
"md5": "111961872232df0eced825d2bc63f2e5",
"sha256": "d6754b69cc024169c51810285e32193f783351237aab80a6b138bbf4d46d3d32"
},
"downloads": -1,
"filename": "spotPython-0.0.18-py3-none-any.whl",
"has_sig": false,
"md5_digest": "111961872232df0eced825d2bc63f2e5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 46355,
"upload_time": "2023-03-26T11:12:23",
"upload_time_iso_8601": "2023-03-26T11:12:23.273866Z",
"url": "https://files.pythonhosted.org/packages/02/e9/3b84a4305e428bd06889339760c0a01722350df1081a956de341fcba7efb/spotPython-0.0.18-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d677a0133fb65f1f2f43cbf28c24cb80774167239370bf99e76c52b35de72bc2",
"md5": "7198bed0a41b1c90bd63441eb24723a4",
"sha256": "e9377e9f46d697de75d19457d0d8e8769273ae70648e1cc3d5fc48874a6d4766"
},
"downloads": -1,
"filename": "spotPython-0.0.18.tar.gz",
"has_sig": false,
"md5_digest": "7198bed0a41b1c90bd63441eb24723a4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 3749872,
"upload_time": "2023-03-26T11:12:25",
"upload_time_iso_8601": "2023-03-26T11:12:25.284917Z",
"url": "https://files.pythonhosted.org/packages/d6/77/a0133fb65f1f2f43cbf28c24cb80774167239370bf99e76c52b35de72bc2/spotPython-0.0.18.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-26 11:12:25",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "spotpython"
}
