-
-
Notifications
You must be signed in to change notification settings - Fork 145
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
Create DEVELOPMENT.md file #1318
base: master
Are you sure you want to change the base?
Conversation
Added the getting started and Ersilia Artifacts session
ersilia -v fetch eos2ta5 #fetch a model | ||
ersilia serve eos2ta5 #serve a model | ||
ersilia -v api run -i "CCCC" #run a model | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Then we can ask them to run the test suite as pytest -v
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @DhanshreeA. I intend to add the run test suites in the "Creating of Pull Request" section.
DEVELOPMENT.md
Outdated
- Open the terminal in codespace. To ensure you are in the root directory | ||
`cd ersilia` | ||
- Run this command | ||
`pip install -e .` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You don't exactly need to do that I think, the environment is prepared with ersilia installed. But we should double check.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, you are right. ersilia is pre-installed and ready to use. To double check, i will add using ersilia --version
in the documentation.
Thanks for the suggestion.
Hi @DhanshreeA. Thanks for the suggestions. All necessary changes has been implemented |
Thank you for taking your time to contribute to Ersilia, just a few checks before we proceed
Description
Currently, Ersilia doesn't have a DEVELOPMENT.md file in the repository. The main aim is to create a DEVELOPMENT.md instruction file
Changes to be made
Add a development .md file in ersilia repository
Status
-v
flag.EOS
directory within the user's$HOME
pathTo do
Add "Create a Pull Request" section
Is this pull request related to any open issue? If yes, replace issueID below with the issue ID
Related to #1270