-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'help_7_6_Logan' into help_7_6
- Loading branch information
Showing
67 changed files
with
623 additions
and
359 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
22 changes: 22 additions & 0 deletions
22
vcell-client/UserDocumentation/originalXML/topics/Auth0/Auth0ExistingUserAccountLinking.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
<vcelldoc> | ||
<page title="Auth0 Existing User Account Linking"> | ||
|
||
<introduction> | ||
Users who remember their existing VCell account login can easily access their old account by providing the username | ||
and password of their old VCell account. All the user's existing models, permissions, and old VCell Username will | ||
immediately become available to the user, once the old credentials are input. | ||
</introduction> | ||
|
||
<appearance> | ||
<imgReference target = "ProfileOldLogin.png"/> | ||
</appearance> | ||
|
||
<operations> | ||
If the user has forgotten their credentials, they will need to follow the instructions | ||
<link target="Auth0ReturningUserAccountLinking">Here</link> | ||
</operations> | ||
|
||
</page> | ||
|
||
</vcelldoc> |
24 changes: 24 additions & 0 deletions
24
vcell-client/UserDocumentation/originalXML/topics/Auth0/Auth0LinkAccount.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
<vcelldoc> | ||
<page title="Auth0 Profile Page"> | ||
|
||
<introduction> | ||
After logging into Auth0 for the first time, the user will be redirected to the <bold>Profile</bold> page | ||
in Auth0. There, the user will complete the final step to creating an Auth0 account. | ||
</introduction> | ||
|
||
<appearance> | ||
<imgReference target = "userLoginReg.png"/> | ||
</appearance> | ||
|
||
<operations> | ||
The <bold>Virtual Cell User Registration</bold> dialog prompts the user to choose a 'login id' (user name, case sensitive) and password. | ||
In order to complete the registration, the user needs to provide other information such as a valid email address (for VCell software notifications and to retrieve forgotten passwords), first and last name of user, job title, organization and address. | ||
The user can choose to decline receiving emails regarding VCell notifications by clicking on the checkbox at the bottom of the registration dialog. | ||
</operations> | ||
|
||
<comments> </comments> | ||
|
||
</page> | ||
|
||
</vcelldoc> |
23 changes: 23 additions & 0 deletions
23
vcell-client/UserDocumentation/originalXML/topics/Auth0/Auth0NewUserAccountCreation.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
<vcelldoc> | ||
<page title="Auth0 New User Account Creation"> | ||
|
||
<introduction> | ||
New users (or those who simply wish to make a fresh new VCell account) simply need to fill out the bottom | ||
section of the profile page | ||
</introduction> | ||
|
||
<appearance> | ||
<imgReference target = "ProfileCreateNew.png"/> | ||
</appearance> | ||
|
||
<operations> | ||
If a message saying "Failed to map new user, please try again", the likely cause is the VCell username | ||
already exists. Pick a new one and try again. | ||
</operations> | ||
|
||
<comments> </comments> | ||
|
||
</page> | ||
|
||
</vcelldoc> |
26 changes: 26 additions & 0 deletions
26
vcell-client/UserDocumentation/originalXML/topics/Auth0/Auth0Overview.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
<vcelldoc> | ||
<page title="Auth0 Overview"> | ||
|
||
<introduction> | ||
Auth0 is a browser and web-based authentication service that allows (in the context of VCell) users to login | ||
to VCell in a secure and modern way. Some benefits include: | ||
<list> | ||
<item>Modern and secure login</item> | ||
<item>Ability to login with Google accounts</item> | ||
<item>Ability to remember login upon opening VCell, while providing a multiple ways to logout</item> | ||
</list> | ||
</introduction> | ||
|
||
<appearance> | ||
<imgReference target = "MainPageWithLogin.png"/> | ||
</appearance> | ||
|
||
<operations> | ||
</operations> | ||
|
||
<comments> </comments> | ||
|
||
</page> | ||
|
||
</vcelldoc> |
28 changes: 28 additions & 0 deletions
28
vcell-client/UserDocumentation/originalXML/topics/Auth0/Auth0ProfilePage.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
<vcelldoc> | ||
<page title="Auth0 Profile Page"> | ||
|
||
<introduction> | ||
After logging into Auth0 for the first time, the user will be redirected to the <bold>Profile</bold> page | ||
in Auth0. There, the user will complete the final step to creating an Auth0 account. | ||
</introduction> | ||
<appearance> | ||
<imgReference target = "ProfileUsernameExplanation.png"/> | ||
</appearance> | ||
<operations> | ||
In order to properly use VCell, users must have a VCell Username. There are three ways to link a VCell | ||
username to an Auth0 login: | ||
<list> | ||
<item>Existing Users - <link target="Auth0ExistingUserAccountLinking">Use old VCell login</link></item> | ||
<item>Forgot your password? - <link target="Auth0ReturningUserAccountLinking">Recover old VCell Account</link></item> | ||
<item>New VCell Users - <link target="Auth0NewUserAccountCreation">Create new Username</link></item> | ||
</list> | ||
|
||
Once a VCell Username is applied, a new Auth0 account has been successfully created, as indicated by seeing | ||
a new Auth0 profile page layout, similar to the image below: | ||
<para></para> | ||
<imgReference target = "ProfileUserMapped.png"/> | ||
</operations> | ||
<comments> </comments> | ||
</page> | ||
</vcelldoc> |
24 changes: 24 additions & 0 deletions
24
vcell-client/UserDocumentation/originalXML/topics/Auth0/Auth0ReturningUserAccountLinking.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
<vcelldoc> | ||
<page title="Auth0 Returning User (Forgot Password) Account Linking"> | ||
|
||
<introduction> | ||
Users who have forgotten their password are still able to recover their account, by providing the username | ||
and associated email of their old VCell account. | ||
</introduction> | ||
|
||
<appearance> | ||
<imgReference target = "ProfileRecoverAccount.png"/> | ||
</appearance> | ||
|
||
<operations> | ||
If the correct combination was input, an email will be sent to the old account's email address, with a link | ||
to immediately approve the linking of the VCell account to the Auth0 account. | ||
</operations> | ||
|
||
<comments> Note that if you do not remember both old username and email, you will have to contact VCell Support | ||
at [email protected]</comments> | ||
|
||
</page> | ||
|
||
</vcelldoc> |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
69 changes: 42 additions & 27 deletions
69
vcell-client/UserDocumentation/originalXML/topics/ch_1/Introduction/General.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,31 +1,46 @@ | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
<vcelldoc> | ||
<page title="Overview" target="General"> | ||
|
||
<introduction> | ||
The Virtual Cell Software provides 2 environments for defining computational models. | ||
<bold>BioModels</bold> and <bold>MathModels</bold> allow the user to create models using the tool that best suits their experience. | ||
A BioModel consists of a model description (<link target = "PhysOverview">Physiology</link>), and one or more <link target = "ApplicationOverview">Applications</link> generated using a graphical interface to define model elements. | ||
A MathModel is a document defined using the VCell Markup Language (VCML) and is created using VCML 'code'. | ||
<para><bold>BioModel</bold></para> | ||
The <link target = "PhysOverview">BioModel Physiology</link> | ||
includes what is known about the biological system in terms of cellular structures, species and biochemical reactions. | ||
|
||
Each <link target = "ApplicationOverview">BioModel Application</link> | ||
allows the user to define the quantitative conditions needed to define, run and visualize a Virtual Experiment, i.e. numerical simulation. Thus, an Application includes the <link target = "GeometryOverview">Geometry</link>, the <link target = "SpecificationsOverview">Specifications</link> (species, | ||
reactions), <link target = "ProtocolsOverview">Protocols</link> (events, electrical mapping), <link target = "simulations_overview">Simulations</link> and <link target = "PEOverview">Parameter Estimation</link> (if applicable). | ||
|
||
A single BioModel may have numerous | ||
Applications, in which geometries and/or parameters have been changed. Each | ||
Application, in turn can have multiple Simulations, in which different numerical | ||
methods or conditions are used. | ||
|
||
<para><bold>MathModel</bold></para> | ||
MathModels define Virtual Experiments using VCell Markup Language. | ||
|
||
|
||
</introduction> | ||
|
||
</page> | ||
<page title="Overview" target="General"> | ||
|
||
<introduction> | ||
VCell provides two styles of developing computational models: | ||
<list> | ||
<item><bold>BioModels</bold></item> | ||
<item><bold>MathModels</bold></item> | ||
</list> | ||
Each uses a different methodology of model creation that best suits a given user's experience. | ||
|
||
<para><bold>BioModel</bold></para> | ||
A BioModel is a computational model defined and built through defining biological concepts within | ||
a graphical interface. | ||
|
||
BioModels consist of: | ||
<list> | ||
<item>a model's biological system, including cellular structures, species and biochemical reactions ("<link target="PhysOverview">Physiology</link>")</item> | ||
<item>one or more sets of constraints and conditions imposed on the model ("<link target="ApplicationOverview">Application</link>")</item> | ||
</list> | ||
|
||
Each <link target="ApplicationOverview">Application</link> | ||
allows the user to define the quantitative values needed to define, run and visualize a Virtual | ||
Experiment (i.e. numerical simulation). Thus, an <bold>Application</bold> includes: | ||
<list> | ||
<item><link target="GeometryOverview">Geometry</link></item> | ||
<item><link target="SpecificationsOverview">Specifications</link> (e.g. species, reactions)</item> | ||
<item><link target="ProtocolsOverview">Protocols</link> (e.g. events, electrical mapping)</item> | ||
<item>one or more <link target="simulations_overview">Simulations</link></item> | ||
<item><link target="PEOverview">Parameter Estimation</link> (if applicable)</item> | ||
</list> | ||
|
||
<para><bold>MathModel</bold></para> | ||
MathModels define Virtual Experiments using the <bold>Virtual Cell Markup Language</bold> (<bold>VCML</bold>). | ||
A MathModel consists of: | ||
<list> | ||
<item></item> | ||
</list> | ||
|
||
|
||
</introduction> | ||
|
||
</page> | ||
|
||
</vcelldoc> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.