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

Included pip & venv based instructions for WSL2 #812

Merged
merged 1 commit into from
Jul 25, 2024
Merged

Conversation

JurgenZach-NOAA
Copy link
Contributor

Possible Cython compile errors in T-route caused by PR784 (#784) have resulted in a recommendation to compile in "no-editable' mode (PR 801, #801). The no-e option, in turn, has resulted in the necessity to recompile T-route after each edit of python code.

The instructions provided here showcase how T-route can be installed in a manner compatible with PR 784 while avoiding the non-editable compile option. It is based on pip and venv, avoiding conda altogether. It has been implemented on WSL, but should be readily adaptable to the same recent long-term stable Ubuntu distros (22.04 and 20.04).

[Short description explaining the high-level reason for the pull request]

Additions

  • Instructions in README file

Removals

Changes

Testing

Screenshots

Notes

Todos

Checklist

  • PR has an informative and human-readable title
  • Changes are limited to a single goal (no scope creep)
  • Code can be automatically merged (no conflicts)
  • Code follows project standards (link if applicable)
  • Passes all existing automated tests
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future todos are captured in comments
  • Visually tested in supported browsers and devices (see checklist below 👇)
  • Project documentation has been updated (including the "Unreleased" section of the CHANGELOG)
  • Reviewers requested with the Reviewers tool ➡️

Testing checklist

Target Environment support

  • Windows
  • Linux
  • Browser

Accessibility

  • Keyboard friendly
  • Screen reader friendly

Other

  • Is useable without CSS
  • Is useable without JS
  • Flexible from small to large screens
  • No linting errors or warnings
  • JavaScript tests are passing

Possible Cython compile errors in T-route caused by PR784 (#784) have resulted in a recommendation to compile in "no-editable' mode (PR 801, #801). The no-e option, in turn, has resulted in the necessity to recompile T-route after each edit of python code. 

The instructions provided here showcase how T-route can be installed in a manner compatible with PR 784 while avoiding the non-editable compile option. It is based on pip and venv, avoiding conda altogether. It has been implemented on WSL, but should be readily adaptable to the same recent long-term stable Ubuntu distros (22.04 and 20.04).
@JurgenZach-NOAA JurgenZach-NOAA self-assigned this Jul 25, 2024
@JurgenZach-NOAA JurgenZach-NOAA merged commit fdea06e into WSL-pip Jul 25, 2024
@JurgenZach-NOAA JurgenZach-NOAA deleted the WSL-pip-1 branch July 25, 2024 00:43
JurgenZach-NOAA added a commit that referenced this pull request Jul 29, 2024
* Included pip & venv based instructions for WSL2 (#812)

Possible Cython compile errors in T-route caused by PR784 (#784) have resulted in a recommendation to compile in "no-editable' mode (PR 801, #801). The no-e option, in turn, has resulted in the necessity to recompile T-route after each edit of python code. 

The instructions provided here showcase how T-route can be installed in a manner compatible with PR 784 while avoiding the non-editable compile option. It is based on pip and venv, avoiding conda altogether. It has been implemented on WSL, but should be readily adaptable to the same recent long-term stable Ubuntu distros (22.04 and 20.04).

* Updated shell formatting

* Update readme.md

* Update readme.md

* Only clone single branch

* Included warning about mixing pip and conda
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.

1 participant