Skip to content
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.

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

Add the demo run to the website pages #428

Merged
merged 7 commits into from
Jun 5, 2024

Conversation

davidorme
Copy link
Collaborator

@davidorme davidorme commented Jun 4, 2024

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

  • New feature (non-breaking change which adds functionality)
  • Optimization (back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)

Key checklist

  • Make sure you've run the pre-commit checks: $ pre-commit run -a
  • All tests pass: $ poetry run pytest

Further checks

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

@davidorme davidorme linked an issue Jun 4, 2024 that may be closed by this pull request
@codecov-commenter
Copy link

codecov-commenter commented Jun 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

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

Additional details and impacted files
@@             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     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@jacobcook1995 jacobcook1995 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Only comment is that it isn't as engrossing as the live demo as it doesn't run while you watch it, but I'm guessing that isn't straightforward to setup the docs to do.

@davidorme
Copy link
Collaborator Author

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
Copy link
Collaborator

Yeah that definitely feels like overkill for this PR

Copy link
Collaborator

@vgro vgro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, a few small comments regarding the input data.

@davidorme
Copy link
Collaborator Author

Yeah that definitely feels like overkill for this PR

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

davidorme and others added 2 commits June 5, 2024 09:15
Co-authored-by: vgro <44095758+vgro@users.noreply.github.com>
@davidorme davidorme merged commit 0ccb1c7 into develop Jun 5, 2024
9 checks passed
@davidorme davidorme deleted the 426-add-a-demo-run-to-the-website-pages branch June 5, 2024 09:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a demo run to the website pages
4 participants