|
2 | 2 |
|
3 | 3 | ## Contents
|
4 | 4 |
|
5 |
| -1. [About the API](#introduction) |
| 5 | +1. [About the CLI](#introduction) |
6 | 6 |
|
7 | 7 | 2. [Setup and Installation](#setup-and-installation)
|
8 | 8 |
|
|
14 | 14 |
|
15 | 15 | 3. [Interacting with the CaltechDATA CLI](#interacting-with-the-caltechdata-cli)
|
16 | 16 |
|
17 |
| - 3.1 [CaltechDATA and the Test Instance of the Repository: Which Should I Use?]() |
| 17 | + 3.1 [CaltechDATA and the CaltechDATA Test Instance: Which Should I Use?](#the-test-instance-or-the-caltechdata-repository) |
18 | 18 |
|
19 |
| - 3.2 [For Mac OS Users and and Windows Subsystem for Linux Users](#for-macos-users) |
20 |
| - |
21 |
| - 3.3 [For Windows Users](#for-windows-users-1) |
| 19 | + 3.2 [Creating A Token](#creating-a-token) |
| 20 | + |
| 21 | + 3.3 [What Files You'll Need to Create A New Dataset](#what-files-youll-need-to-create-a-new-dataset) |
| 22 | + |
| 23 | + 3.4 [For Mac OS Users and and Windows Subsystem for Linux Users](#for-macos-users-and-windows-subsystem-for-linux-wsl-users) |
22 | 24 |
|
23 |
| -4. [Additional Steps](#additional-steps) |
| 25 | + 3.5 [For Windows Users](#for-windows-users-1) |
24 | 26 |
|
25 |
| -5. [Troubleshooting](#troubleshooting) |
| 27 | +4. [Troubleshooting](#troubleshooting) |
26 | 28 |
|
27 |
| - 5.1 [General Troubleshooting FAQs](#general-troubleshooting-and-faqs) |
| 29 | + 4.1 [General Troubleshooting FAQs](#general-troubleshooting-and-faqs) |
28 | 30 |
|
29 |
| - 5.2 [Windows Subsystem for Linux](#windows-subsystem-for-linux-troubleshooting-and-faqs) |
| 31 | + 4.2 [Windows Subsystem for Linux](#windows-subsystem-for-linux-troubleshooting-and-faqs) |
30 | 32 |
|
31 |
| -7. [Contact Us](#contact-us) |
| 33 | +5. [Contact Us](#contact-us) |
32 | 34 |
|
33 | 35 | ## Introduction
|
34 |
| -The CaltechData API repository houses the codebase for accessing, uploading, and editing research data and metadata from Caltech's collections through a program or CLI. This API provides developers with endpoints to interact with datasets and retrieve relevant information. |
| 36 | +The CaltechData CLI is a command line interface that automates creation and |
| 37 | +upload of records to CaltechDATA. Large data uploads are currently for test |
| 38 | +purposes only; please email [email protected] if you have large data |
| 39 | +distribution needs. |
35 | 40 |
|
36 | 41 |
|
37 | 42 | ## Setup and Installation:
|
@@ -138,14 +143,39 @@ Now, we shall install caltechdata_api. To do this, please run the following comm
|
138 | 143 |
|
139 | 144 |
|
140 | 145 | ## Interacting with the CaltechDATA CLI
|
141 |
| -The CaltechDATA Command Line Interface (CLI) helps you interact with the CaltechDATA repository to upload research data, link your data with your publications, and assign a permanent DOI to your dataset so that others can reference the dataset. You can access the datasets you create or edit at https://data.caltech.edu/. |
| 146 | +The CaltechDATA Command Line Interface (CLI) helps you interact with the CaltechDATA repository to upload research data, link your data with your publications, |
| 147 | +and assign a permanent DOI to your dataset so that others can reference the |
| 148 | +dataset. You can access the datasets you create or edit at |
| 149 | +[https://data.caltech.edu/](https://data.caltech.edu). |
142 | 150 |
|
143 | 151 | ### The Test Instance or the CaltechDATA Repository
|
144 |
| -If you would like to create and edit a test record of your datset before uploading it to the CaltechDATA Repository and generating a permanent DOI, you can also use the CaltechDATA Command Line Interface (CLI) to interact with the test instance of the CaltechDATA Repository that you can access at https://data.caltechlibrary.dev/. |
| 152 | +If you would like to create and edit a test record of your datset before uploading |
| 153 | +it to the CaltechDATA Repository and generating a permanent DOI, you can also |
| 154 | +use the CaltechDATA Command Line Interface (CLI) to interact with the test instance |
| 155 | +of the CaltechDATA Repository that you can access at |
| 156 | +[https://data.caltechlibrary.dev/](https://data.caltechlibrary.dev/). |
| 157 | + |
| 158 | +We recommend using the CLI to interact with the test instance if you |
| 159 | +experimenting and are not ready to generate a permanent DOI. It is difficult to |
| 160 | +remove records in the main CaltechDATA repository, but easy to do so in the |
| 161 | +test repository. In general, users create and edit datasets in the same way regardless of whether the dataset exists on the original CaltechDATA Repository or the test instance. |
| 162 | + |
| 163 | +### Creating A Token: |
| 164 | +In order to create or edit datasets you'll need to create a token. In order to this, you'll need to open the platform you are uploading your dataset to (the original CaltechDATA Repository or the test instance of it) and log in. Then follow these steps: |
| 165 | + |
| 166 | +#### Step 1: |
| 167 | +Please click the person icon appearing on the top right and choose "Applications" from the dropdown menu that appears. |
145 | 168 |
|
146 |
| -We recommend using the CLI to interact with the test instance if you are not ready to generate a permanent DOI but would like to experiment to avoid creating junk records on the original CaltechDATA Repository. In general, users create and edit datasets in the same way regardless of whether the dataset exists on the original CaltechDATA Repository or the test instance. |
| 169 | +#### Step 2: |
| 170 | +Next, please click the option that says "New Token" and name your token. |
| 171 | + |
| 172 | +### What Files You'll Need to Create A New Dataset: |
| 173 | +In order to create a new dataset, you will need a: |
| 174 | + |
| 175 | +1) File containing your dataset (csv or json file) |
| 176 | +2) A metadata file (json file) |
147 | 177 |
|
148 |
| -Now we shall outline the steps to interact with the CLI. |
| 178 | +We use a customised version of Datacite 4.3 Schema which you can download [here](https://github.com/datacite/schema/blob/master/source/json/kernel-4.3/datacite_4.3_schema.json). Otherwise you can use your own. |
149 | 179 |
|
150 | 180 | ### For MacOS Users and Windows Subsystem for Linux (WSL) Users:
|
151 | 181 | Please run the command shown in order to interact with the CaltechDATA Repository:
|
@@ -194,24 +224,6 @@ Above: Using Visual Studio Code (VSCode)
|
194 | 224 | .png>)
|
195 | 225 | Above: Using Windows PowerShell
|
196 | 226 |
|
197 |
| -## Additional Steps: |
198 |
| - |
199 |
| -### Creating A Token: |
200 |
| -In order to create or edit datasets you'll need to create a token. In order to this, you'll need to open the platform you are uploading your dataset to (the original CaltechDATA Repository or the test instance of it) and log in. Then follow these steps: |
201 |
| - |
202 |
| -#### Step 1: |
203 |
| -Please click the person icon appearing on the top right and choose "Applications" from the dropdown menu that appears. |
204 |
| - |
205 |
| -#### Step 2: |
206 |
| -Next, please click the option that says "New Token" and name your token. |
207 |
| - |
208 |
| -### What Files You'll Need to Create A New Dataset: |
209 |
| -In order to create a new dataset, you will need a: |
210 |
| - |
211 |
| -1) File containing your dataset (csv or json file) |
212 |
| -2) A metadata file (json file) |
213 |
| - |
214 |
| -We use a customised version of Datacite 4.3 Schema which you can download [here](https://github.com/datacite/schema/blob/master/source/json/kernel-4.3/datacite_4.3_schema.json). Otherwise you can use your own. |
215 | 227 |
|
216 | 228 | ## Troubleshooting
|
217 | 229 |
|
|
0 commit comments