Skip to content

Commit

Permalink
docs(WebSite): Update name
Browse files Browse the repository at this point in the history
  • Loading branch information
jourdain committed May 27, 2016
1 parent 5770a5f commit 38e3471
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 15 deletions.
6 changes: 3 additions & 3 deletions documentation/content/docs/contributing.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
title: Contributing
---

We welcome you to join the development of ParaViewWeb - Visualizer. This document will help you through the process.
We welcome you to join the development of ParaView Visualizer. This document will help you through the process.

## Before You Start

Expand Down Expand Up @@ -55,8 +55,8 @@ Please follow the coding style:

## Updating Documentation

The ParaViewWeb Visualizer documentation is part of the code repository.
The ParaView Visualizer documentation is part of the code repository.

## Reporting Issues

When you encounter some problems when using Visualizer, you can find the solutions in [Troubleshooting](troubleshooting.html) or ask me on [GitHub](https://github.com/kitware/visualizer/issues) or [Mailing list](http://www.paraview.org/mailman/listinfo/paraview). If you can't find the answer, please report it on GitHub.
When you encounter some problems when using ParaView Visualizer, you can find the solutions in [Troubleshooting](troubleshooting.html) or ask me on [GitHub](https://github.com/kitware/visualizer/issues) or [Mailing list](http://www.paraview.org/mailman/listinfo/paraview). If you can't find the answer, please report it on GitHub.
15 changes: 7 additions & 8 deletions documentation/content/docs/index.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,26 @@
title: Documentation
---

The ParaViewWeb Visualizer is a Web application that aims to enable scientific visualization
on the Web using a ParaView backend for data processing and rendering.
The ParaView Visualizer is a Web application that aims to enable scientific visualization on the Web using a ParaView backend for data processing and rendering.

If you encounter any problems when using Visualizer, you can find the solutions in [Troubleshooting](troubleshooting.html) or ask me on [GitHub](https://github.com/kitware/visualizer/issues) or [Mailing list](http://www.paraview.org/mailman/listinfo/paraview). If you can't find the answer, please report it on GitHub.
If you encounter any problems when using ParaView Visualizer, you can find the solutions in [Troubleshooting](troubleshooting.html) or ask me on [GitHub](https://github.com/kitware/visualizer/issues) or [Mailing list](http://www.paraview.org/mailman/listinfo/paraview). If you can't find the answer, please report it on GitHub.

## What is ParaViewWeb Visualizer?
## What is ParaView Visualizer?

ParaViewWeb Visualizer is a standalone application that leverage ParaView capabilities on the backend to produce interactive visualizations over the Web. The Visualizer application can be used locally as a command line tool (demo-mode) or remotely when properly deployed.
ParaView Visualizer is a standalone application that leverage ParaView capabilities on the backend to produce interactive visualizations over the Web. The Visualizer application can be used locally as a command line tool (demo-mode) or remotely when properly deployed.

The ParaViewWeb Visualizer aims to provide a ParaView like application for your browser.

## Installation

It only takes few minutes to set up ParaViewWeb Visualizer. If you encounter a problem and can't find the solution here, please [submit a GitHub issue](https://github.com/kitware/visualizer/issues).
It only takes few minutes to set up ParaView Visualizer. If you encounter a problem and can't find the solution here, please [submit a GitHub issue](https://github.com/kitware/visualizer/issues).

```sh
$ npm install -g pvw-visualizer
$ Visualizer --paraview /Applications/paraview.app --data ~/Desktop
```

For production usage, ParaViewWeb Visualizer should be deployed within your Web insfrastructure following the proper requirements:
For production usage, ParaView Visualizer should be deployed within your Web insfrastructure following the proper requirements:

1) Serve the Visualizer application to the client (Static content: JS + HTML) using any kind of Web server (Apache, Nginx, Tomcat, Node...).
2) Enable the client to start a new ParaView process on the server side (Cluster). We provide a generic launcher implementation using Python which could be replaced with something more appropriate to your infrastructure.
Expand All @@ -31,7 +30,7 @@ For better rendering performances, the ParaView server should run on a GPU machi

### Requirements

Installing ParaViewWeb Visualizer as a dependency inside your Web project is quite easy. However, you do need to have a couple of other things installed first:
Installing ParaView Visualizer as a dependency inside your Web project is quite easy. However, you do need to have a couple of other things installed first:

- [Node.js](http://nodejs.org/)
- [Git](http://git-scm.com/)
Expand Down
2 changes: 1 addition & 1 deletion documentation/content/docs/redux.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Visualizer Data Model

Visualizer use **Redux** for managing its internal state which is described below.
ParaView Visualizer use **Redux** for managing its internal state which is described below.

## Global state

Expand Down
2 changes: 1 addition & 1 deletion documentation/content/docs/tools.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
title: Tools
---

ParaViewWeb Visualizer is meant to be an Open Source application for 3D
ParaView Visualizer is meant to be an Open Source application for 3D
Scientific Visualization.

The following guide explain our software process and tools use to
Expand Down
2 changes: 1 addition & 1 deletion documentation/content/docs/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
title: Troubleshooting
---
In case you're experiencing problems with using ParaViewWeb Visualizer, here is a list of solutions to some frequently encountered issues. If this page doesn't help you solve your problem, try doing a search on [GitHub](https://github.com/kitware/visualizer/issues) or our [Mailing list](http://www.paraview.org/mailman/listinfo/paraview).
In case you're experiencing problems with using ParaView Visualizer, here is a list of solutions to some frequently encountered issues. If this page doesn't help you solve your problem, try doing a search on [GitHub](https://github.com/kitware/visualizer/issues) or our [Mailing list](http://www.paraview.org/mailman/listinfo/paraview).
2 changes: 1 addition & 1 deletion documentation/content/index.jade
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ ul#intro-feature-list
i.fa.fa-cloud-download
h3.intro-feature-title
a(href="https://www.npmjs.com/package/pvw-visaulizer").link Releases
p.intro-feature-desc Visualizer is available via npm and should be used via Webpack or Browserify within your project using standard ES6 import syntax for embedded usage.
p.intro-feature-desc ParaView Visualizer is available via npm and should be used via Webpack or Browserify within your project using standard ES6 import syntax for embedded usage.

li.intro-feature-wrap
.intro-feature
Expand Down

0 comments on commit 38e3471

Please sign in to comment.