Skip to content

Commit

Permalink
remove backticks
Browse files Browse the repository at this point in the history
  • Loading branch information
sjspielman committed Mar 13, 2024
1 parent ef9cd0f commit 209bef7
Showing 1 changed file with 28 additions and 28 deletions.
56 changes: 28 additions & 28 deletions docs/technical-setup/environment-setup/setup-conda.md
Original file line number Diff line number Diff line change
@@ -1,71 +1,71 @@
# Install and setup `conda`
# Install and setup conda

## What is `conda`?
## What is conda?

The `OpenScPCA` project uses [`conda`](https://docs.anaconda.com/free/miniconda/index.html) to setup your software environment.
`conda` is a command-line software management tool which helps you install and track specific versions of software in many programming languages.
The OpenScPCA project uses [conda](https://docs.anaconda.com/free/miniconda/index.html) to setup your software environment.
conda is a command-line software management tool which helps you install and track specific versions of software in many programming languages.

This page provides instructions on how to install `conda` and use it to install certain software you will need to contribute to `OpenScPCA`.
This page provides instructions on how to install conda and use it to install certain software you will need to contribute to OpenScPCA.


### Why use `conda`?
### Why use conda?

There are two main reasons we use `conda` for `OpenScPCA`:
There are two main reasons we use conda for OpenScPCA:

- `conda` provides a "one stop shop" for installing lots of different software
- Rather than having to figure out how to install every new software on its own, `conda` can handle it all for you.
- You'll use `conda` to install the software dependencies you'll need to contribute to `OpenScPCA`.
- `conda` allows you set up different software environments for different projects
- conda provides a "one stop shop" for installing lots of different software
- Rather than having to figure out how to install every new software on its own, conda can handle it all for you.
- You'll use conda to install the software dependencies you'll need to contribute to OpenScPCA.
- conda allows you set up different software environments for different projects
- For example, you may have two projects that require different versions of the same package.
With `conda`, you can create separate, fully isolated software environments for each project with different package versions.
- Python-based `OpenScPCA` analysis modules will use different `conda` environments to prevent conflicts and improve reproducibility.
With conda, you can create separate, fully isolated software environments for each project with different package versions.
- Python-based OpenScPCA analysis modules will use different conda environments to prevent conflicts and improve reproducibility.


## Install `conda`
## Install conda

We recommend installing [Miniconda](https://docs.anaconda.com/free/miniconda/index.html) to obtain `conda`.
Miniconda is lightweight version of the full `conda` platform and includes the `conda` tool itself, Python, and a few other commonly-used packages.
We recommend installing [Miniconda](https://docs.anaconda.com/free/miniconda/index.html) to obtain conda.
Miniconda is lightweight version of the full conda platform and includes the conda tool itself, Python, and a few other commonly-used packages.

To install Miniconda, [download the installer for your operating system](https://docs.anaconda.com/free/miniconda/miniconda-install/), and follow all instructions.

If you already have `conda` on your system, you do not need to re-install it.
If you already have conda on your system, you do not need to re-install it.

## Setup `conda`
## Setup conda

Next, you will need to set certain `conda` settings and install a few packages that will allow you to contribute to `OpenScPCA` in general.
Next, you will need to set certain conda settings and install a few packages that will allow you to contribute to OpenScPCA in general.

1. Open a prompt to interact with `conda`.
1. Open a prompt to interact with conda.
The application to open depends on your operating system:
- _If you are on a macOS machine_, open the `Terminal` application.
To launch `Terminal`, search for "terminal" in spotlight and open the application.
- _If you are on a macOS machine_, open the Terminal application.
To launch Terminal, search for "terminal" in spotlight and open the application.
<figure markdown="span">
![Launch the Terminal application.](../../img/terminal-spotlight.png){width="425"}
</figure>


- _If you are on a Windows machine_, open the `conda` prompt.
- _If you are on a Windows machine_, open the conda prompt.
To launch the prompt, SOMETHING SOMETHING START MENU.
TODO: Add screenshot.

1. Copy and paste the following code into the prompt, and hit enter.
These commands will set the [recommended channels](https://docs.conda.io/projects/conda/en/latest/user-guide/concepts/channels.html) `conda` should use to search for software. <!-- For an indented code block, no backticks - just tab in twice -->
These commands will set the [recommended channels](https://docs.conda.io/projects/conda/en/latest/user-guide/concepts/channels.html) conda should use to search for software. <!-- For an indented code block, no backticks - just tab in twice -->

conda config --add channels defaults
conda config --add channels bioconda
conda config --add channels conda-forge
conda config --set channel_priority strict

!!! info
If you are on a macOS machine and get the error `conda: command not found`, this means `conda` was not properly installed.
If you are on a macOS machine and get the error `conda: command not found`, this means conda was not properly installed.
Please DO SOMETHING TO GET HELP? IS IT OPEN A DISCUSSION? IS IT DM US? IS IT SEE OTHER DOCS FOR WAYS TO GET HELP?
OR DO WE NOT EVEN NEED THIS NOTE?

!!! note
You may be prompted to enter `y` or `n` (yes or no) during this setup.
If/when this prompt appears, you should hit `y` to give `conda` permissions to proceed.
If/when this prompt appears, you should hit `y` to give conda permissions to proceed.

1. The last step is to add the packages to your base `conda` environment that you will need to contribute to `OpenScPCA`.
Copy and paste the following command into `Terminal`, and hit enter.
1. The last step is to add the packages to your base conda environment that you will need to contribute to OpenScPCA.
Copy and paste the following command into Terminal, and hit enter.

conda install awscli jq pre-commit

Expand Down

0 comments on commit 209bef7

Please sign in to comment.