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.99.tar.gz
(470.5 kB
view hashes)
Built Distribution
spotRiver-0.0.99-py3-none-any.whl
(477.5 kB
view hashes)
Close
Hashes for spotRiver-0.0.99-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d654bc4f139d063e21ec4520ef7618a6490040fd3f4058e613ee0fa3c9a22301 |
|
MD5 | 145605a509d9c3ec7fb00ec427331207 |
|
BLAKE2b-256 | ca88ddefd577e2561595c1a09c174de96705cdc0e9ce0b221fdd59745caee980 |