README improvements for first time users #65
Conversation
The steps required to get ginan running the first time were out of order. These changes move the data downloads to the getting started section, remove some old instructions and introduce some more detailed instructions for docker.
Simplifies the first time user experience so that they do not need to find these settings if they do not have mongodb running.
|
|
||
| mongo: # Mongo is a database used to store results and intermediate values for later analysis and inter-process communication | ||
|
|
||
| enable: primary # Enable and connect to mongo database {none,primary,secondary,both} |
There was a problem hiding this comment.
Mongo is required for running Ginan in real-time so this will need to stay as is
| process: true | ||
|
|
||
| mongo: | ||
| enable: primary |
There was a problem hiding this comment.
SNR recording goes into the Mongo database, so this will need to stay as is
|
|
||
|
|
||
| mongo: | ||
| enable: primary |
There was a problem hiding this comment.
I haven't run this example, but may need mongo to do precise orbit determination (I'll let others comment on this)
|
|
||
|
|
||
| mongo: | ||
| enable: primary |
There was a problem hiding this comment.
Same as the pod example below, not sure if Mongo is needed on this. If not, happy to not have mongo enabled
| You can quickly download a ready-to-run Ginan environment using docker by running: | ||
|
|
||
| mkdir ginan-data | ||
| docker run -it -v ginan-data:/data gnssanalysis/ginan:v3.0.0 bash |
There was a problem hiding this comment.
This works locally for me when I have sudo out the front. An additional line on that below would be good to inform users that may have trouble getting it started
|
|
||
| ```bash | ||
| cd inputData/data | ||
| ./getData.sh |
There was a problem hiding this comment.
These scripts will download into the /ginan directory, which is not mapped to the local machine (and therefore will disappear once the terminal is closed).
This may be ok for the inputs if that's what we want, but the output directory also points at locations within /ginan.
Just a note to the user in the README would be fine at this point, but we may want to change this a bit so that outputs go to the ginan-data directory that you've created.
2 participants
I went through the README from scratch on a Windows machine to check if the order of the instructions made sense. This PR is proposing to reorder parts of the README so that everything that a first time user needs to get ginan running is in one spot.
mkdir ginan-datahas been added in the docker instructions so that a user does not encounter an error that ${host_data_folder} does not exist