Skip to content

Commit

Permalink
Merge branch 'refs/heads/GuideDevUse'
Browse files Browse the repository at this point in the history
  • Loading branch information
pahjbo committed Jun 25, 2024
2 parents c19e71b + 152f76e commit 18a64d4
Show file tree
Hide file tree
Showing 2 changed files with 73 additions and 18 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@ node_modules/
.hugo_build.lock
/.idea/
/.vscode/
/site/
/site/
/venv/
88 changes: 71 additions & 17 deletions docs/Developer/use-cases.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@ actor :AAI User: as user
actor :Observatory Admin: as obsadmin
actor :TAC member: as tacmem
actor :TAC Chair: as tacchair
actor :Reviewer: as rev
actor :Internal Reviewer: as intrev
actor :External Reviewer: as extrev
actor :CO I : as coi
actor :Principal Investigator: as pi
usecase "deploy the system" as UC0
usecase "user registers to system" as UC1
usecase "create observatory admin" as UC2
usecase "configure observatory" as UC3
usecase "create observatory admin" as UC2
usecase "configure observatory" as UC3
usecase "create new proposal cycle" as UC4
usecase "create observing proposal" as UC5
usecase "edit observing proposal" as UC6
Expand All @@ -37,6 +37,12 @@ usecase "assign observing time" as UC12
usecase "inform PIs about allocation" as UC13
usecase "export whole proposal" as UC14
usecase "import whole proposal" as UC15
usecase "assign internal reviewer" as UC16
usecase "assign external reviewer" as UC17
usecase "review proposal scores" as UC18
usecase "clone proposal" as UC20
usecase "withdraw proposal" as UC21
usecase "revoke allocation" as UC22
sysadmin --> UC0
sysadmin --> UC2
user --> UC1
Expand All @@ -45,25 +51,35 @@ obsadmin --> UC4
user ..>pi
user ..>coi
user ..>extrev
user ..>intrev
user ..>tacmem
user ..>obsadmin
tacmem ..>rev
tacmem ..>tacchair
pi-->UC5
coi-->UC6
pi-->UC6
pi-->UC7
pi-->UC14
pi--> UC15
pi-->UC15
pi-->UC20
pi-->UC21
coi-->UC6
coi-->UC14
obsadmin-->UC8
tacchair-->UC9
tacchair-->UC10
tacchair-->UC12
tacchair-->UC13
rev-->UC10
rev-->UC11
extrev -->UC10
extrev -->UC11
tacchair-->UC16
tacchair-->UC17
tacchair-->UC22
tacmem-->UC10
tacmem-->UC14
tacmem-->UC18
intrev-->UC10
intrev-->UC11
intrev-->UC14
extrev-->UC10
extrev-->UC11
extrev-->UC14
```

## Digging down
Expand All @@ -79,6 +95,7 @@ rather than using the AAI and has full access to the system.
All other users should go through the AAI mechanisms on initial creation

### create observatory admin

the system administrator configures initial supported observatory object(s) and assigns an already registered user (or users)
to be the observatory administrators

Expand All @@ -90,6 +107,9 @@ observatory administrators have the permission to be able to more fully configur

the observatory administrators can assign someone to be the time allocation committee chair for the observatory

### add TAC members

The TAC Chair can add existing users to the TAC
### create new proposal cycle

The TAC chair would then create Proposal Cycle
Expand All @@ -98,39 +118,73 @@ The TAC chair would then create Proposal Cycle

A PI will create an observing proposal and invite CO-Is

### import whole proposal

the proposal could be imported in the approved Polaris Document Exchange Format

### clone proposal

PI clones one of their proposals to act as a seed for a new proposal

### edit observing proposal

PIs and CO-Is can edit an observing proposal


### submit a proposal

When the proposal is complete the PI can formally submit the proposal

### withdraw proposal

PI withdraws a previously submitted proposal

### add TAC members
### assign internal reviewer

The TAC Chair can add existing users to the TAC
TAC Chair assigns a reviewer from their observatory, who must be a registered Polaris user

### assign external reviewer

TAC Chair assigns a reviewer from outside their observatory, but reviewer must be a registered Polaris user

### review proposals

The proposals can be distributed to the TAC - this might

### export whole proposal

the proposal could be exported in several forms, eg, PDF, approved Polaris Document Exchange Format

### score proposals

There might be a scoring system that allows people outside the TAC to score as well. See the external reviewer.

### review proposal scores

TAC members review the scores assigned by reviewers

### assign observing time

The TAC assigns observing time to the highest scoring proposals

### inform PIs about allocation
### export whole proposal

the proposal could be exported in several forms
possibly automated email

### revoke allocation

TAC Chair revokes a previously allocated proposal, possibly because cycle schedule has become over-subscribed












### import whole proposal



Expand Down

0 comments on commit 18a64d4

Please sign in to comment.