Merge pull request #12 from WildMeOrg/scout-install-rework

Scout install rework

docs/contribute/dev-setup.md

@@ -22,8 +22,26 @@ The following instructions are for once you've made changes to your local forked
 1. Check your work! Use your browser to access `localhost:1337` and see if your changes are working as desired.
 1. Continue making changes or create your [PR](pr-workflow.md).
 
-### Alternative run commands
-If you are doing development work on a feature that is not impacted by image availability or ML results, you can run without GPU support.
+### Run without GPU
+If you are doing development work on a feature that is not impacted by image availability or ML results, you can go from [storage setup](../setup-and-maintenance//server-system-setup.md#storage) to setting up your code repo.
 ```
 docker run --privileged -p 1337:1337 --rm -it --mount type=bind,source=/data,target=/data -e ENV_IP="`ip route get 1 | sed 's/^.*src \([^ ]*\).*$/\1/;q'`" -v /data/scout_data:/data/db -v /data/scout/tmp:/tmp/scout-tmp yourimage:latest
 ```
+## Run image that includes data
+
+To simplify development, we have provided a Docker image that comes pre-loaded with image data and tasks. Example images are from the [WAID dataset from Applied Sciences](https://github.com/xiaohuicui/WAID/).
+
+Note that this version of Scout does not include Scoutbot and therefore does not require a GPU to function. This also means, however, that it cannot process images with ML classifiers.
+
+#### One time setup
+From root of the code directory (`/scout`), run `npm install` to make sure all necessary libraries are installed.
+
+#### Usage
+1. `cd` to the `/develop-with-data` directory
+1. Run `docker-compose up` to fetch that docker image and run Scout.
+1. Once running, use a browser to open http://localhost:1337
+1. Login with `admin`/`admin` as username/password.
+
+#### Troubleshooting
+- If you encounter a docker error `urllib3.exceptions.URLSchemeUnknown: Not supported URL scheme http+docker`, try running `pip install requests=2.31.0`
+- If your process fails, you should run `docker-compose down` to stop the container when you shut down your scout instance (`Ctrl+C`)

docs/contribute/roadmap.md

@@ -1,9 +1,24 @@
 # Roadmap
-The roadmaps below are rough outlines of our objectives. We operate by milestones, and sometimes things change dramatically because of technical limitations or pressing issues reported by users.
+The roadmaps below are rough outlines of our objectives. We operate by milestones, and sometimes things change dramatically because of technical limitations or pressing issues reported by users. Because Scout started as a tool to support a single project, We are working to broaden the usage by making it a more generalized tool. We want to improve the workflow management and annotation interface.
 
-## Scout
-Because Scout started as a tool to support a single project, We are working to broaden the usage by making it a more generalized tool. We want to improve the workflow management and annotation interface.
+## 2.5.0
+- Point annotations
+- Clean up annotation interface 
+- Task review that doesn't set ground truth
+- New filter: random subset of images
 
-### 2.2.0
+## 2.6.0
+- Automated overlap detection
+- Grouping of tasks into projects
+- Annotator time spent
+- Annotator performance export
 
-### 2.3.0
+## General Goals
+We have general objectives that we need to address eventually, but have no specific timeframe. If you're interested in working on something in this list, let us know!
+- Video tracking
+- Visualization of survey track
+- Visualization of static locations over time (ex. change in tree health)
+- Performance improvements are always welcome
+- Text localization
+- Simplify docker install
+- `dmg` or `exe` installation available for additional OS support

docs/setup-and-maintenance/index.md

@@ -2,7 +2,8 @@
 
 Scout is an early stage product where we are working to improve on the installation and usage processes. That being said, for the best experience with setting up Scout, we recommend system administrators have experience with their given operating system and have familiarity with working from the console.
 
-Ideal setup for Scout includes enough space for high volumes of imagery, such as a NAS, and a system with powerful Nvidia GPU. Scout runs on Linux and Mac, but primary development is on Ubuntu.
+Ideal setup for Scout includes enough space for high volumes of imagery, such as a NAS, and a system with powerful Nvidia GPU. 
+All development and installation instructions provided are for Linux. Wild Me does not guarantee support for any other operating system.
 
 ## System Requirements