Tilted Tutorial Sessions

# Tiled Tutorial Sessions ## Prequisites - Clean conda environment. Anything Python 3.8 - 3.11 works. Dan uses 3.11. (Some dependencies do not yet support 3.12.) - `pip install "tiled[all]"` ## This Week Tired of typing `from_uri("https://tiled.nsls2.bnl.gov")`? ```bash tiled profile create --name nsls2 https://tiled.nsls2.bnl.gov ``` ```python from tiled.client import from_profile client = from_profile("nsls2") ``` ## Previously on... ### 2024-03-29 First, everybody upgrade `pip install --upgrade "tiled[all]"` Start a clean server. ```bash tiled serve catalog --temp --api-key secret ``` ```python= import numpy from tiled.client import from_uri c = from_uri("http://localhost:8000", api_key="secret") arr = numpy.ones((5, 5)) c.write_array(arr, key="x", metadata={"T": 5, "color": "blue"}) c.write_array(arr, key="y", metadata={"T": 10, "color": "red"}) c.write_array(arr, key="z", metadata={"T": 15, "color": "green"}) a = c.create_container("a") a.write_array(arr, key="z", metadata={"T": 15, "color": "green"}) tree(c) ``` ```py from tiled.client import tree tree(c) ``` ```python= from tiled.queries import Eq ``` https://jsonapi.org/ Unedited dump from session: ```python= c.search(Eq("color", "green")) c c.search(Eq("color", "green")) from tiled.client import show_logs show_logs() c.search(Eq("color", "green")); 1 + 1 1 + 1; import time time.sleep(1); c.search(Eq("color", "green")) Eq("color", "green") Eq? Eq?? c from tiled.queries import FullText client = from_profile('nsls2') from tiled.client import from_profile client = from_profile('nsls2') c from tiled.client import from_profile, hide_logs hide_logs() c['bmm']['raw'].search(FullText('quadem1')) c client['bmm']['raw'].search(FullText('quadem1')) client['bmm']['raw'] Eq? show_logs() client['bmm']['raw'].search(FullText('quadem1')) c hide_logs() c c.write_array(arr, key="x2", metadata={"T": 150, "color": "green"}) c c.search(Eq("color", "green")) c.search(Eq("color", "green")).search(Eq("T", 150)) show_logs() c.search(Eq("color", "green")).search(Eq("T", 150)) hide_logs() c c.search(Eq("color", "green")) c.search(Eq("color", "green")).search(Eq("T", 150)) c.search(Eq("color", "green")); c.search(Eq("color", "green")).search(Eq("T", 150)); c.search(Eq("color", "green")).search(Eq("T", 150))[-1] c.search(Eq("color", "green")).search(Eq("T", 150)).values()[-1] c.search(Eq("color", "green")).search(Eq("T", 150)).keys()[-1] c.search(Eq("color", "green")).search(Eq("T", 150)).values()[0] results = c.search(Eq("color", "green")).search(Eq("T", 150)) results results._queries results._queries_as_params from tiled.queries import Key c.search(Eq("color", "green")).search(Eq("T", 150)) from tiled.queries import NotEq, Operator Operator? from tiled.queries import NotEq, Comparison Comparison? c.search(Comparison("gt", "T", 100)) c.search(Comparison("lt", "T", 100)) Comparison("lt", "T", 100).encode() Key("T") == 5 Key("T") > 5 c.search(Key("color") == "green").search(Key("T") >= 150) c.search(Key("color") != "green") tree(c) import pandas df = pandas.DataFrame({"A": [1,2,3], "B": [4,5,6], "C": [7,8,9]}) df['A'] df.A df = pandas.DataFrame({"A": [1,2,3], "B": [4,5,6], "C": [7,8,9], "sum": [10,11,12]}) df.sum() df['A'] df.A df['sum'] df.sum df = pandas.DataFrame({"A": [1,2,3], "B": [4,5,6], "C": [7,8,9], "sum": [10,11,12], "matt snyder": [1,2,3]}) df['matt snyder'] c show_logs() c['a'] c['a']['z'] ``` ### 2024-03-22 - Using [HTTPie](https://httpie.io/) commandline tool to explore the Tiled HTTP API Install and use HTTPie. ```bash pip install httpie http https://example.com ``` Start a Tiled server. ```bash tiled serve catalog --temp --api-key secret ``` Public server landing page (HTML) ```bash http :8000 ``` Public server info (JSON) ```bash http :8000/api/v1 # missing trailing / http :8000/api/v1/ ``` The `/metadata` and `/search` endpoints ```bash http :8000/api/v1/metadata/ # missing authentication http :8000/api/v1/metadata/ 'Authorization:Apikey secret' http :8000/api/v1/search/ 'Authorization:Apikey secret' ``` Using the Python client to upload some data: ```python= from tiled.client import from_uri import dask.array import dask.dataframe import numpy import pandas c = from_uri('http://localhost:8000', api_key='secret') arr = numpy.ones((5, 5)) c.write_array(arr, key="x") df = pandas.DataFrame({"A": [1,2,3], "B": [4,5,6], "C": [7,8,9]}) c.write_dataframe(df, key="y") z = c.create_container("z") z.write_array([1], key="stuff") z.write_array([10, 20, 30], key="things") da = dask.array.from_array(numpy.mgrid[:5, :5][0] * 10 + numpy.mgrid[:5, :5][1], chunks=(3, 3)) c.write_array(da, key='da') ddf = dask.dataframe.from_pandas(df, npartitions=2) c.write_dataframe(ddf, key='ddf') ``` Use `/search` to list contents. ```bash http :8000/api/v1/search/ 'Authorization:Apikey secret' ``` ```bash pip install jq http :8000/api/v1/search/ 'Authorization:Apikey secret' | jq .data[].id http :8000/api/v1/search/ 'Authorization:Apikey secret' | jq .data[].links.self http :8000/api/v1/search/z 'Authorization:Apikey secret' | jq .data[].id ``` Describe an array. ``` http :8000/api/v1/metadata/x 'Authorization:Apikey secret' ``` Fetch array data. ```bash http :8000/api/v1/array/full/x 'Authorization:Apikey secret' ``` Request a non-default format. ```bash http :8000/api/v1/array/full/x 'Authorization:Apikey secret' 'Accept:text/csv' http ':8000/api/v1/array/full/x?format=text/csv' 'Authorization:Apikey secret' http ':8000/api/v1/array/full/x?format=csv' 'Authorization:Apikey secret' ``` ```bash http :8000/api/v1/array/full/x 'Authorization:Apikey secret' 'Accept:nonsense' ``` Slice. ```bash http ':8000/api/v1/array/full/x?slice=:3' 'Authorization:Apikey secret' 'Accept:text/csv' http ':8000/api/v1/array/full/x?slice=:,:3' 'Authorization:Apikey secret' 'Accept:text/csv' ``` Use the block endpoint. ```bash! # See the full array in one request. http ':8000/api/v1/array/full/da' 'Authorization:Apikey secret' 'Accept:text/csv' # Request individual blocks. http ':8000/api/v1/array/block/da?block=0,0' 'Authorization:Apikey secret' 'Accept:text/csv' http ':8000/api/v1/array/block/da?block=0,1' 'Authorization:Apikey secret' 'Accept:text/csv' http ':8000/api/v1/array/block/da?block=1,0' 'Authorization:Apikey secret' 'Accept:text/csv' http ':8000/api/v1/array/block/da?block=0,0' 'Authorization:Apikey secret' 'Accept:text/csv' # Slice within a block. http ':8000/api/v1/array/block/da?block=0,0&slice=1:,1:' 'Authorization:Apikey secret' 'Accept:text/csv' ``` Describe a table. ```bash http ':8000/api/v1/metadata/y' 'Authorization:Apikey secret' ``` Fetch tabular data. ```bash= http ':8000/api/v1/table/full/y' 'Authorization:Apikey secret' 'Accept:text/csv' http ':8000/api/v1/table/full/y?column=A' 'Authorization:Apikey secret' 'Accept:text/csv' http ':8000/api/v1/table/full/y?column=A&column=B' 'Authorization:Apikey secret' 'Accept:text/csv' ``` Fetch tabular data by partition: ```bash= http ':8000/api/v1/table/partition/ddf?partition=0' 'Authorization:Apikey secret' 'Accept:text/csv' http ':8000/api/v1/table/partition/ddf?partition=1' 'Authorization:Apikey secret' 'Accept:text/csv' # Combine with column selection http ':8000/api/v1/table/partition/ddf?partition=1&column=A' 'Authorization:Apikey secret' 'Accept:text/csv' ``` ### 2024-03-15 - Registration - Data Sources ### 2024-03-07

Syntax	Example	Reference
# Header	Header	基本排版
- Unordered List	Unordered List
1. Ordered List	Ordered List
- [ ] Todo List	Todo List
> Blockquote	Blockquote
Bold font	Bold font
Italics font	Italics font
~~Strikethrough~~	~~Strikethrough~~
19^th^	19^th
H~2~O	H₂O
++Inserted text++	Inserted text
==Marked text==	Marked text
[link text](https:// "title")	Link
![image alt](https:// "title")	Image
`Code`	`Code`	在筆記中貼入程式碼
```javascript var i = 0; ```	`var i = 0;`
:smile:		Emoji list
{%youtube youtube_id %}	Externals
$L^aT_eX$	L^aT_eX
:::info This is a alert area. :::	This is a alert area.