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.

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

Jump to bottom

Update readme instructions #30

Merged
merged 5 commits into from
Jan 22, 2025
Merged

Update readme instructions #30

merged 5 commits into from
Jan 22, 2025

Conversation

iantei
Copy link
Contributor

@iantei iantei commented Jan 21, 2025 •
edited
Loading

  • Update the following in the README.md for Quick Start code:
    • Change the data frame columns from miles to distance and grade_dec to grade_percent
  • Update the following for Instructions.md:
    • Updated instructions to use pip3 in case pip command is missing
    • Instruction to create a conda virtual environment for Rust Smartcore
  • Update the project version to rust/pyproject.toml to 1.1.1

iantei added 4 commits January 18, 2025 11:51
@iantei
Update Quick Start Code in RREADME.md. Replace miles and grade_dec wi…
5b807c3 
…th distance and grade_percent to adhere to the new model.
@iantei
Updated instruction with pip3
2a61ebc
@iantei
1. Use pip3 if pip is missing. 2. Use conda virtual environment for R…
5e24593 
…ust Smartcore, since maturin develop release command requires either virtualenv or conda environment.
@iantei
Add project version to rust/pyproject.toml
153c153
@iantei iantei marked this pull request as ready for review January 21, 2025 17:25
nreinicke
nreinicke requested changes Jan 22, 2025
View reviewed changes
Copy link
Collaborator

@nreinicke nreinicke left a comment

Choose a reason for hiding this comment

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

This looks great! I just left a small suggestion to update the example grade value to be in the correct percent units. Thanks for making these changes.

nreinicke
nreinicke approved these changes Jan 22, 2025
View reviewed changes
Copy link
Collaborator

@nreinicke nreinicke left a comment

Choose a reason for hiding this comment

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

Great, thanks!

@nreinicke nreinicke merged commit 9a8f4f8 into NREL:main Jan 22, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nreinicke nreinicke nreinicke approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@iantei @nreinicke