Skip to content

Renaming the package#392

Merged
davidorme merged 13 commits intodevelopfrom
391-rename-the-package
Feb 29, 2024
Merged

Renaming the package#392
davidorme merged 13 commits intodevelopfrom
391-rename-the-package

Conversation

@davidorme
Copy link
Copy Markdown
Collaborator

Description

This PR implements #391:

  • Code references changed (both imports and sphinx references)
  • Text references to rainforest in docs and docstrings updated.
  • Package directory moved.
  • vr_run function renamed to ve_run. For some reason, I don't like that name, but we can fix that later!
  • RTD set up to build the branch to preview: https://virtual-rainforest.readthedocs.io/en/391-rename-the-package/

Still to do:

  • Rename the repo.
  • Update other repos
  • Update the RTD settings to build to the new website name
  • Publish a draft package version to occupy the namespace on PyPi

Fixes #391

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 Feb 21, 2024 that may be closed by this pull request
4 tasks
@davidorme
Copy link
Copy Markdown
Collaborator Author

Oh great. #390 has started affecting the Mac OS runners.

Copy link
Copy Markdown
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.

LGTM. Just a few minor comments.
Thanks for the huge effort! Quite cool to see ow much code we have created over the last two years :-)

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Feb 26, 2024

Codecov Report

Attention: Patch coverage is 96.21622% with 7 lines in your changes are missing coverage. Please review.

Project coverage is 93.18%. Comparing base (8220f21) to head (6677c7a).

Files Patch % Lines
virtual_ecosystem/entry_points.py 91.66% 1 Missing ⚠️
...le_data/generation_scripts/climate_example_data.py 0.00% 1 Missing ⚠️
..._data/generation_scripts/elevation_example_data.py 0.00% 1 Missing ⚠️
...ple_data/generation_scripts/litter_example_data.py 0.00% 1 Missing ⚠️
...mple_data/generation_scripts/plant_example_data.py 0.00% 1 Missing ⚠️
...ple_data/generation_scripts/runoff_example_data.py 0.00% 1 Missing ⚠️
...ample_data/generation_scripts/soil_example_data.py 0.00% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #392   +/-   ##
========================================
  Coverage    93.18%   93.18%           
========================================
  Files           60       60           
  Lines         2920     2920           
========================================
  Hits          2721     2721           
  Misses         199      199           

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

Copy link
Copy Markdown
Collaborator

@TaranRallings TaranRallings left a comment

Choose a reason for hiding this comment

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

LGTM!

We have written quite a bit of code!

@davidorme davidorme merged commit 468ee55 into develop Feb 29, 2024
@davidorme davidorme deleted the 391-rename-the-package branch July 5, 2024 09:19
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.

Rename the package

4 participants