Example to use Rohub from Jupyter notebook

pip install rohub pillow

from pathlib import Path
import json
import rohub

cred_path = Path.home() / ".config" / "rohub_credentials.json"

try:
    with cred_path.open("r", encoding="utf-8") as f:
        data = json.load(f)
    rohub_user = data["rohub"]["username"]
    rohub_pwd = data["rohub"]["password"]
except FileNotFoundError:
    raise SystemExit(f"Credentials file not found: {cred_path}")
except KeyError:
    raise SystemExit("Expected keys not found in credentials file.")
except json.JSONDecodeError:
    raise SystemExit("Credentials file is not valid JSON.")

rohub.login(username=rohub_user, password=rohub_pwd)

rohub.list_valid_research_areas()

rohub.list_valid_ros_types()

ro_title="FAIR2Adapt RO-Crate with Jupyter Notebook"
ro_research_areas=["Environmental research"]
ro_description="This Research Object demonstrate how to create a new RO in ROHub from Python"
ro_ros_type="Executable Research Object"

ro = rohub.ros_create(title=ro_title, research_areas=ro_research_areas, description=ro_description, ros_type=ro_ros_type, use_template=True)

#ro_id = "b3aa0332-2954-486b-b95f-33d84af14232"
#ro = rohub.ros_load(identifier=ro_id)

ro.show_metadata()

ro.description="This Research Object is an example for FAIR2Adapt Case Study 2"
#ro.editors = "annef@simula.no torill.hamre@nersc.no"
ro.update()

myfolders = ro.list_folders()
myfolders

from PIL import Image, ImageDraw

# Create a blank image
img = Image.new("RGB", (200, 200), color="white")

# Create a drawing object
draw = ImageDraw.Draw(img)

# Draw a red rectangle
draw.rectangle([50, 50, 150, 150], fill="red")

# Draw a blue ellipse
draw.ellipse([70, 70, 130, 130], fill="blue")

# Save
img.save("my_drawing.png")

resi_res_type="Sketch"
resi_file_path="my_drawing.png"
resi_title="Image to illustrate my case study"
resi_folder="input"

my_res_int0=ro.add_internal_resource(res_type=resi_res_type,file_path=resi_file_path, title=resi_title, folder=resi_folder)

rese_res_type="Image"
rese_file_url="https://raw.githubusercontent.com/FAIR2Adapt/saarland-flooding/refs/heads/main/static/flood_in_saarland_with_jqgis.png"
rese_title="flood in saarland with JupyterGIS"
rese_description="Example for FAIR2Adapt training on RO-Crate and ROHub"

ro.add_external_resource(res_type=rese_res_type, input_url=rese_file_url, title=rese_title, description= rese_description, folder="output")

rese_res_type="Jupyter Notebook"
rese_file_url="https://raw.githubusercontent.com/FAIR2Adapt/saarland-flooding/refs/heads/main/notebooks/Flood_protection_line_Saarland.ipynb"
rese_title="Flood analysis with JupterGIS"
rese_description="Visualizing Generalized Flood Areas for HQ100 Event and relate to an existing flooding event."

my_res_ext0=ro.add_external_resource(res_type=rese_res_type, input_url=rese_file_url, title=rese_title, description=rese_description, folder="tool")

ro.list_resources()

geojson_bbox = {
    "@context": {
        "geojson": "https://purl.org/geojson/vocab#"
    },
    "type": "Feature",
    "geometry": {
        "type": "Polygon",
        "coordinates": [[
            [6.31, 49.1],   # SW corner
            [6.31, 49.64],  # NW corner
            [7.41, 49.64],  # NE corner
            [7.41, 49.1],   # SE corner
            [6.31, 49.1]    # Close polygon back to SW
        ]]
    }
}

ro.add_geolocation(body_specification_json=geojson_bbox)

#ro.export_to_rocrate(filename="my-ro-crate")
ro.export_to_rocrate(filename="my-ro-crate", use_format="zip")

usernames = rohub.users_find(search="Ines")
usernames

