ImperialCollegeLondon / virtual_ecosystem

This repository is the home for the codebase for the Virtual Ecosystem project.
https://virtual-ecosystem.readthedocs.io
BSD 3-Clause "New" or "Revised" License
8 stars 1 forks source link

Add the demo run to the website pages #428

Closed davidorme closed 3 months ago

davidorme commented 3 months ago

Description

This adds a new page to the docs that contains the current simple walkthrough of running the model. It fixes a couple of minor sphinx issues along the way.

See: https://virtual-ecosystem.readthedocs.io/en/426-add-a-demo-run-to-the-website-pages/virtual_ecosystem/virtual_ecosystem_in_use.html

Closes #426

Type of change

Key checklist

Further checks

codecov-commenter commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 94.68%. Comparing base (13af7ac) to head (b508176).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## develop #428 +/- ## =========================================== + Coverage 94.52% 94.68% +0.16% =========================================== Files 70 70 Lines 3744 3744 =========================================== + Hits 3539 3545 +6 + Misses 205 199 -6 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

davidorme commented 3 months ago

Yeah - there's no way to generate this dynamically on request. We'd need a live jupyter server running an instance - which we could do but probably not now 😄

jacobcook1995 commented 3 months ago

Yeah that definitely feels like overkill for this PR

davidorme commented 3 months ago

Yeah that definitely feels like overkill for this PR

I think it's probably as simple as using Binder? https://mybinder.org/