-
Notifications
You must be signed in to change notification settings - Fork 32
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
WIP: Add instructions for creating a course distribution #115
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# Instructions for creating distribution for the OpenDA course | ||
|
||
For use with the OpenDA course a custom OpenDA Windows distribution is created. | ||
|
||
## Requirements | ||
|
||
- OpenDA Win64 build | ||
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. |
||
- Java JRE x64 | ||
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. |
||
- Visual Studio Code portable mode | ||
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. |
||
|
||
## Directory structure | ||
|
||
Create the following directory structure: | ||
|
||
- course_distribution | ||
- openda | ||
- course | ||
- jre | ||
- visual studio code | ||
|
||
## OpenDA build | ||
|
||
|
||
|
||
|
||
## Java JRE | ||
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. |
||
|
||
Download the custom Windows 64 JRE which is created for use with OpenDA from the [Teamcity Build server](https://build.deltares.nl/project.html?projectId=OpenDA_OpenjdkJreBuild_Win64&tab=projectOverview). Unzip the ` openda-jre-windows-*.zip` and copy the contents to ` course_distribution\jre`. Make sure the `jre` directory directly contains the `bin`, `conf`, etc subdirectories. | ||
|
||
## Visual Studio Code portable mode | ||
|
||
Visual Studio Code supports a [Portable mode](https://code.visualstudio.com/docs/editor/portable). This mode enables all data created and maintained by VS Code to live near itself, so it can be moved around across environments. | ||
|
||
Follow the instructions provided by Microsoft on https://code.visualstudio.com/docs/editor/portable. When unzipping Visual Studio Code make sure that target location is `course_distribution\visual studio code`. | ||
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. |
||
|
||
After setup install the following useful extensions (`File -> Preferences -> Extensions`): | ||
|
||
- Log File Highlighter `emilast.logfilehighlighter` | ||
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. |
||
- Rainbow CSV `mechatroner.rainbow-csv` | ||
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. |
||
- Edit csv `janisdd.vscode-edit-csv` | ||
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. |
||
- Data Preview `randomfractalsinc.vscode-data-preview` | ||
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. |
||
- XML `redhat.vscode-xml` | ||
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. |
||
- Python `ms-python.python` | ||
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. |
||
|
||
For the the XML plugin a JRE is required. Configure `xml.java.home` in the Visual Studio Code `settings.json` file like | ||
```json | ||
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.
|
||
{ | ||
"xml.java.home": "..\\jre", | ||
} | ||
``` | ||
In this way we use the JRE that is inside the course distribution. |
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.
_
in a file name