Maintenance scheduled for Thursday, September 24th at 15:00 MDT. Expected downtime <1 hour.

Changed conda to command prompt

parent 6a95156a
# Setting up the development environment on Windows
## 1. Download and install Miniconda
Miniconda is a Python distribution and environment manager. Miniconda will help
you install the correct packages and Python version to run the FluEgg code.
**CHANGE TO SOMETHING ELSE**
* Download [Miniconda](https://docs.conda.io/en/latest/miniconda.html). Be sure
to download the 64-bit Python 3.7 version.
* Run the installer. Install it for "Just me" when asked. This does not require
administrative privileges. **Do not** install Miniconda for "all users".
## 2. Download and install Git
Git is a source control manager. It tracks changes made to the code and helps
to keep versions of the code organized.
* Download [Git](https://git-scm.com/). Similar to installing Miniconda, install
Git on your profile. This does not require administrative privileges. **Do
not** install Git for all users.
* Download [Git](https://git-scm.com/). Install Git on your profile.
This does not require administrative privileges.
**Do not** install Git for all users.
## 3. Create an SSH key and add it to your GitLab account
......@@ -33,8 +20,8 @@ to set up SSH.
* Create an SSH key and add it to your GitLab account by following the
instructions beginning [here](https://code.usgs.gov/help/ssh/README.md#generating-a-new-ssh-key-pair).
Follow the instructions under **Generating a new SSH key pair** and **Adding an
SSH key to your GitLab account**.
Follow the instructions under **Generating a new SSH key pair** and
**Adding an SSH key to your GitLab account**.
* You want to use RSA when generating a new SSH key pair.
......@@ -45,35 +32,38 @@ SSH key to your GitLab account**.
```
## 4. Clone the repository
Cloning the repository downloads a copy of the Git repository to your
local machine. This repository contains a history of changes, and most
importantly, the FluEgg code. Cloning the repository will also create a
reference from your local repository to the remote repository on code.usgs.gov.
This process may be done with either Windows Command Prompt or git bash. This
tutorial will use Command Prompt.
* Open Anaconda Prompt (available after installing Miniconda) and navigate to
the directory where you want to keep the FluEgg repository. In the following
instructions, `path-to-sources` is this directory.
* Open Command Prompt and navigate to the directory where you want to keep the
FluEgg repository by using the `cd` command. In the following instructions,
`path-to-sources` is this directory.
* Clone the repository using the following command (where `(base)
C:\path-to-sources>` is the command prompt).
* Clone the repository using the following command (where
`C:\path-to-sources>` is the command prompt).
```
(base) C:\path-to-sources>git clone git@code.usgs.gov:FluEgg/fluegg.git
C:\Users\user>cd path-to-sources
C:\path-to-sources>git clone git@code.usgs.gov:FluEgg/fluegg.git
```
## 5. Create and activate the fluegg conda environment
## 5. Create and activate the fluegg venv environment
In this step, you will create an Anaconda environment that contains the version
In this step, you will create a venv environment that contains the version
of Python and versions of packages that are known to work with the FluEgg code
base.
* `cd` into the `fluegg` directory that was created after cloning the FluEgg
repository.
```
(base) C:\path-to-sources>cd fluegg
```
* Create an environment by running `python -m venv env`
```
(base) C:\path-to-sources\fluegg>python -m venv env
C:\path-to-sources>cd fluegg
C:\path-to-sources\fluegg>python -m venv env
```
See [Creating virtual environments](https://docs.python.org/3/library/venv.html#creating-virtual-environments)
......@@ -85,7 +75,7 @@ You'll have to take this step every time you want to work in the FluEgg
development environment.
```
(base) C:\path-to-sources\fluegg>env\Scripts\activate
C:\path-to-sources\fluegg>env\Scripts\activate
(env) C:\path-to-sources\fluegg>
```
......@@ -127,7 +117,7 @@ command line. The output should look something like the below text.
pass*
----------------------------------------------------------------------
Ran 40 tests in 3.452s
Ran 43 tests in 3.452s
OK
```
......@@ -165,7 +155,6 @@ may be tested by running the following command:
```
For more information on how to use the user interface, see the FluEgg Manual.
**MANUAL LOCATION**
In order to build the user interface as it appears through the command line,
the python module `pyinstaller` will be used. To start, enter the command:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment