Skip to content

Fix notebooks to pass tests (Add Sphinx docs - Part 2) #92

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

Closed
Closed
Show file tree
Hide file tree
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
7 changes: 6 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,7 @@
may2019_demo/pancreas.loom
.ipynb_checkpoints/
download-any-bam-file/Aligned.sortedByCoord.out.bam
download-smartseq2-matrix-scanpy/matrix.results
download-smartseq2-matrix-scanpy/matrix.tsv
download-smartseq2-matrix-scanpy/matrix2.results
download-smartseq2-matrix-scanpy/matrix2.tsv
explore-hca-dataset-scanpy-may-2019/pancreas.loom
4,582 changes: 4,406 additions & 176 deletions download-all-fastq-files/download-all-fastq-files.ipynb

Large diffs are not rendered by default.

413 changes: 231 additions & 182 deletions download-any-bam-file/download-any-bam-file.ipynb

Large diffs are not rendered by default.

1,344 changes: 737 additions & 607 deletions find-cell-type-count/find-cell-type-count.ipynb

Large diffs are not rendered by default.

54 changes: 27 additions & 27 deletions login/login.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -4,48 +4,48 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## Login to the DSS 🔶"
"# Login to the DSS"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Things fall apart when logging in\n",
"First, assume the HCA CLI is already installed.\n",
"## Interactively\n",
"\n",
"The docs say to log in with `hca dss login`. This won't return if you run it in a notebook:"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"%%bash\n",
"hca dss login"
"One of the first things you will need to do to use the Human Cell Atlas command line interface (CLI) is to log in with your Human Cell Atlas account.\n",
"\n",
"Running the following command in a terminal will open a browser, and will direct you to an Auth0 URL that will ask you to authenticate yourself using one of atuhentication providers.\n",
"\n",
"To do this, run the following command at the command line:\n",
"\n",
"```\n",
"hca dss login\n",
"```\n",
"\n",
"Running via a terminal tells you to `Please visit this URL to authorize this application: <url>`\n",
"\n",
"That URL directs you to a Google sign-in page, which then redirects to to `localhost:8080`."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Running via a terminal tells you to `Please visit this URL to authorize this application: <url>`\n",
"## Remotely\n",
"\n",
"That URL directs you to a Google sign-in page, which then redirects to to `localhost:8080`.\n",
"If you're working in a notebook, VM, EC2 instance, or other remote host where you can't access a browser, you can run the following command instead:\n",
"\n",
"If you're working in a notebook, VM, EC2 instance, or other remote host where you can't access a browser, instead do:"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"```\n",
"hca dss login --remote\n",
"```\n",
"\n",
"If you are running a Jupyter notebook, enter the following into a cell to run the command using bash magic:\n",
"\n",
"```\n",
"%%bash\n",
"hca dss login --remote"
"hca dss login --remote\n",
"```"
]
}
],
Expand All @@ -65,7 +65,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.7.4"
"version": "3.6.9"
}
},
"nbformat": 4,
Expand Down
6 changes: 2 additions & 4 deletions test/ignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,2 @@
Download\ 10x\ Seq\ T-cell\ Bundles/
Find\ Cell\ Type\ Count/
Login\ to\ the\ DSS/
SPARK\ Example/
download-10x-seq-tcell
spark-example