TACC-Cloud · duckonomy · Jun 21, 2022 · Jun 21, 2022 · Jun 21, 2022 · Jun 27, 2022
diff --git a/docs/Dockerfile b/docs/Dockerfile
@@ -0,0 +1,32 @@
+FROM python:3.8-alpine
+
+# Set build directory
+WORKDIR /tmp
+
+# Copy files necessary for build
+# COPY material material
+# COPY MANIFEST.in MANIFEST.in
+# COPY package.json package.json
+# COPY README.md README.md
+COPY requirements.txt requirements.txt
+# COPY setup.py setup.py
+
+# Perform build and cleanup artifacts
+RUN apk add --no-cache \
+    git curl \
+    && apk add --no-cache --virtual .build gcc musl-dev \
+    && pip install --user -r requirements.txt \
+    && apk del .build gcc musl-dev \
+    && rm -rf /tmp/*
+
+ENV PATH=$PATH:/root/.local/bin
+# Set working directory
+
+WORKDIR /docs
+
+# Expose MkDocs development server port
+EXPOSE 8000
+
+# Start development server by default
+ENTRYPOINT ["mkdocs"]
+CMD ["serve", "--dev-addr=0.0.0.0:8000"]
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,14 @@
+DOCKER_IMAGE=taccaci/hazmapper-docs
+
+.PHONY: build
+build:
+	docker build --rm -t $(DOCKER_IMAGE) .
+
+.PHONY: run
+run:
+	docker run --rm -it -p 8000:8000 -v ${PWD}:/docs $(DOCKER_IMAGE)
+
+.PHONY: publish
+publish:
+	docker push $(DOCKER_IMAGE)
+
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,7 @@
+# Running locally
+```
+make build
+make run
+```
+Then navigate to `localhost:8000`.
+
diff --git a/docs/custom_theme/footer.html b/docs/custom_theme/footer.html
@@ -0,0 +1,32 @@
+<footer>
+  {%- block next_prev %}
+  {%- if config.theme.prev_next_buttons_location|lower in ['bottom', 'both']
+        and page and (page.next_page or page.previous_page) %}
+    <div class="rst-footer-buttons" role="navigation" aria-label="{% trans %}Footer Navigation{% endtrans %}">
+      {%- if page.previous_page %}
+        <a href="{{ page.previous_page.url|url }}" class="btn btn-neutral float-left" title="{{ page.previous_page.title }}"><span class="icon icon-circle-arrow-left"></span> {% trans %}Previous{% endtrans %}</a>
+      {%- endif %}
+      {%- if page.next_page %}
+        <a href="{{ page.next_page.url|url }}" class="btn btn-neutral float-right" title="{{ page.next_page.title }}">{% trans %}Next{% endtrans %} <span class="icon icon-circle-arrow-right"></span></a>
+      {%- endif %}
+    </div>
+  {%- endif %}
+  {%- endblock %}
+
+  <hr/>
+
+  <div role="contentinfo">
+    <!-- Copyright etc -->
+    {%- if config.copyright %}
+      <p>{{ config.copyright }}</p>
+    {%- endif %}
+  </div>
+
+  <div role="contentinfo">
+    {%- if config.last_updated %}
+      <p>{{ config.last_updated }}</p>
+    {%- endif %}
+  </div>
+
+  <!-- {% trans mkdocs_link='<a href="https://www.mkdocs.org/">MkDocs</a>', sphinx_link='<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>', rtd_link='<a href="https://readthedocs.org">Read the Docs</a>' %}Built with %(mkdocs_link)s using a %(sphinx_link)s provided by %(rtd_link)s.{% endtrans %} -->
+</footer>
diff --git a/docs/docs/accessing.md b/docs/docs/accessing.md
@@ -0,0 +1,18 @@
+# Accessing Hazmapper
+To access Hazmapper from Designsafe, the user can first navigate to the top menu bar and find *Workspace* (*Fig 1.1*).
+
+<figure><img src="../img/designsafe-toolbar.png" alt="" style="filter:drop-shadow(2px 2px 3px black); width:100%"><figcaption style="padding-top: 20px" align = "center"><b>Fig 1.1</b></figcaption></figure>
+
+From there, the user can hover on the *Workspace* section and select *Tools & Application* (*Fig 1.2*).
+
+<figure style="display: flex; justify-content: center; align-items: center; flex-direction: column"><img src="../img/designsafe-menu.png" alt="" style="filter:drop-shadow(2px 2px 3px black); width:50%"><figcaption style="padding-top: 20px" align = "center"><b>Fig 1.2</b></figcaption></figure>
+
+From the *Tools & Applications* page, the user can navigate to *Hazmapper (2.0)* (*Fig 1.3*) and then *Launch Hazmapper* (*Fig 1.4*).
+
+<figure><img src="../img/designsafe-tools.png" alt="" style="filter:drop-shadow(2px 2px 3px black); width:100%"><figcaption style="padding-top: 20px" align = "center"><b>Fig 1.3</b></figcaption></figure>
+
+<figure><img src="../img/designsafe-launch.png" alt="" style="filter:drop-shadow(2px 2px 3px black); width:100%"><figcaption style="padding-top: 20px" align = "center"><b>Fig 1.4</b></figcaption></figure>
+
+
+
+
diff --git a/docs/docs/assets.md b/docs/docs/assets.md
@@ -0,0 +1,54 @@
+# Supported Asset Types<a id='supported-asset-types'></a>
+
+## Map Associated Assets<a id='map-associated-assets'></a>
+### Media Assets
+Currently, we support the following media assets.
+Note that these assets must have geospatial data (lat/lon) for Hazmapper to properly process and handle them.
+If the image is problematic, Hazmapper should show an error during the import process.
+
+- Image Assets:
+jpeg, jpg, png
+
+- Video Assets:
+mp4, mov, mpeg4, webm
+
+- GeoJSON/Shapefiles
+
+
+### Point Cloud Assets
+Point cloud assets are represented as bounding boxes showing their respective geographic locations.
+
+They can be analyzed further through the Potree Viewer, which shows a 3D model of the point cloud.
+
+### Imported Streetview Assets<a id='imported-streetview-assets'></a>
+These are imported versions of mapillary streetview assets and bound to the map (different from [non-imported streetview assets](assets.md#non-imported-streetview-assets) shown and accessed through the [Streetview panel](interface.md#streetview-panel)).
+
+Thus, they can be shared among users of the map and with those who have access to the public link map if the map has a public version.
+
+### Tile Layers<a id='supported-tile-formats'></a>
+These are tile layers from an external tile server. They are managed through the [Layers panel](interface.md#layers-panel).
+
+Currently, supported formats are:
+
+- TMS
+- WMS
+- ArcGIS Tile Server
+- `.ini` file containing tms/wms information
+- Formats accessible through [Quick Map Services](https://qms.nextgis.com/)
+
+**NOTE**: *Tile layers are not regular Feature Assets (i.e. they do not show up in the assets panel), but they are part of the map and can be shared among collaborators and those with access to the public version of the map.*
+
+<!-- TODO -->
+<!-- #### Shapefiles -->
+
+<!-- #### Overlays -->
+
+<!-- #### Coming Soon -->
+<!-- KML and KMZ (Coming Soon!) -->
+
+
+## Third-party Assets
+
+### Non-imported Streetview Assets<a id='non-imported-streetview-assets'></a>
+These are supported through a Mapillary's tile service. Because these are user-dependent services, they cannot be shared among users of a map. Thus, they must be [imported](interface.md#importing-streetview-assets) as [imported streetview assets](interface.md#imported-streetview-assets)
+
diff --git a/docs/docs/collaboration.md b/docs/docs/collaboration.md
@@ -0,0 +1,11 @@
+# Collaboration
+
+## Shared Maps<a id='shared-maps'></a>
+As briefly mentioned in the [Maps](maps.md) section, maps that are saved in the DesignSafe project will be shared among the [members of the project](interface.md#members-tab).
+These maps will automatically display in the [welcome menu](interface.md#welcome-menu). 
+Because of the connection, the addition/deletion of members is also managed by each corresponding DesignSafe project.
+
+## Public Maps<a id='public-maps'></a>
+Any map can have a public version of the map through the [public tab of the manage panel](interface.md#public-tab). The generated link will be permanent unless the owner of the map makes the map private, or unless the owner of the map deletes the original map.
+
+
diff --git a/docs/docs/img/assets-import-prompt.png b/docs/docs/img/assets-import-prompt.png
diff --git a/docs/docs/img/assets-panel-full.png b/docs/docs/img/assets-panel-full.png
diff --git a/docs/docs/img/assets-panel-import.png b/docs/docs/img/assets-panel-import.png
diff --git a/docs/docs/img/assets-panel.png b/docs/docs/img/assets-panel.png
diff --git a/docs/docs/img/control-bar.png b/docs/docs/img/control-bar.png
diff --git a/docs/docs/img/designsafe-launch.png b/docs/docs/img/designsafe-launch.png
diff --git a/docs/docs/img/designsafe-menu.png b/docs/docs/img/designsafe-menu.png
diff --git a/docs/docs/img/designsafe-save.png b/docs/docs/img/designsafe-save.png
diff --git a/docs/docs/img/designsafe-toolbar.png b/docs/docs/img/designsafe-toolbar.png
diff --git a/docs/docs/img/designsafe-tools.png b/docs/docs/img/designsafe-tools.png
diff --git a/docs/docs/img/filters-panel.png b/docs/docs/img/filters-panel.png
diff --git a/docs/docs/img/layers-panel-add.png b/docs/docs/img/layers-panel-add.png
diff --git a/docs/docs/img/layers-panel-added.png b/docs/docs/img/layers-panel-added.png
diff --git a/docs/docs/img/layers-panel-modified.png b/docs/docs/img/layers-panel-modified.png
diff --git a/docs/docs/img/layers-panel-options.png b/docs/docs/img/layers-panel-options.png
diff --git a/docs/docs/img/layers-panel.png b/docs/docs/img/layers-panel.png
diff --git a/docs/docs/img/layers-prompt-ini.png b/docs/docs/img/layers-prompt-ini.png
diff --git a/docs/docs/img/layers-prompt-manual.png b/docs/docs/img/layers-prompt-manual.png
diff --git a/docs/docs/img/layers-prompt-qms.png b/docs/docs/img/layers-prompt-qms.png
diff --git a/docs/docs/img/layers-prompt-suggestions.png b/docs/docs/img/layers-prompt-suggestions.png
diff --git a/docs/docs/img/manage-panel-map.png b/docs/docs/img/manage-panel-map.png
diff --git a/docs/docs/img/manage-panel-members.png b/docs/docs/img/manage-panel-members.png
diff --git a/docs/docs/img/manage-panel-public-private.png b/docs/docs/img/manage-panel-public-private.png
diff --git a/docs/docs/img/manage-panel-public.png b/docs/docs/img/manage-panel-public.png
diff --git a/docs/docs/img/manage-panel-save.png b/docs/docs/img/manage-panel-save.png
diff --git a/docs/docs/img/manage-public-link.png b/docs/docs/img/manage-public-link.png
diff --git a/docs/docs/img/map-creation-1.png b/docs/docs/img/map-creation-1.png
diff --git a/docs/docs/img/map-creation-2.png b/docs/docs/img/map-creation-2.png
diff --git a/docs/docs/img/map-panel.png b/docs/docs/img/map-panel.png
diff --git a/docs/docs/img/map-point-cloud-click.png b/docs/docs/img/map-point-cloud-click.png
diff --git a/docs/docs/img/map-point-cloud.png b/docs/docs/img/map-point-cloud.png
diff --git a/docs/docs/img/map-points.png b/docs/docs/img/map-points.png
diff --git a/docs/docs/img/map-polygon-info.png b/docs/docs/img/map-polygon-info.png
diff --git a/docs/docs/img/map-polygon.png b/docs/docs/img/map-polygon.png
diff --git a/docs/docs/img/map-start.png b/docs/docs/img/map-start.png
diff --git a/docs/docs/img/map-streetview-asset-empty.png b/docs/docs/img/map-streetview-asset-empty.png
diff --git a/docs/docs/img/map-streetview-asset-viewer.png b/docs/docs/img/map-streetview-asset-viewer.png
diff --git a/docs/docs/img/map-streetview-asset.png b/docs/docs/img/map-streetview-asset.png
diff --git a/docs/docs/img/map-streetview-mapillary-asset-info.png b/docs/docs/img/map-streetview-mapillary-asset-info.png
diff --git a/docs/docs/img/map-streetview-mapillary-asset.png b/docs/docs/img/map-streetview-mapillary-asset.png
diff --git a/docs/docs/img/menu-buttons.png b/docs/docs/img/menu-buttons.png
diff --git a/docs/docs/img/menu-selected.png b/docs/docs/img/menu-selected.png
diff --git a/docs/docs/img/menu.png b/docs/docs/img/menu.png
diff --git a/docs/docs/img/point-clouds-import-prompt.png b/docs/docs/img/point-clouds-import-prompt.png
diff --git a/docs/docs/img/point-clouds-panel-add-asset.png b/docs/docs/img/point-clouds-panel-add-asset.png
diff --git a/docs/docs/img/point-clouds-panel-add.png b/docs/docs/img/point-clouds-panel-add.png
diff --git a/docs/docs/img/point-clouds-panel-empty.png b/docs/docs/img/point-clouds-panel-empty.png
diff --git a/docs/docs/img/point-clouds-panel-with-object.png b/docs/docs/img/point-clouds-panel-with-object.png
diff --git a/docs/docs/img/point-clouds-panel.png b/docs/docs/img/point-clouds-panel.png
diff --git a/docs/docs/img/point-clouds-potree.png b/docs/docs/img/point-clouds-potree.png
diff --git a/docs/docs/img/point-clouds-prompt.png b/docs/docs/img/point-clouds-prompt.png
diff --git a/docs/docs/img/public-map.png b/docs/docs/img/public-map.png
diff --git a/docs/docs/img/streetview-association.png b/docs/docs/img/streetview-association.png
diff --git a/docs/docs/img/streetview-imported-assets.png b/docs/docs/img/streetview-imported-assets.png
diff --git a/docs/docs/img/streetview-linked-assets.png b/docs/docs/img/streetview-linked-assets.png
diff --git a/docs/docs/img/streetview-login-1.png b/docs/docs/img/streetview-login-1.png
diff --git a/docs/docs/img/streetview-login-mapillary-auth.png b/docs/docs/img/streetview-login-mapillary-auth.png
diff --git a/docs/docs/img/streetview-login-organization-1.png b/docs/docs/img/streetview-login-organization-1.png
diff --git a/docs/docs/img/streetview-login-organization.png b/docs/docs/img/streetview-login-organization.png
diff --git a/docs/docs/img/streetview-login-user.png b/docs/docs/img/streetview-login-user.png
diff --git a/docs/docs/img/streetview-mapillary-asset-info-link.png b/docs/docs/img/streetview-mapillary-asset-info-link.png
diff --git a/docs/docs/img/streetview-mapillary-asset-info.png b/docs/docs/img/streetview-mapillary-asset-info.png
diff --git a/docs/docs/img/streetview-mapillary-organization-key.png b/docs/docs/img/streetview-mapillary-organization-key.png
diff --git a/docs/docs/img/streetview-mapillary-user-1.png b/docs/docs/img/streetview-mapillary-user-1.png
diff --git a/docs/docs/img/streetview-mapillary-user-2.png b/docs/docs/img/streetview-mapillary-user-2.png
diff --git a/docs/docs/img/streetview-mapillary-user-organization.png b/docs/docs/img/streetview-mapillary-user-organization.png
diff --git a/docs/docs/img/streetview-panel-1-all.png b/docs/docs/img/streetview-panel-1-all.png
diff --git a/docs/docs/img/streetview-panel-1-buttons.png b/docs/docs/img/streetview-panel-1-buttons.png
diff --git a/docs/docs/img/streetview-panel-1-display.png b/docs/docs/img/streetview-panel-1-display.png
diff --git a/docs/docs/img/streetview-panel-1-publish.png b/docs/docs/img/streetview-panel-1-publish.png
diff --git a/docs/docs/img/streetview-panel-1.png b/docs/docs/img/streetview-panel-1.png
diff --git a/docs/docs/img/streetview-panel-account.png b/docs/docs/img/streetview-panel-account.png
diff --git a/docs/docs/img/streetview-panel-assets-no-display.png b/docs/docs/img/streetview-panel-assets-no-display.png
diff --git a/docs/docs/img/streetview-panel-assets.png b/docs/docs/img/streetview-panel-assets.png
diff --git a/docs/docs/img/streetview-panel-filter.png b/docs/docs/img/streetview-panel-filter.png
diff --git a/docs/docs/img/streetview-panel-log-progress.png b/docs/docs/img/streetview-panel-log-progress.png
diff --git a/docs/docs/img/streetview-panel-log.png b/docs/docs/img/streetview-panel-log.png
diff --git a/docs/docs/img/streetview-publish-prompt.png b/docs/docs/img/streetview-publish-prompt.png
diff --git a/docs/docs/img/streetview-sequence-info-link.png b/docs/docs/img/streetview-sequence-info-link.png
diff --git a/docs/docs/img/streetview-sequence-info.png b/docs/docs/img/streetview-sequence-info.png
diff --git a/docs/docs/index.md b/docs/docs/index.md
@@ -0,0 +1 @@
+# Hazmapper User Guide