|
|
@@ -1,14 +1,27 @@
|
|
|
-## Labkey Python interface ##
|
|
|
-A Python3 urllib3 based interface for communication with the LabKey server. Update over official LabKey version is the use of client certificates to access potentially sensitive sites.
|
|
|
+## Orthanc Python interface ##
|
|
|
+A Python3 urllib3 based interface for communication with the Orthanc server.
|
|
|
+Provides simple REST API interfaces integrated in python code.
|
|
|
|
|
|
### Setup ###
|
|
|
-Update `network-config-sample.json` with personal information needed to access the site (certificates, keys, username and password)
|
|
|
-When using labkeyInterface, use the updated file as input to labkeyInterface constructor, ie
|
|
|
+Update `network-config-sample.json` with personal information needed to access the site (username and password)
|
|
|
+When using orthancInterface, use the updated file as input to orthancInterface constructor, ie
|
|
|
```python
|
|
|
-ifc=labkeyInterface.labkeyInterface('/path/to/network-config.json')
|
|
|
+ifc=orthancInterface.orthancInterface('/path/to/network-config.json')
|
|
|
```
|
|
|
|
|
|
+Orthanc configuration file can be merged with the LabKeyInterface configuration file.
|
|
|
+
|
|
|
### Use ###
|
|
|
-`getFile.py` illustrates use to connect to site, collect image and perform image analysis.
|
|
|
+Sample usage:
|
|
|
|
|
|
+```python
|
|
|
+fhome=os.path.expanduser('~')
|
|
|
+fconfig=os.path.join(fhome,'.labkey','network.json')
|
|
|
+onet=orthancInterface.orthancInterface()
|
|
|
+onet.init(fconfig)
|
|
|
+ofb=orthancFileBrowser.orthancFileBrowser(onet)
|
|
|
+...
|
|
|
+#download seriesId to fname
|
|
|
+ofb.getZip('series',seriesId,fname)
|
|
|
+```
|
|
|
|
