Skip to content

Commit

Permalink
Update docs on projects
Browse files Browse the repository at this point in the history
  • Loading branch information
MartaNascimento committed Jul 5, 2016
1 parent 8282204 commit e4cfc33
Show file tree
Hide file tree
Showing 8 changed files with 35 additions and 1 deletion.
Binary file added docs/_images/ProjectDataset.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/ProjectDirectory.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/ProjectFind.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/ProjectOpen.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/ProjectRestored.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/ProjectSave.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/ProjectTab.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 35 additions & 1 deletion docs/projects.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,38 @@
# Project management

TBD
A PHYLOViZ Project allows users to save their ongoing studies and dynamically update them. It is a time-saving feature when working with large data sets and essential for efficiently sharing results.
Each project includes the data under analysis, results of inference algorithms, visualization serializations and related customizations.

## Saving

Right click on the dataset you would like to save and choose the option _Save as Project_. As you can see we'll save a DataSet that has the isolate data integrated in the visualization.

![project save](./_images/ProjectSave.png)

Finally you can choose where to save your project.
A dialog appears if you are overriding an existing project or creating a new one with a name that was already taken in the chosen directory.

![project directory](./_images/ProjectDirectory.png)

## Loading
Go to _File_ menu and choose _Open Project_.

![project open](./_images/ProjectOpen.png)

The next step is to find the project that you would like to load.
After finding it click on _Open Project_.

![project find](./_images/ProjectFind.png)

This action will open the _Projects Tab_ where you can see your project listed and many others that were previously opened.

![project tab](./_images/ProjectTab.png)

Now for restoring the study just right click on the project and select _Load DataSet_.
This will open the _Dataset's Tab_ with your saved study.

![project dataset](./_images/ProjectDataset.png)

The project is now loaded with all the study that was done before as we can see in the following screenshot. You can check that the isolated data integrated on saving was restored completely.

![project restored](./_images/ProjectRestored.png)

0 comments on commit e4cfc33

Please sign in to comment.