Create DEVELOPMENT.md file #1318
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added the getting started and Ersilia Artifacts session
DhanshreeA
requested changes
Oct 13, 2024
| 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.
Then we can ask them to run the test suite as pytest -v
There was a problem hiding this comment.
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.
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.
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 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
-vflag.EOSdirectory within the user's$HOMEpathTo 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