Skip to content

Commit

Permalink
Update docs files
Browse files Browse the repository at this point in the history
  • Loading branch information
rosericazondekon committed Jun 22, 2023
1 parent ca76a0d commit b3fd92b
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 9 deletions.
16 changes: 8 additions & 8 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,19 @@ Installing pynssp
=================


.. Stable release
.. --------------
Stable release
--------------

.. To install pynssp, run this command in your terminal:
To install pynssp, run this command in your terminal:

.. .. code-block:: console
.. code-block:: console
.. $ pip install pynssp
$ pip install pynssp
.. This is the preferred method to install pynssp, as it will always install the most recent stable release.
This is the preferred method to install pynssp, as it will always install the most recent stable release.

.. If you don't have `pip`_ installed, this `Python installation guide`_ can guide
.. you through the process.
If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.

.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
Expand Down
14 changes: 13 additions & 1 deletion docs/readme.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,24 @@
# About pynssp
[![pynssp Pipeline](https://github.com/cdcent/pynssp/actions/workflows/check-standard.yaml/badge.svg)](https://github.com/cdcent/pynssp/actions/workflows/check-standard.yaml)
[![Project Status: Active](https://www.repostatus.org/badges/latest/active.svg)](https://github.com/CDCgov/pynssp)
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
## Overview
`pynssp` is a Python package for the National Syndromic Surveillance Program (NSSP) and its Community of Practice. A collection of classes and methods to advance the practice of Syndromic Surveillance. It serves as a Python alternative to the [Rnssp R package](https://cdcgov.github.io/Rnssp).

## Installation

### Stable release

To install `pynssp`, run this command in your terminal:

```console
$ pip install pynssp
```

This is the preferred method to install `pynssp`, as it will always install the most recent stable release.

### Development version

You can install the development version of `pynssp` from Github:

```console
Expand Down

0 comments on commit b3fd92b

Please sign in to comment.