Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
wblumberg committed Sep 13, 2019
1 parent e382bac commit 2710122
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 8 deletions.
2 changes: 2 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ Welcome to SHARPpy's documentation!
:Release: |version|
:Date: |today|

FYI: This documentation describes the soon to be released Andover branch of SHARPpy, which are accessible only through cloning the Github repository.

SHARPpy is a collection of open source sounding and hodograph analysis routines, a sounding plotting package, and an interactive, *cross-platform* application for analyzing real-time soundings all written in Python. It was developed to provide the atmospheric science community a free and consistent source of sounding analysis routines. SHARPpy is constantly updated and vetted by professional meteorologists and climatologists within the scientific community to help maintain a standard source of sounding routines.

We currently support Python >= 3.6 and will be dropping support for Python 2.7 in summer 2019.
Expand Down
29 changes: 21 additions & 8 deletions docs/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,20 +65,15 @@ install the required packages manually. These instructions assume that you have

Since SHARPpy requires the qtpy and Numpy packages, you will need to install them. If you choose to use the Anaconda distribution, Numpy comes installed by default. qtpy can be installed through the Anaconda package manager that comes with the Anaconda distribution by opening up your command line program (Terminal in macOS/Linux and Command Prompt in Windows) and typing:

.. prompt:: bash

conda install -c conda-forge pyside2

* PySide2
* PySide 2
* requests
* python-dateutil

Since SHARPpy requires these packages, you will need to install them. If you choose to use the Anaconda distribution, Numpy comes installed by default. PySide, requests, and python-dateutil can be installed through the Anaconda package manager that comes with the Anaconda distribution by opening up your command line program (Terminal in macOS/Linux and Command Prompt in Windows) and typing:
Since SHARPpy requires these packages, you will need to install them. If you choose to use the Anaconda distribution, Numpy comes installed by default. PySide 2, requests, and python-dateutil can be installed through the Anaconda package manager that comes with the Anaconda distribution by opening up your command line program (Terminal in macOS/Linux and Command Prompt in Windows) and typing:

.. prompt:: bash

conda install -c conda-forge requests python-dateutil
>>>>>>> andover
conda install -c conda-forge pyside2=5.12.* requests python-dateutil

After installing all the required Python packages for SHARPpy, you now can install the SHARPpy package to your computer. You'll need to download it to your computer first and open up a command line prompt. You can download it as a ZIP file (link on the right) or clone the Git respository (you will need the git program) into a directory on your computer by typing this into your command line:

Expand All @@ -96,11 +91,29 @@ If you follow the route of cloning SHARPpy, you can update to the most recent SH

git pull origin master

Other branches (including development ones not called master) can be listed using the `git branch` command:

.. prompt:: bash

git branch

We tend to name each version of SHARPpy after a famous tornado (e.g., Xenia). Releases will be under the "master" branch, while development versions will
tend to have another name (such as andover). You can download those using the `checkout` command. For example:

.. prompt:: bash
git checkout andover

Once the package has been downloaded to your computer, use your command line to navigate into the SHARPpy directory and type this command in to install SHARPpy:

.. prompt:: bash

python setup.py install

If you have pip, it may be installed via this command:

.. prompt:: bash

pip install -e .

After installing the package, you can run the SHARPpy GUI and interact with the SHARPpy libraries through Python scripts.
The GUI can be launched similar to the method described above in the "Installing from conda or pip" section.

0 comments on commit 2710122

Please sign in to comment.