-
Notifications
You must be signed in to change notification settings - Fork 26
Add a section on how to run a development instance of EasyBuild #260
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
Open
gkaf89
wants to merge
1
commit into
easybuilders:develop
Choose a base branch
from
gkaf89:feature/run-local-instance
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
Original file line number | Diff line number | Diff line change | ||||||
---|---|---|---|---|---|---|---|---|
|
@@ -266,6 +266,41 @@ git checkout develop | |||||||
git pull upstream develop | ||||||||
``` | ||||||||
|
||||||||
##### Running your development instance {: #running_your_development_instance } | ||||||||
|
||||||||
To run your development instance locally access to a copy of the | ||||||||
[easybuild-easyblocks](https://github.com/easybuilders/easybuild-easyblocks) and | ||||||||
the [easybuild-easyconfigs](https://github.com/easybuilders/easybuild-easyconfigs) | ||||||||
repositories is required. Assuming that you have cloned `easybuild-framework`, | ||||||||
`easybuild-easyblocks`, and `easybuild-easyconfigs` repositories in the safe | ||||||||
directory, say `EasyBuild`, your directory structure should resemble the | ||||||||
following: | ||||||||
|
||||||||
``` | ||||||||
EasyBuild | ||||||||
| | ||||||||
+- easybuild-framework | ||||||||
+- easybuild-easyblocks | ||||||||
+- easybuild-easyconfigs | ||||||||
``` | ||||||||
|
||||||||
To run the development instance, you need to add the framework and easyblocks | ||||||||
directories in the Python path, and the easyconfigs in the robot search path. | ||||||||
|
||||||||
You can also define the `PYTHONPATH` in inline format: | ||||||||
|
||||||||
```bash | ||||||||
PYTHONPATH=/path/to/EasyBuild/easybuild-framework:/path/to/EasyBuild/easybuild-easyblocks:${PYTHONPATH} /path/to/EasyBuild/easybuild-framework/eb --dry-run --robot=/path/to/EasyBuild/easybuild-easyconfigs/easybuild/easyconfigs ReFrame-4.3.3.eb | ||||||||
``` | ||||||||
|
||||||||
For convenience, you can define an alias for the development instance of | ||||||||
EasyBuild as follows: | ||||||||
|
||||||||
```bash | ||||||||
alias eb="PYTHONPATH=/path/to/EasyBuild/easybuild-framework:/path/to/EasyBuild/easybuild-easyblocks:${PYTHONPATH} /path/to/EasyBuild/easybuild-framework/eb --robot-paths=/path/to/EasyBuild/easybuild-easyconfigs/easybuild/easyconfigs:" | ||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Rather than suggest to shadow the |
||||||||
``` | ||||||||
|
||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||
|
||||||||
### Opening a new pull request {: #contributing_creating_pull_requests } | ||||||||
|
||||||||
!!! note | ||||||||
|
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.
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.