Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix formatting on data access doc #65

Merged
merged 3 commits into from
Apr 18, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 17 additions & 15 deletions docs/vobs/vobs-data-access.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -17,35 +17,39 @@
"\n",
"To access data from the Vector Observatory, you will need to follow these steps:\n",
"\n",
"### Step 1. Make sure you have a Google Account\n",
"#### Step 1. Make sure you have a Google Account\n",
"\n",
"To allow us to configure data access permissions, you will need to provide us with an email address that is associated with a Google account. This could be a standard Google (i.e., GMail) account, or alternatively it could be your work email if your employer uses Google Workspace.\n",
"\n",
"### Step 2. Fill out the data access request form\n",
"#### Step 2. Fill out the data access request form\n",
"\n",
"Please fill out and submit the following form:\n",
"\n",
"https://forms.gle/kCqistorZyxaU4LP7 \n",
"> [MalariaGEN cloud data access form](https://forms.gle/kCqistorZyxaU4LP7)\n",
"\n",
"All requests for data access will be granted, subject to verification checks and agreement to reasonable use. This is to ensure that the data resources remain accessible to everyone. Submitting this form will allow us to configure storage permissions and monitor storage for excessive network usage in future.\n",
"\n",
"### Step 3. Ensure you are using the latest version of the `malariagen_data` Python package\n",
"#### Step 3. Ensure you are using the latest version of the `malariagen_data` Python package\n",
"\n",
"If you access data via the `malariagen_data` Python package, please upgrade to version 9.0 or higher. These versions will automatically use your authentication credentials when accessing data in Google Cloud.\n",
"\n",
"### Step 4. Set up Google Cloud authentication credentials\n",
"#### Step 4. Set up Google Cloud authentication credentials\n",
"\n",
"If you are only accessing data via the malariagen_data Python package from within Google Colab, you can skip this step, because authentication credentials will be obtained automatically.\n",
"If you are only accessing data via the `malariagen_data` Python package from within Google Colab, you can skip this step, because authentication credentials will be obtained automatically.\n",
"\n",
"If you are accessing data from any other location, you will need to authenticate with Google Cloud. To do this, you will need to:\n",
"\n",
"1. Install the [Google Cloud CLI](https://cloud.google.com/sdk/gcloud). See the details in the Google Documentation [here](https://cloud.google.com/sdk/docs/install-sdk).\n",
"\n",
"2. Check gcloud is installed correctly:\n",
"\n",
"2. Check `gcloud` is installed correctly:\n",
"\n",
"```bash\n",
"gcloud help\n",
"```\n",
"\n",
"3. Authenticate using `gcloud`: \n",
"\n",
"- If you need to authenticate within the `malariagen_data` package, you will need to use the following command:\n",
"\n",
"```bash\n",
Expand All @@ -56,18 +60,16 @@
"\n",
"```bash\n",
"gcloud auth login\n",
"```\n",
"\n",
"If you have any questions, please contact us at: support@malariagen.net"
"```"
]
},
{
"cell_type": "code",
"execution_count": null,
"id": "ade225aa-7bd3-44e6-95a6-17e81cb53557",
"cell_type": "markdown",
"id": "ed024cac-be61-44a0-a339-821a9f70a456",
"metadata": {},
"outputs": [],
"source": []
"source": [
"If you have any questions, please contact us at: <support@malariagen.net>"
]
}
],
"metadata": {
Expand Down
Loading