Project Model¶

Field	Description	Settable
`project_id`	Short, unique identifier chosen at creation time (e.g. `MFP12345`)	create
`organization`	Free-text institution or group name (e.g. `"LBNL"`, `"Stanford"`)	create, update
`title`	Human-readable project title	create, update
`status`	Project status (e.g. `"active"`)	create, update
`project_lead_orcid`	ORCID of the project lead — must correspond to an existing Crucible user	create
`project_lead_name`	Project lead's name — populated by the server from the lead's ORCID	server-assigned
`project_lead_email`	Project lead's email — populated by the server from the lead's ORCID	server-assigned
`creation_time`	When the record was created	server-assigned
`modification_time`	When the record was last modified	server-assigned

Project Management¶

Listing projects¶

projects = client.projects.list()
for p in projects:
    print(p["project_id"], p["title"])

Getting a project¶

project = client.projects.get("MFP12345")

Creating a project¶

from crucible.models import Project

result = client.projects.create(Project(
    project_id="MFP12345",
    organization="LBNL",
    project_lead_orcid="0000-0001-2345-6789",
    title="Nanoparticle synthesis study",
    status="active",
))

project_id must be unique across the system. project_lead_orcid must correspond to an existing Crucible user.

Updating a project¶

client.projects.update("MFP12345", title="Nanoparticle synthesis study — phase 2", status="active")

Managing users¶

List users in a project¶

users = client.projects.get_users("MFP12345")
for u in users:
    print(u["unique_id"], u["email"])

Add a user¶

client.projects.add_user(orcid="0000-0002-3456-7890", project_id="MFP12345")

Remove a user¶

client.projects.remove_user(project_id="MFP12345", orcid="0000-0002-3456-7890")

Setting a default project in the CLI¶

Set a default project so you don't have to pass -pid on every command:

crucible config set current_project MFP12345

Or switch the active project in the interactive shell:

crucible
> use MFP12345