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.

Sign up for GitHub

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

Renamed README file to indicate markdown #2

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Renamed README file to indicate markdown #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
192e8d9
Renamed README file to indicate markdown
plnordquist Sep 17, 2017
6f4c3ad
Changed assembly to track new readme file name
plnordquist Sep 17, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 27 additions & 27 deletions README → README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
# Prosser Usage
The `prosser-api.jar` is an executable jar that can compile and write out your
experiment to its constituent files. Usage is below:
java -jar prosser-api.jar <path to java file> <output path>
There are two example java files in this bundle, `ExperimentFncsTest.java` and
`TestSeanZExperiment.java`. `TestSeanZExperiment.java` is a GridLabD only
experiment that was our first test of the GridLabD parts of Prosser.
`ExperimentFncsTest.java` is a full experiment that generates GridLabD and NS-3
files. FNCS file generation is currently unimplemented. An example of usage
is below:
1. Open a command prompt or shell in the folder with all of these files
2. Run `java -jar prosser-api.jar ExperimentFncsTest.java out`
3. This will compile the `ExperimentFncsTest.java` and put the results in the
`out` folder
You must run the command with a Java Development Kit (JDK) in order for the
compilation to work. Most of the time `java` is linked to a Java Runtime
Environment (JRE). All of the code has been compiled with Java 8 so you will
need to have a Java 8 JDK in order to run this command. In my case on Windows,
I had to run the command with `"C:\Program Files\Java\jdk1.8.0_31\bin\java.exe"`
The `prosser-api-javadoc.jar` is a zip file that contains the Prosser javadoc
that you can use when developing your own Experiment.
# Prosser Usage

The `prosser-api.jar` is an executable jar that can compile and write out your
experiment to its constituent files. Usage is below:

java -jar prosser-api.jar <path to java file> <output path>

There are two example java files in this bundle, `ExperimentFncsTest.java` and
`TestSeanZExperiment.java`. `TestSeanZExperiment.java` is a GridLabD only
experiment that was our first test of the GridLabD parts of Prosser.
`ExperimentFncsTest.java` is a full experiment that generates GridLabD and NS-3
files. FNCS file generation is currently unimplemented. An example of usage
is below:

1. Open a command prompt or shell in the folder with all of these files
2. Run `java -jar prosser-api.jar ExperimentFncsTest.java out`
3. This will compile the `ExperimentFncsTest.java` and put the results in the
`out` folder

You must run the command with a Java Development Kit (JDK) in order for the
compilation to work. Most of the time `java` is linked to a Java Runtime
Environment (JRE). All of the code has been compiled with Java 8 so you will
need to have a Java 8 JDK in order to run this command. In my case on Windows,
I had to run the command with `"C:\Program Files\Java\jdk1.8.0_31\bin\java.exe"`

The `prosser-api-javadoc.jar` is a zip file that contains the Prosser javadoc
that you can use when developing your own Experiment.
2 changes: 1 addition & 1 deletion src/main/assembly/bin.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<source>target/${project.build.finalName}-javadoc.jar</source>
</file>
<file>
<source>README</source>
<source>README.md</source>
</file>
<file>
<source>src/test/java/TestSeanZExperiment.java</source>
Expand Down