agents = [usernames.iloc[0][["orcid_identifier"]].to_dict()]
print(agents)

#ro.set_authors(agents=agents)

#ro.set_authors(agents=["dontdoit@lochness.uk"])

#ro.set_contributors(agents=[{"user_id":"rapnonexist_3@hotmail.com", 
#                             "display_name": "Pepito Bato", 
#                             "email":"example3@hotmail.com",
#                             "orcid_id":"0000-0002-8316-3192",
#                             "affiliation": "PCSS"}])

organizations=rohub.organizations_find(search="poznan")
organizations

ro.set_publishers(agents=[organizations.loc[0,"organization_id"]])

ro.set_copyright_holders(agents=[{"org_id":"https://neic.no/",
                    "display_name": "Nordic e-Infrastructure Collaboration", 
                     "agent_type": "organization",
                    "ror_identifier":"04jcwf484",
                    "organization_url": "https://neic.no/"}])

rohub.list_available_licenses()

rohub.list_valid_license_status()

rohub.list_custom_licenses() 

rohub.zenodo_list_funders(query="European")

grant_id="101188256"
grant_Name="FAIR2Adapt"
grant_title="FAIR to Adapt to Climate Change"
funder_name="European Commission"
funder_doi="10.3030/101188256"

ro.add_funding(grant_identifier=grant_id, grant_name=grant_Name, funder_name=funder_name,
grant_title=grant_title, funder_doi=funder_doi)

# snapshot_id=ro.snapshot()
# snapshot_id

snapshot_title="Case Study RO - published v1"
# Uncomment the line below to publish in zenodo and get a DOI
# snapshot_id_pub=ro.snapshot(title=snapshot_title, create_doi=True, publication_services=["Zenodo"])
#snapshot_id_pub

#snapshot_id_pub = '57cf76e1-2179-4650-b48b-b5990dca86c1'
#published_ro = rohub.ros_load(identifier=snapshot_id_pub)
#published_ro.list_publications()

#fork_id=ro.fork(title="Forked RO")
#forked_ro = rohub.ros_load(identifier=fork_id)
#forked_ro.show_metadata()
#%time fork_id=ro.fork()

results=ro.list_resources()
results

my_res1=rohub.resource_load(identifier=results.loc[1,"identifier"])

my_res1.show_metadata()

my_res1.title="Image - updated"
my_res1.description="This resource has this description"
my_res1.update_metadata()

import urllib.request

url = "https://raw.githubusercontent.com/FAIR2Adapt/saarland-flooding/refs/heads/main/static/logo.png"
urllib.request.urlretrieve(url, "fair2adapt-logo.png")
print("Downloaded to logo.png")

resi_file_path="fair2adapt-logo.png"
my_res1.update_content(file_path=resi_file_path)

my_res1_ext=rohub.resource_load(identifier=results.loc[0,"identifier"])
rese_file_url="https://raw.githubusercontent.com/FAIR2Adapt/saarland-flooding/refs/heads/main/notebooks/Hamburg_urban_data_portal_WFS.ipynb"
my_res1_ext.update_content(input_url=rese_file_url)

file=my_res1.download(resource_filename="resource.png")

from IPython.display import Image
Image(filename=file) 

# my_res1_ext.assign_doi()

#forked_ro.delete()
#ro_id_to_delete="55a0fbe5-fde3-40cb-9ea0-1eacd3cda8d1"
#rohub.ros_delete(identifier=ro_id_to_delete)

rohub.show_user_id()

rohub.list_valid_research_areas()

rohub.list_valid_ros_types()

rohub.list_valid_publication_services()

rohub.list_valid_resource_types()

rohub.list_valid_creation_modes()

rohub.list_valid_access_modes()

rohub.list_custom_licenses()

rohub.list_available_licenses()

rohub.show_valid_type_matching_for_ros()

ro.load_full_metadata()

ro.show_full_metadata()

rohub.version()

#default 30
rohub.set_retries(50)

# default 2
rohub.set_sleep_time(5)

my_ros = rohub.list_my_ros()
my_ros