| Name | spotRiver JSON |
| Version |
0.3.3
JSON |
| download |
| home_page | None |
| Summary | spotRiver - Sequential Parameter Optimization Interface to River |
| upload_time | 2024-03-29 16:30:54 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# spotRiver
# 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
## github
* Clone the github repository.
## 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/spotRiver/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 `spotRiver*.tar.gz` file from the `dist` folder for your package installation with `pip`, e.g.;
* `python3 -m pip install ./dist/spotRiver-*.tar.gz`
Raw data
{
"_id": null,
"home_page": null,
"name": "spotRiver",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "\"T. Bartz-Beielstein\" <tbb@bartzundbartz.de>",
"download_url": "https://files.pythonhosted.org/packages/8b/02/fb650b060451b8ce0190fbd379ed25246d02826da2cf290ae869db931b24/spotRiver-0.3.3.tar.gz",
"platform": null,
"description": "# spotRiver\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## github\n\n* Clone the github repository.\n\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/spotRiver/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 `spotRiver*.tar.gz` file from the `dist` folder for your package installation with `pip`, e.g.;\n * `python3 -m pip install ./dist/spotRiver-*.tar.gz`\n",
"bugtrack_url": null,
"license": null,
"summary": "spotRiver - Sequential Parameter Optimization Interface to River",
"version": "0.3.3",
"project_urls": {
"Homepage": "https://www.spotseven.de"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "08f700de298b3a0574e31da1291518416197aed6466c42615ee41a4c2d5272dd",
"md5": "c5eadd76d6119f70d8bc5c2ff2bdb8e1",
"sha256": "d1a6d933c57e52faa8625be862a9ed3ea966a7725c7161adc98aad1a531930a5"
},
"downloads": -1,
"filename": "spotRiver-0.3.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c5eadd76d6119f70d8bc5c2ff2bdb8e1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 483187,
"upload_time": "2024-03-29T16:30:49",
"upload_time_iso_8601": "2024-03-29T16:30:49.141050Z",
"url": "https://files.pythonhosted.org/packages/08/f7/00de298b3a0574e31da1291518416197aed6466c42615ee41a4c2d5272dd/spotRiver-0.3.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8b02fb650b060451b8ce0190fbd379ed25246d02826da2cf290ae869db931b24",
"md5": "12bdca015dccd01330a1905089d4af3b",
"sha256": "193a963f9520852adae4c2fd61a28df1432eafffa918b766873a9e4b70eb12a6"
},
"downloads": -1,
"filename": "spotRiver-0.3.3.tar.gz",
"has_sig": false,
"md5_digest": "12bdca015dccd01330a1905089d4af3b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 477549,
"upload_time": "2024-03-29T16:30:54",
"upload_time_iso_8601": "2024-03-29T16:30:54.083668Z",
"url": "https://files.pythonhosted.org/packages/8b/02/fb650b060451b8ce0190fbd379ed25246d02826da2cf290ae869db931b24/spotRiver-0.3.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-29 16:30:54",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "spotriver"
}
