search

Bugmark-Simulator / bugmark_simulation

A simulator for Bugmark to run experiments
Mozilla Public License 2.0
2 stars 1 forks source link

Create Documentation #21

Open GeorgLink opened 6 years ago

GeorgLink commented 6 years ago

We want to fulfill the requirements for The Journal of Open Source Software https://joss.theoj.org/about

We can start with:

GeorgLink commented 6 years ago

We might want to do #22 first, so that we don't have to update links throughout the docs later.

GeorgLink commented 6 years ago

Suggestion for

How to Install

  1. Set up a Bugmark development environment on a server or VM: https://github.com/Bugmark-Simulator/exchange/blob/master/notes/devenv.md
  2. On the server, go to src directory: cd ~/src
  3. Git clone the Bugmark Simulator: git clone <insert url to repo>
  4. Create .env setting file cd bugmark_simulation/exercise/simulation; cp .env-default .env
  5. Check which directory the .env links to and change if desired, then create that directory cd ~; mkdir trial; cd trial; mkdir simulation; cd ~/src
  6. Run script work_queue_table_scr to create work queue table ./bugmark_simulation/exercises/script/work_queue_table_scr
  7. Start the Bugmark Simulator ./bugmark_simulation/exercises/simulation/webapp/run
vinodkahuja commented 6 years ago

For this, we have to install a fresh copy on a VM and test over it and document each step. Since we have new github repo I would suggest we open all issues onwards over there.

GeorgLink commented 6 years ago

Good idea to start fresh. I will delete my VM and start over.

GeorgLink commented 6 years ago

I started on a fresh VM and got through the install. But I cannot start the simulator.

I remember we had this issue before, but I don't remember how to solve it.

@vinodahujauno ideas?

image

vinodkahuja commented 6 years ago

I think there are some setting files which needs to be placed and Andy has not kept them in the GitHub due to information secrecy like emails and other things.

Other then this I have no clue.

On Wed, Jun 27, 2018 at 8:50 AM, Georg J.P. Link notifications@github.com wrote:

I started on a fresh VM and got through the install. But I cannot start the simulator.

I remember we had this issue before, but I don't remember how to solve it.

@vinodahujauno https://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_vinodahujauno&d=DwMFaQ&c=Cu5g146wZdoqVuKpTNsYHeFX_rg6kWhlkLF8Eft-wwo&r=uuEPpUZhZPku7npCczAKiv8Rovz29zAuhtZXL3gDsks&m=m2n8ajypX8RiPRZ87WQb20DCQc5P_7fXiNXU2uOuQnQ&s=3zNe2reTM_90w6uF01ZlrlW9_DaWQoL0lDr90HOUVEY&e= ideas?

[image: image] https://urldefense.proofpoint.com/v2/url?u=https-3A__user-2Dimages.githubusercontent.com_8862021_41978228-2D008ec772-2D79e7-2D11e8-2D92bd-2D79062189bfd5.png&d=DwMFaQ&c=Cu5g146wZdoqVuKpTNsYHeFX_rg6kWhlkLF8Eft-wwo&r=uuEPpUZhZPku7npCczAKiv8Rovz29zAuhtZXL3gDsks&m=m2n8ajypX8RiPRZ87WQb20DCQc5P_7fXiNXU2uOuQnQ&s=-blo6KaL9XdS6ox0TLQYZ4fIH7nOSZJs7FNdEMmsysk&e=

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_Bugmark-2DSimulator_bugmark-5Fsimulation_issues_21-23issuecomment-2D400678554&d=DwMFaQ&c=Cu5g146wZdoqVuKpTNsYHeFX_rg6kWhlkLF8Eft-wwo&r=uuEPpUZhZPku7npCczAKiv8Rovz29zAuhtZXL3gDsks&m=m2n8ajypX8RiPRZ87WQb20DCQc5P_7fXiNXU2uOuQnQ&s=j8jvnoi9IOl7qVTeVIOGJsrqppUEdCfeaIHKrumPupE&e=, or mute the thread https://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_notifications_unsubscribe-2Dauth_AYSdUz9ssOneTp5vkv-5FORepG7gDCXppUks5uA42agaJpZM4U4oEe&d=DwMFaQ&c=Cu5g146wZdoqVuKpTNsYHeFX_rg6kWhlkLF8Eft-wwo&r=uuEPpUZhZPku7npCczAKiv8Rovz29zAuhtZXL3gDsks&m=m2n8ajypX8RiPRZ87WQb20DCQc5P_7fXiNXU2uOuQnQ&s=Ggt82uCmaFNgdoh1xYNQB21O24pgmuFZASg2OADBOIQ&e= .

-- Vinod Kumar Ahuja Graduate Assistant | Management Information Systems | UNO Vice President | Management Information Systems Student Organization (MISSO)

Ph: 531-205-8338 | E-mail: vahuja@unomaha.edu

GeorgLink commented 6 years ago

I spoke with Andy and extended above description.

I ran the installation front to back today and I think we can use it as is.

vinodkahuja commented 6 years ago

run script work_que_table_scr to create work que table

GeorgLink commented 6 years ago

@vinodahujauno please put this issue top of list and start compiling this information. It may change over time, but we need this and it will get harder to create if we wait longer.

vinodkahuja commented 6 years ago

Setup instruction done