Skip to content

Improve installation documentation for beginner onboarding #125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
shreyadesai20042009 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve installation documentation for beginner onboarding #125

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/source/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,21 @@ The part ``pip install --no-deps -r requirements-without-deps.txt`` is necessary
**Power/fuel consumption framework**

In order to get high-quality results, a suitable power/fuel modelling framework should be used as it is the core of any weather routing optimization. Please check the respective section of our documentation for more information as the installation of dedicated software might be necessary for your application.

## What to Do After Installation

After completing the installation steps above, you can verify that the
WeatherRoutingTool is installed correctly and start exploring its functionality.

### Verify the Installation

Make sure your virtual environment is activated, then run:

```bash
python -m WeatherRoutingTool.cli --help

If the installation was successful, this command will display the available
command-line options.
If example scripts are available, you can run one to ensure everything works:

python examples/basic_example.py