Skip to content

Latest commit

 

History

History
104 lines (73 loc) · 4.66 KB

README.md

File metadata and controls

104 lines (73 loc) · 4.66 KB
Raw

cdss-app-snodas-tools

This project is still under initial development - please wait until the initial production version is released to attempt using yourself

Colorado's Decision Support Systems (CDSS) Snow Data Assimilation System (SNODAS) Tools

This repository contains Python code and supporting files for CDSS SNODAS tools, which provide the ability to process SNODAS grids into products suitable for water supply decision-making in Colorado.

Refer to the developer manual for information about configuring the development environment and performing development tasks.

The following illustrates the recommended organization of repository files for software development environment. Additional information is provided to recommend steps for new developers. Development environment setup needs to occur before development tasks can be performed. This repository corresponds to the C:/Users/user/owf-dev/CDSS-SNODAS-Tools/git-repos/cdss-app-snodas-tools/ folder.

C:\Users\user\                         (developer home folder)
  cdss-dev\                            (folder where CDSS development projects live)
    CDSS-SNODAS-Tools\                 (developer files folder)
      git-repos\                       (Git repositories, may be one or more repositories under here,
        cdss-app-snodas-tools\          all the code that is used by this development project)

New Developer Setup / Overview

A new developer that will contribute to the SNODAS tools must configure a development environment consistent with the Initial Project Setup. The standard development folder structure should be followed to minimize potential for issues, especially given the number of components and setup steps.

The setup involves performing some of the same tasks as the initial project setup, but some tasks do not need to be repeated, because the Git repository contains results of the initial project setup.

Note that the following sections are copied from the New Developer Setup documentation in the MkDocs documentation described below. Refer to the full documentation once MkDocs has been enabled in the development environment.

Configure Machine for Development

This documentation has been written assuming that development will occur on a Windows 7/10 64-bit computer, with deployment to similar environment. Any changes in the deployed environment should hopefully be handled simply by installing an alternate QGIS and Python version (Python programs resulting from this project will hopefully not need to be modified).

Development files will be created in C:\Users\user\cdss-dev\CDSS-SNODAS-Tools as discussed in the following sections.

If development occurs on other than Windows 7/10, then this section may be modified to describe setting up a Virtual Machine (VM).

Create Folder for Development Files

Create a development folder consistent with the initial project setup - this is an umbrella folder for all development files, including copies of software should the developer choose to use this approach.

Install Git Software

The Git software is needed to clone the repository (next step).

See the Git installation instructions.

Clone Git Repository

The Git repository contains the SNODAS tools software project files. It also contains this documentation. The repository will be referenced by the PyCharm IDE sofware. TODO smalers 2016-12-04 need to figure out how PyCharm manages files.

Clone the repository files using Git BASH:

$ cd /c/Users/user/CDSS-SNODAS-Tools
$ mkdir git-repos
$ cd git-repos
$ git clone https://github.com/OpenWaterFoundation/cdss-app-snodas-tools.git

If prompted, specify the GitHub account credentials.

View Developer Documentation with MkDocs

Developer documentation is created with MkDocs, which uses Markdown to create a static HTML website. First install necessary Python 3.5 and MkDocs software, if not already installed:

MkDocs can then be used to run a local web server to view the full documentation. Run the following in a Windows Command Shell:

> cd C:\Users\user\cdss-dev\CDSS-SNODAS-Tools\git-repos\cdss-app-snodas-tools\doc-dev-mkdocs-project
> mkdocs serve

INFO    -  Building documentation...
INFO    -  Cleaning site directory
[I 161205 02:11:49 server:283] Serving on http://127.0.0.1:8000
[I 161205 02:11:49 handlers:60] Start watching changes
[I 161205 02:11:49 handlers:62] Start detecting changes

Then view the localhost:8080 web page in a web browser. Follow the instructions in the New Developer Setup documentation.