Getting Started¶

Install (Conda).¶

Below are step-by-step instructions for setting up the ARC tool.

If you haven't already, Download Miniconda (or a similar conda distribution).
Clone this repository.
In the upper right hand corner of this screen, left-click the green <> Code button and copy the text.
If your on a PC, open Git Bash on your local machine or if you have a Linux or Mac open a terminal with Git installed within it.

Run the following command in Git Bash or Terminal:

git clone https://github.com/MikeFHS/automated-rating-curve

Open the "Anaconda Prompt" on PC or remain in your terminal in Mac or Linux, and create you Conda environment.
Navigate to the location where you cloned the ARC repository.
```
cd automated-rating-curve
```
Create the Conda environment using the following command. Alternatively, if you have an existing conda environment you would like integrate ARC within, take a look at it dependencies and make sure you environment has these libraries.
```
conda env create -f environment.yaml
```
Activate the Conda environment using the following command.
```
conda activate arc
```
Install ARC within your Conda environment by navigating to the local ARC instance on your machine from within "Anaconda Prompt" on PC or terminal in Mac or Linux machine, and run the following command.
```
pip install .
```
To developers: an editable install is recommended for development, which can be done with the following command instead:
```
pip install -e .
```
Your ARC environment should be ready to roll!

You may run arc -h to get help using ARC.