Skip to content

Commit

Permalink
Create quick-example.md
Browse files Browse the repository at this point in the history
  • Loading branch information
xinan1911 authored Oct 29, 2024
1 parent f09c006 commit 6479f04
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions docs/quick-example.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
PiCaS quick example
============

To demonstrate how pilot job PiCaS works, this page gives instructions on running a quick example which takes probably a few minutes. The quick example including four main steps:
1. connect to Picas server
2. prepare and upload tokens to Picas server
3. run Picas example pilot job
4. check the tokens and results


## Prerequisite

Before running the example, please read the README.md in [Picas Client](https://github.com/sara-nl/picasclient/). The prerequisites are:
* you have installed and tested the Picas client
* you have a Picas account and a Picas database
* there is a Picas token pool server running on CouchDB.

If you are following a workshop organized by SURF, the last two requirements have already been arranged for you.


## Connect to Picas server

## Prepare and upload tokens

## Run Picas example

## Check the tokens and results


0 comments on commit 6479f04

Please sign in to comment.