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

GARNET as a python package #1

Merged
merged 5 commits into from
Feb 20, 2024
Merged

GARNET as a python package #1

merged 5 commits into from
Feb 20, 2024

Conversation

searscr
Copy link
Contributor

@searscr searscr commented Feb 16, 2024

Short description of the changes:

This PR creates the foundation for installing GARNET as an editable python package.

Long description of the changes:

package has been setup so that

Using:

python -m pip install -e .

GARNET will be installed in your working environment and can be called as

python -m garnet

Or simply,

garnet

to start the application.

Check list for the pull request

  • I have read the [CONTRIBUTING]
  • I have read the [CODE_OF_CONDUCT]
  • I have added tests for my changes
  • I have updated the documentation accordingly

Check list for the reviewer

  • I have read the [CONTRIBUTING]
  • I have verified the proposed changes
  • best software practices
    • all internal functions have an underbar, as is python standard
    • clearly named variables (better to be verbose in variable names)
    • code comments explaining the intent of code blocks
  • All the tests are passing
  • The documentation is up to date
  • code comments added when explaining intent

Manual test for the reviewer

References

@searscr searscr requested a review from mpatrou February 16, 2024 17:59
@searscr searscr mentioned this pull request Feb 20, 2024
13 tasks
Copy link
Collaborator

@mpatrou mpatrou left a comment

Choose a reason for hiding this comment

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

garnet is installed with pip locally.

@searscr searscr merged commit ba7f0d6 into next Feb 20, 2024
1 check passed
@searscr searscr deleted the ewm3833 branch February 20, 2024 14:22
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.

2 participants