Expand description
Spectator is a GUI tool to observe the progress of an optimization run.
The data is transferred to spectator by the argmin observer
argmin-observer-spectator.
§Installation
The preferred way is to install directly from crates.io:
cargo install spectator --locked
Alternatively, one can clone the repo and install/run from there:
git clone https://github.com/argmin-rs/argmin.git
cd argmin
# Compile and run from the repo...
cargo build -p spectator --release
./target/release/spectator
# .. or directly run from the repo...
cargo run -p spectator --release
# ... or install locally
cargo install -p spectator
spectator
§Usage
spectator --host 127.0.0.1 --port 5498
The optional options --host and --port indicate the host and port spectator binds to.
By default, spectator will bind to 0.0.0.0:5498.
§Library
This crate can also be used as a library and exposes the Message type used to encode data
sent to specator and DEFAULT_PORT which defines the default port used by spectator.
§License
Licensed under either of
- Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT License (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
§Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
Enums§
- Enum used to encode information sent to spectator.
Constants§
- Default port used by spectator