spotRiver - Sequential Parameter Optimization Interface to River
Project description
spotRiver
Development
Styleguide
Follow the Google Python Style Guide from 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
from the projects root directory:
$ black .
Next, check if flake8
shows any errors:
$ flake8
Fix any shown errors before you commit.
Installation
github
- Clone the github repository.
Python
-
Mac Users: Install brew
brew install python
andbrew install graphviz
etc.
-
Generate and activate a virtual environment, see venv, 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
https://scipy-lectures.org/advanced/optimizing/index.html
Editor/IDE
- Optional: Install visualstudio
- Optional: Install quarto
Package Installation
Configuration Files
- This information is based on 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.- Important: Follow the instructions from 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. It describes the data files to be included, e.g.:include src/spotRiver/data/*.rst
LICENSE
: see 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 thedist
folder for your package installation withpip
, e.g.; python3 -m pip install ./dist/spotRiver-*.tar.gz
- Make sure you have the latest version of PyPA’s build installed:
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
spotRiver-0.0.61.tar.gz
(33.1 kB
view hashes)
Built Distribution
spotRiver-0.0.61-py3-none-any.whl
(36.5 kB
view hashes)
Close
Hashes for spotRiver-0.0.61-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 51c438a4337b582dc0d5c697f78ce2722ac40cd9f04808f3df840c944134cadd |
|
MD5 | a3f964ca77e18ec8b3cb59a1e3b27bf4 |
|
BLAKE2b-256 | 748074f2ef3bfc7b639c86e3de6dd2f0c5ec89113bfd3d341eef5eae8bd1e211 |