-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
#263 test with partial for girder documentation
- Loading branch information
Showing
2 changed files
with
52 additions
and
51 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,51 +1 @@ | ||
| = Girder | ||
|
|
||
| == What is Girder | ||
|
|
||
| Girder is a data management platform. | ||
| It can be used to store (large) files such as meshes, simulation results, etc... | ||
| Read more about it in the {feelpp} xref:data:ROOT:data-storage.adoc[data manual] or | ||
| link:http://girder.readthedocs.io/[on the official website]. | ||
|
|
||
| == File access options | ||
|
|
||
| A big advantage of girder is that files can be accessed either with a nice user | ||
| interface (in a web browser) or more programmatically (via CLI or programming | ||
| interfaces). | ||
| This is true for both upload and download. | ||
|
|
||
| === Web browser UI | ||
|
|
||
| If you are new to Girder, you should start with the web user interface to | ||
| discover the service. | ||
| You are encouraged to read the documentation | ||
| link:http://girder.readthedocs.io/[documentation] and especially the | ||
| link:http://girder.readthedocs.io/en/latest/user-docs.html[user guide]. | ||
| For example, using a web browser, you can reach | ||
| link:https://girder.math.unistra.fr/#collections[our server]. | ||
|
|
||
| |=== | ||
| | image:girder/girder_web_ui.png[Web user interface,100%] | ||
| |=== | ||
|
|
||
| NOTE: This is quite straightforward and it should illustrate important concepts | ||
| and help better visualize the following section. | ||
|
|
||
| === Python API | ||
|
|
||
| To download or upload a file using python, we have two options. | ||
| We can either use a login system (user + password) or an API key. | ||
| - With the user/password, we will need to provide a user and a password to | ||
| access files, just like a human would do using the UI. | ||
| - With an API key, the script only needs an API key. | ||
| This means we do not need to have an account on the Girder server. | ||
|
|
||
| In both cases, similar pieces of information are required: | ||
|
|
||
| - an *address* (URL): to reach the server, | ||
| - a *file ID*: to tell which file/directory we want to manipulate, | ||
| - either a *user/password* pair or an *API key*: to grant access to the | ||
| required file(s). | ||
|
|
||
| Let's check out some | ||
| xref:contribute:girder:python_scripts.adoc[scripts]. | ||
| include::partial$girder/README.adoc |
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,51 @@ | ||
| = Girder | ||
|
|
||
| == What is Girder | ||
|
|
||
| Girder is a data management platform. | ||
| It can be used to store (large) files such as meshes, simulation results, etc... | ||
| Read more about it in the {feelpp} xref:data:ROOT:data-storage.adoc[data manual] or | ||
| link:http://girder.readthedocs.io/[on the official website]. | ||
|
|
||
| == File access options | ||
|
|
||
| A big advantage of girder is that files can be accessed either with a nice user | ||
| interface (in a web browser) or more programmatically (via CLI or programming | ||
| interfaces). | ||
| This is true for both upload and download. | ||
|
|
||
| === Web browser UI | ||
|
|
||
| If you are new to Girder, you should start with the web user interface to | ||
| discover the service. | ||
| You are encouraged to read the documentation | ||
| link:http://girder.readthedocs.io/[documentation] and especially the | ||
| link:http://girder.readthedocs.io/en/latest/user-docs.html[user guide]. | ||
| For example, using a web browser, you can reach | ||
| link:https://girder.math.unistra.fr/#collections[our server]. | ||
|
|
||
| |=== | ||
| | image:girder/girder_web_ui.png[Web user interface,100%] | ||
| |=== | ||
|
|
||
| NOTE: This is quite straightforward and it should illustrate important concepts | ||
| and help better visualize the following section. | ||
|
|
||
| === Python API | ||
|
|
||
| To download or upload a file using python, we have two options. | ||
| We can either use a login system (user + password) or an API key. | ||
| - With the user/password, we will need to provide a user and a password to | ||
| access files, just like a human would do using the UI. | ||
| - With an API key, the script only needs an API key. | ||
| This means we do not need to have an account on the Girder server. | ||
|
|
||
| In both cases, similar pieces of information are required: | ||
|
|
||
| - an *address* (URL): to reach the server, | ||
| - a *file ID*: to tell which file/directory we want to manipulate, | ||
| - either a *user/password* pair or an *API key*: to grant access to the | ||
| required file(s). | ||
|
|
||
| Let's check out some | ||
| xref:contribute:girder:python_scripts.adoc[scripts]. |